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

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.377     jnemeth    33: <div><p class="copyright">Copyright © 1994-2025 The NetBSD Foundation, Inc</p></div>
1.382     wiz        34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.45 2025/04/17 22:00:11 wiz 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>
1.317     nia        88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                     92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig     94: </dl></dd>
1.267     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     96: <dd><dl>
1.267     rillig     97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     99: <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    100: </dl></dd>
                    101: </dl></dd>
1.267     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    103: <dd><dl>
1.267     rillig    104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig    106: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                    107: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                    108: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                    109: <dd><dl>
                    110: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    112: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       113: </dl></dd>
1.355     rillig    114: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                    115: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig    116: </dl></dd>
1.267     rillig    117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    118: <dd><dl>
1.267     rillig    119: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    120: <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    121: </dl></dd>
1.267     rillig    122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    123: builds)</a></span></dt>
1.75      rillig    124: <dd><dl>
1.267     rillig    125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    127: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    128: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    129: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    130: <dd><dl>
1.294     rillig    131: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    132: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig    133: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    140: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    141: </dl></dd>
                    142: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    143: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    144: </dl></dd>
                    145: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    146: <dd><dl>
                    147: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    148: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    149: </dl></dd>
                    150: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    151: <dd><dl>
                    152: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    154: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    155: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    156: <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>
                    157: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    158: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    159: <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>
                    160: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    161: <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       162: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    163: <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>
1.336     nia       164: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    165: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    169: <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    170: </dl></dd>
                    171: </dl></dd>
                    172: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    173: <dd><dl>
1.267     rillig    174: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    175: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    176: <dd><dl>
1.299     rillig    177: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    178: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    179: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    180: <dd><dl>
1.299     rillig    181: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    186: </dl></dd>
1.299     rillig    187: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    188: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    189: <dd><dl>
                    190: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    193: </dl></dd>
                    194: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    195: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    196: </dl></dd>
1.299     rillig    197: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    198: <dd><dl>
1.299     rillig    199: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    203: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    204: <dd><dl>
1.299     rillig    205: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    206: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    207: </dl></dd>
1.299     rillig    208: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    219: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    220: </dl></dd>
                    221: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    222: <dd><dl>
                    223: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    224: <dd><dl>
1.334     nia       225: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                    226: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                    227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig    228: </dl></dd>
1.299     rillig    229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    230: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig    231: </dl></dd>
1.299     rillig    232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    233: <dd><dl>
1.299     rillig    234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    238: <dd><dl>
1.299     rillig    239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    241: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid  243: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig    244: </dl></dd>
                    245: </dl></dd>
1.299     rillig    246: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    247: <dd><dl>
1.299     rillig    248: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    249: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    250: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    251: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    252: </dl></dd>
1.299     rillig    253: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    254: <dd><dl>
1.299     rillig    255: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    256: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    257: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    258: </dl></dd>
                    259: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    262: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    263: <dd><dl>
1.299     rillig    264: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    265: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       266:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    267:       and
                    268:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    269:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    270: </dl></dd>
1.299     rillig    271: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig    272: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig    273: </dl></dd>
                    274: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig    275: <dd><dl>
1.299     rillig    276: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    277: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    278: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    279: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    280: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    281: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    282: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    284: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig    285: </dl></dd>
1.299     rillig    286: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    287: <dd><dl>
                    288: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    289: <dd><dl>
                    290: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    291: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig    292: </dl></dd>
1.299     rillig    293: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig    294: <dd><dl>
1.299     rillig    295: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    296: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353     dholland  297: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                    298: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig    300: </dl></dd>
                    301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    312: <dd><dl>
                    313: <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>
                    314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    328: <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>
                    329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia       336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz       337: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig    338: </dl></dd>
                    339: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    340: <dd><dl>
                    341: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    342: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz       343: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia       344: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                    345: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                    346: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                    347: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig    348: </dl></dd>
                    349: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    350: <dd><dl>
                    351: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    352: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    353: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    354: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                    355: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    356: </dl></dd>
                    357: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    358: <dd><dl>
                    359: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    360: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    361: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    362: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    363: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia       364: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz       365: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                    367: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                    368: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                    369: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                    370: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                    371: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                    372: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                    373: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                    374: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz       375:     emulation</a></span></dt>
1.369     wiz       376: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                    377: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig    378: </dl></dd>
1.267     rillig    379: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    380: </dl></dd>
1.299     rillig    381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    382: <dd><dl>
                    383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    387: </dl></dd>
1.267     rillig    388: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    389: <dd><dl>
1.267     rillig    390: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    391: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    392: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    394: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    395: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    396: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    397: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    398: </dl></dd>
1.382     wiz       399: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                    400: <dd><dl>
                    401: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                    402: <dd><dl>
                    403: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                    404: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                    405: </dl></dd>
                    406: </dl></dd>
                    407: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig    408: </dl></dd>
                    409: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    410: <dd><dl>
1.382     wiz       411: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    412: <dd><dl>
1.382     wiz       413: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    414: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    415: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig    416: <dd><dl>
1.382     wiz       417: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    418: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig    419: </dl></dd>
1.382     wiz       420: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    421: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    422: <dd><dl>
1.382     wiz       423: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    424: <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    425: </dl></dd>
1.382     wiz       426: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig    427: <dd><dl>
1.382     wiz       428: <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>
                    429: <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    430: </dl></dd>
                    431: </dl></dd>
1.382     wiz       432: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig    433: <dd><dl>
1.382     wiz       434: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    435: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig    436: <dd><dl>
1.382     wiz       437: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    438: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig    439: </dl></dd>
                    440: </dl></dd>
1.382     wiz       441: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    442: <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    443: </dl></dd>
                    444: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    447: <dd><dl>
                    448: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    449: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    450: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    451: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    452: </dl></dd>
                    453: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    454: </dl></dd>
1.322     leot      455: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75      rillig    456: <dd><dl>
1.322     leot      457: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                    458: <dd><dl>
                    459: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                    460: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                    461: </dl></dd>
                    462: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                    463: <dd><dl>
                    464: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                    465: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                    466: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                    467: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                    468: </dl></dd>
                    469: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                    470: <dd><dl>
                    471: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                    472: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                    473: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                    474: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                    475: </dl></dd>
                    476: </dl></dd>
                    477: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
                    478: <dd><dl>
                    479: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                    480: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75      rillig    481: </dl></dd>
1.322     leot      482: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76      rillig    483: <dd><dl>
1.322     leot      484: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    485: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    486: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    487: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    488: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261     leot      489: <code class="filename">stable</code>,
1.128     wiz       490: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    491: source packages</a></span></dt>
                    492: </dl></dd>
1.322     leot      493: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
                    494: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    495: <dd><dl>
1.322     leot      496: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                    497: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig    498: </dl></dd>
                    499: </dl>
                    500: </div>
1.82      rillig    501: <div class="list-of-tables">
                    502: <p><b>List of Tables</b></p>
                    503: <dl>
                    504: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    505: </dt>
1.299     rillig    506: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      507: </dt>
1.299     rillig    508: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      509: </dt>
1.82      rillig    510: </dl>
                    511: </div>
1.148     asau      512: <div class="chapter">
                    513: <div class="titlepage"><div><div><h1 class="title">
                    514: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    515: <div class="toc">
                    516: <p><b>Table of Contents</b></p>
1.210     leot      517: <dl class="toc">
1.75      rillig    518: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    519: <dd><dl>
                    520: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    521: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    522: </dl></dd>
1.75      rillig    523: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    524: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       525: <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    526: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    527: </dl>
                    528: </div>
1.148     asau      529: <div class="sect1">
1.75      rillig    530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    531: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    532: <p>There is a lot of software freely available for Unix-based
                    533: systems, which is usually available in form of the source code. Before
                    534: such software can be used, it needs to be configured to the local
                    535: system, compiled and installed, and this is exactly what The NetBSD
                    536: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    537: to handle binary packages, so that not every user has to build the
                    538: packages for himself, which is a time-costly task.</p>
1.75      rillig    539: <p>pkgsrc currently contains several thousand packages,
                    540:       including:</p>
1.148     asau      541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot      542: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    543:          web server</p></li>
1.322     leot      544: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    545:          web browser</p></li>
1.322     leot      546: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    547:          Desktop Environment</p></li>
1.322     leot      548: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    549:          Desktop Environment</p></li>
                    550: </ul></div>
1.219     rillig    551: <p>&#8230; just to name a few.</p>
1.75      rillig    552: <p>pkgsrc has built-in support for handling varying dependencies,
                    553:       such as pthreads and X11, and extended features such as IPv6 support on
                    554:       a range of platforms.</p>
1.148     asau      555: <div class="sect2">
1.82      rillig    556: <div class="titlepage"><div><div><h3 class="title">
                    557: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    558: <p>
                    559: pkgsrc provides the following key features:
                    560: </p>
1.148     asau      561: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       562: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    563:   and installation of binary packages. The source and latest
                    564:   patches are retrieved from a master or mirror download site, checksum
                    565:   verified, then built on your system. Support for binary-only
                    566:   distributions is available for both native platforms and NetBSD
                    567:   emulated platforms.</p></li>
1.128     wiz       568: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    569:   including binaries, libraries, man pages and other
                    570:   documentation.</p></li>
1.214     sevan     571: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    572:   performing updates, to ensure required packages are installed. The
                    573:   configuration files of various packages are handled automatically during
                    574:   updates, so local changes are preserved.</p></li>
1.128     wiz       575: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    576:   consists of highly portable code. This allows the greatest speed of
1.132     spz       577:   development when porting to a new platform. This portability also
1.82      rillig    578:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    579:   platforms</em></span>.</p></li>
1.128     wiz       580: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    581:   international encryption requirements and build-time options for a
                    582:   large number of packages are all set in a simple, central
                    583:   configuration file.</p></li>
1.128     wiz       584: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    585:   freely available under a BSD license, so you may extend and adapt
                    586:   pkgsrc to your needs. Support for local packages and patches is
                    587:   available right out of the box, so you can configure it specifically
                    588:   for your environment.</p></li>
                    589: </ul></div>
1.91      rillig    590: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      591: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       592: <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  593: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    594: them and to complain about them rather than to just install the package
                    595: and hope that it works. There are numerous checks in pkgsrc that try to
1.322     leot      596: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    597: of shell scripts), and post-installation checks (installed files,
                    598: references to shared libraries, script interpreters).</p></li>
1.128     wiz       599: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  600: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    601: pkgsrc has been ported to many operating systems. Care is taken that
                    602: packages behave the same on all platforms.</p></li>
                    603: </ul></div>
1.82      rillig    604: </div>
1.148     asau      605: <div class="sect2">
1.82      rillig    606: <div class="titlepage"><div><div><h3 class="title">
                    607: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    608: <p>pkgsrc consists of both a source distribution and a binary
                    609: distribution for these operating systems. After retrieving the required
                    610: source or binaries, you can be up and running with pkgsrc in just
                    611: minutes!</p>
1.75      rillig    612: <p>pkgsrc was derived from FreeBSD's ports system, and
                    613:       initially developed for NetBSD only. Since then, pkgsrc has
                    614:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    615: <div class="table">
                    616: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       617: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    618: <colgroup>
                    619: <col>
                    620: <col>
1.202     sevan     621: <col>
1.82      rillig    622: </colgroup>
                    623: <thead><tr>
                    624: <th>Platform</th>
                    625: <th>Date Support Added</th>
1.202     sevan     626: <th>Notes</th>
1.82      rillig    627: </tr></thead>
                    628: <tbody>
                    629: <tr>
1.289     leot      630: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    631: <td align="center">Aug 1997</td>
1.202     sevan     632: <td class="auto-generated"> </td>
1.82      rillig    633: </tr>
                    634: <tr>
1.110     hubertf   635: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    636: <td align="center">Mar 1999</td>
1.264     sevan     637: <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    638: </tr>
                    639: <tr>
1.289     leot      640: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    641: <td align="center">Jun 1999</td>
1.264     sevan     642: <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    643: </tr>
                    644: <tr>
                    645: <td>
1.230     sevan     646:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    647:         </td>
                    648: <td align="center">Oct 2001</td>
1.305     bacon     649: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82      rillig    650: </tr>
                    651: <tr>
1.289     leot      652: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    653: <td align="center">Nov 2002</td>
1.264     sevan     654: <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    655: </tr>
                    656: <tr>
1.289     leot      657: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    658: <td align="center">Nov 2002</td>
1.264     sevan     659: <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    660: </tr>
                    661: <tr>
1.289     leot      662: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    663: <td align="center">Dec 2002</td>
1.202     sevan     664: <td>
1.264     sevan     665:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202     sevan     666:        </td>
1.82      rillig    667: </tr>
                    668: <tr>
                    669: <td>BSD/OS</td>
                    670: <td align="center">Dec 2003</td>
1.381     dholland  671: <td align="center">Removed from pkgsrc Mar 2025</td>
1.82      rillig    672: </tr>
                    673: <tr>
1.289     leot      674: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    675: <td align="center">Dec 2003</td>
1.264     sevan     676: <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    677: </tr>
                    678: <tr>
                    679: <td>
1.289     leot      680:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    681:           (Microsoft Windows Services for Unix)
                    682:         </td>
                    683: <td align="center">Mar 2004</td>
1.383     wiz       684: <td align="center">Removed from pkgsrc Apr 2025</td>
1.82      rillig    685: </tr>
                    686: <tr>
1.289     leot      687: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    688: <td align="center">Oct 2004</td>
1.202     sevan     689: <td class="auto-generated"> </td>
1.82      rillig    690: </tr>
                    691: <tr>
1.110     hubertf   692: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    693: <td align="center">Nov 2004</td>
1.264     sevan     694: <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    695: </tr>
1.98      wiz       696: <tr>
1.289     leot      697: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       698: <td align="center">Apr 2007</td>
1.264     sevan     699: <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       700: </tr>
1.128     wiz       701: <tr>
1.289     leot      702: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       703: <td align="center">Sep 2010</td>
1.264     sevan     704: <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       705: </tr>
1.151     obache    706: <tr>
1.289     leot      707: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  708: <td align="center">Jan 2011</td>
1.381     dholland  709: <td align="center">Removed from pkgsrc Mar 2025</td>
1.151     obache    710: </tr>
                    711: <tr>
1.289     leot      712: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    713: <td align="center">Nov 2011</td>
1.264     sevan     714: <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    715: </tr>
                    716: <tr>
1.289     leot      717: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    718: <td align="center">Mar 2013</td>
1.264     sevan     719: <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    720: </tr>
1.166     jnemeth   721: <tr>
1.289     leot      722: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   723: <td align="center">Jul 2013</td>
1.380     maya      724: <td>Removed from pkgsrc Mar 2025</td>
1.166     jnemeth   725: </tr>
1.214     sevan     726: <tr>
1.289     leot      727: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     728: <td align="center">Jun 2014</td>
1.344     gutterid  729: <td>Removed from pkgsrc Sep 2022</td>
1.214     sevan     730: </tr>
1.82      rillig    731: </tbody>
1.91      rillig    732: </table></div>
1.82      rillig    733: </div>
1.91      rillig    734: <br class="table-break">
1.82      rillig    735: </div>
1.75      rillig    736: </div>
1.148     asau      737: <div class="sect1">
1.75      rillig    738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    739: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    740: <p>This document is divided into three parts. The first,
1.110     hubertf   741:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    742:        describes how one can use one of the packages in the Package
                    743:        Collection, either by installing a precompiled binary package,
1.93      rillig    744:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   745:        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    746:        package so it can be easily built by other NetBSD users without
                    747:        knowing about the package's building details. The third part,
1.110     hubertf   748:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    749:        is intended for those who want to understand how pkgsrc is
                    750:        implemented.</p>
                    751: <p>This document is available in various formats:
1.110     hubertf   752:        <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    753: </div>
1.148     asau      754: <div class="sect1">
1.75      rillig    755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    756: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       757: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    758:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    759:       terminology used within this document.</p>
1.148     asau      760: <div class="variablelist"><dl class="variablelist">
1.75      rillig    761: <dt><span class="term">Package</span></dt>
                    762: <dd><p>A set of files and building instructions
                    763:            that describe what's necessary
                    764:            to build a certain piece of software using
                    765:             pkgsrc. Packages are traditionally stored under
1.236     wiz       766:            <code class="filename">/usr/pkgsrc</code>,
                    767:            but may be stored in any location,
                    768:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    769: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       770: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       771:          is part of the NetBSD operating system and can be bootstrapped
                    772:          to run on non-NetBSD operating systems as well.  It handles
                    773:          building (compiling), installing, and removing of
                    774:          packages.</p></dd>
1.75      rillig    775: <dt><span class="term">Distfile</span></dt>
                    776: <dd><p>This term describes the file or files that are
                    777:            provided by the author of the piece of software to
                    778:            distribute his work. All the changes necessary to build on
                    779:            NetBSD are reflected in the corresponding package. Usually
                    780:            the distfile is in the form of a compressed tar-archive,
                    781:            but other types are possible, too. Distfiles are usually
                    782:            stored below
1.76      rillig    783:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    784: <dt><span class="term">Port</span></dt>
                    785: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    786:            for what we call a package.
1.128     wiz       787:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    788:            architecture.</p></dd>
                    789: <dt><span class="term">Precompiled/binary package</span></dt>
                    790: <dd>
                    791: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    792:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    793:            file so it can be installed on machines of the same
                    794:            machine architecture without the need to
                    795:            recompile. Packages are usually generated in
1.76      rillig    796:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       797:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       798: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    799:            especially in the context of precompiled packages.</p>
                    800: </dd>
                    801: <dt><span class="term">Program</span></dt>
1.88      wiz       802: <dd><p>The piece of software to be installed which will be
                    803:          constructed from all the files in the distfile by the
                    804:          actions defined in the corresponding package.</p></dd>
1.75      rillig    805: </dl></div>
1.148     asau      806: <div class="sect2">
1.75      rillig    807: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       808: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      809: <div class="variablelist"><dl class="variablelist">
1.75      rillig    810: <dt><span class="term">pkgsrc users</span></dt>
                    811: <dd>
                    812: <p>The
                    813:        pkgsrc users are people who use the packages provided by pkgsrc.
                    814:        Typically they are system administrators. The people using the
1.128     wiz       815:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    816:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    817: <p>There are two kinds of pkgsrc users: Some only want to
                    818:        install pre-built binary packages. Others build the pkgsrc
                    819:        packages from source, either for installing them directly or for
1.110     hubertf   820:        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    821:        documentation.</p>
                    822: </dd>
                    823: <dt><span class="term">package maintainers</span></dt>
                    824: <dd><p>A
1.110     hubertf   825:        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    826: <dt><span class="term">infrastructure developers</span></dt>
                    827: <dd><p>These people are involved in all those files
1.76      rillig    828:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   829:        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    830:        too.</p></dd>
                    831: </dl></div>
                    832: </div>
                    833: </div>
1.148     asau      834: <div class="sect1">
1.75      rillig    835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    836: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    837: <p>When giving examples for commands, shell prompts are used to
                    838:       show if the command should/can be issued as root, or if
1.128     wiz       839:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     840:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    841:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344     gutterid  842:       Bourne shell and derivatives.</p>
1.75      rillig    843: </div>
                    844: </div>
1.148     asau      845: <div class="part">
1.75      rillig    846: <div class="titlepage"><div><div><h1 class="title">
                    847: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    848: <div class="toc">
                    849: <p><b>Table of Contents</b></p>
1.210     leot      850: <dl class="toc">
1.267     rillig    851: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    852: <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    853: <dd><dl>
1.267     rillig    854: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    855: <dd><dl>
1.267     rillig    856: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    857: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    858: </dl></dd>
1.267     rillig    859: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    860: <dd><dl>
1.267     rillig    861: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    862: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    863: </dl></dd>
                    864: </dl></dd>
1.267     rillig    865: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    866: <dd><dl>
1.267     rillig    867: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    868: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    869: </dl></dd>
1.267     rillig    870: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    871: <dd><dl>
1.267     rillig    872: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    873: <dd><dl>
1.267     rillig    874: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    875: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia       876: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    877: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    878: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    879: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    880: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    881: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig    882: </dl></dd>
1.267     rillig    883: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    884: <dd><dl>
1.267     rillig    885: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    886: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    887: <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    888: </dl></dd>
                    889: </dl></dd>
1.267     rillig    890: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    891: <dd><dl>
1.267     rillig    892: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    893: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig    894: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                    895: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                    896: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                    897: <dd><dl>
                    898: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                    899: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    900: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       901: </dl></dd>
1.355     rillig    902: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                    903: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig    904: </dl></dd>
1.267     rillig    905: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    906: <dd><dl>
1.267     rillig    907: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    908: <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    909: </dl></dd>
1.267     rillig    910: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    911: builds)</a></span></dt>
1.75      rillig    912: <dd><dl>
1.267     rillig    913: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    914: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    915: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    916: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    917: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    918: <dd><dl>
1.294     rillig    919: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    920: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig    921: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    922: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    923: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    924: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    925: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    926: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    927: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    928: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    929: </dl></dd>
                    930: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    931: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    932: </dl></dd>
                    933: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    934: <dd><dl>
                    935: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    936: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    937: </dl></dd>
                    938: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    939: <dd><dl>
                    940: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    941: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    942: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    943: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    944: <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>
                    945: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    946: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    947: <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>
                    948: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    949: <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       950: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    951: <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>
1.336     nia       952: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    953: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    954: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    955: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    956: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    957: <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    958: </dl></dd>
                    959: </dl>
                    960: </div>
1.148     asau      961: <div class="chapter">
1.75      rillig    962: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    963: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    964: <p>
                    965:        To get help when using pkgsrc, the definitive source is this
                    966:        document, the pkgsrc guide. If you don't find anything here,
                    967:        there are alternatives:
                    968: </p>
                    969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    970: <li class="listitem">
                    971: <p>
                    972:        The built-in pkgsrc help, which is available after bootstrapping
                    973:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    974:        help for any topic, such as a variable name like
                    975:        <code class="varname">BUILD_DEFS</code>, a make target like
                    976:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    977:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322     leot      978: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267     rillig    979: </li>
                    980: <li class="listitem"><p>
1.278     rillig    981:        To see the value of a single variable, run <span class="command"><strong>bmake
                    982:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    983: </p></li>
                    984: <li class="listitem"><p>
                    985:        To see the values of the most common variables, run
                    986:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    987:        topic. To see the variables for a single topic, run
                    988:        <span class="command"><strong>bmake
                    989:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    990:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    991: </p></li>
                    992: <li class="listitem"><p>
1.267     rillig    993:        The pkgsrc-users mailing list, to which
                    994:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    995:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    996:        questions</a>.</p></li>
                    997: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland  998:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig    999:        or by using a specialized chat program such as
                   1000:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   1001:        Pick any user name and join the channel #pkgsrc.</p></li>
                   1002: </ul></div>
                   1003: </div>
                   1004: <div class="chapter">
                   1005: <div class="titlepage"><div><div><h2 class="title">
                   1006: <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   1007: <div class="toc">
                   1008: <p><b>Table of Contents</b></p>
1.210     leot     1009: <dl class="toc">
1.267     rillig   1010: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig   1011: <dd><dl>
1.267     rillig   1012: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                   1013: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig   1014: </dl></dd>
1.267     rillig   1015: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig   1016: <dd><dl>
1.267     rillig   1017: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                   1018: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig   1019: </dl></dd>
                   1020: </dl>
                   1021: </div>
1.91      rillig   1022: <p>Before you download and extract the files, you need to decide
                   1023: where you want to extract them. When using pkgsrc as root user, pkgsrc
                   1024: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                   1025: free to install the sources and binary packages wherever you want in
                   1026: your filesystem, provided that the pathname does not contain white-space
                   1027: or other characters that are interpreted specially by the shell and some
                   1028: other programs. A safe bet is to use only letters, digits, underscores
                   1029: and dashes.</p>
1.148     asau     1030: <div class="sect1">
1.75      rillig   1031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1032: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1033: <p>Before you download any pkgsrc files, you should decide
                   1034:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1035:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1036:        quarterly basis from the current branch and only gets modified
                   1037:        for security updates. The names of the stable branches are built
                   1038:        from the year and the quarter, for example
1.384   ! leot     1039:        <code class="literal">2025Q2</code>.</p>
1.75      rillig   1040: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1041:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1042:        Both ways are described here.</p>
1.157     asau     1043: <p>Note that tar archive contains CVS working copy.
                   1044:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1045: <div class="sect2">
1.75      rillig   1046: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1047: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1048: <p>The primary download location for all pkgsrc files is
1.264     sevan    1049:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1050:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1051:        (it points to the same location).
                   1052:        There are a number of subdirectories for different purposes,
1.322     leot     1053:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.157     asau     1054: <p>The tar archive for the current branch is in the directory
1.264     sevan    1055:        <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    1056:        It is autogenerated weekly.</p>
1.157     asau     1057: <p>To save download time we provide bzip2- and
                   1058:        xz-compressed archives which are published at
1.264     sevan    1059:        <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     1060:        and
1.264     sevan    1061:        <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     1062:        respectively.
                   1063:        </p>
                   1064: <p>You can fetch the same files using FTP.</p>
1.384   ! leot     1065: <p>The tar file for the stable branch 2025Q2 is in the
        !          1066:        directory <code class="filename">pkgsrc-2025Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1067: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1068: <pre class="screen">
1.384   ! leot     1069: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q2/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1070: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1071:        or your web browser.</p>
1.112     weinem   1072: <p>Then, extract it with:</p>
1.188     snj      1073: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1074: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1075:        in <code class="filename">/usr/</code> and all the package source will be 
                   1076:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1077: <p>To download pkgsrc-current, run:</p>
                   1078: <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   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="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1083: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.384   ! leot     1084: <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-2025Q2 -P pkgsrc</code></strong>
1.128     wiz      1085: </pre>
                   1086: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1087:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1088:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1089: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1090: <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    1091: </pre>
1.289     leot     1092: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1093: <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      1094: <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      1095: </pre>
                   1096: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1097:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1098:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1099: <pre class="programlisting">
                   1100: # set CVS remote shell command
                   1101: CVS_RSH=ssh
                   1102: export CVS_RSH
                   1103: </pre>
                   1104: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1105:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1106:        in your home directory and saving the following lines to it.
                   1107:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1108:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1109: <pre class="programlisting">
                   1110: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1111: cvs -q
1.101     rillig   1112: checkout -P
1.103     wiz      1113: update -dP
                   1114: diff -upN
1.101     rillig   1115: rdiff -u
1.128     wiz      1116: release -d
1.101     rillig   1117: </pre>
1.75      rillig   1118: </div>
                   1119: </div>
1.148     asau     1120: <div class="sect1">
1.75      rillig   1121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1122: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1123: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1124:        (which also works if you have first installed it via a tar
                   1125:        file). It saves bandwidth and hard disk activity, compared to
                   1126:        downloading the tar file again.</p>
1.148     asau     1127: <div class="sect2">
1.75      rillig   1128: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1129: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1130: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1131: <h3 class="title">Warning</h3>
1.77      rillig   1132: <p>When updating from a tar file, you first need to
                   1133:        completely remove the old pkgsrc directory. Otherwise those
                   1134:        files that have been removed from pkgsrc in the mean time will
                   1135:        not be removed on your local disk, resulting in inconsistencies.
                   1136:        When removing the old files, any changes that you have done to
                   1137:        the pkgsrc files will be lost after updating. Therefore updating
                   1138:        via CVS is strongly recommended.</p>
1.75      rillig   1139: </div>
1.82      rillig   1140: <p>Note that by default the distfiles and the binary packages
                   1141:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1142:        before updating. You can also configure pkgsrc to store distfiles
                   1143:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1144:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1145:        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   1146: <p>To update pkgsrc from a tar file, download the tar file as
                   1147:        explained above. Then, make sure that you have not made any
                   1148:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1149:        directory and extract the new tar file. Done.</p>
                   1150: </div>
1.148     asau     1151: <div class="sect2">
1.75      rillig   1152: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1153: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1154: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1155: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1156: </pre>
                   1157: <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>
                   1158: <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>
                   1159: </pre>
1.148     asau     1160: <div class="sect3">
1.75      rillig   1161: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1162: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1163: <p>When updating pkgsrc, the CVS program keeps track of the
                   1164:        branch you selected. But if you, for whatever reason, want to
                   1165:        switch from the stable branch to the current one, you can do it
1.128     wiz      1166:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1167:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1168:        back to the stable branch, add the
1.384   ! leot     1169:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2025Q2</span>&#8221;</span> option.</p>
1.75      rillig   1170: </div>
1.148     asau     1171: <div class="sect3">
1.75      rillig   1172: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1173: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1174: <p>When you update pkgsrc, the CVS program will only touch
                   1175:        those files that are registered in the CVS repository. That
                   1176:        means that any packages that you created on your own will stay
                   1177:        unmodified. If you change files that are managed by CVS, later
                   1178:        updates will try to merge your changes with those that have been
                   1179:        done by others. See the CVS manual, chapter
1.128     wiz      1180:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1181: </div>
                   1182: </div>
                   1183: </div>
                   1184: </div>
1.148     asau     1185: <div class="chapter">
1.75      rillig   1186: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1187: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1188: <div class="toc">
                   1189: <p><b>Table of Contents</b></p>
1.210     leot     1190: <dl class="toc">
1.267     rillig   1191: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1192: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1193: </dl>
                   1194: </div>
1.148     asau     1195: <div class="sect1">
1.75      rillig   1196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1197: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1198: <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   1199: </div>
1.148     asau     1200: <div class="sect1">
1.82      rillig   1201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1202: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1203: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1204:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1205:     to privileged one all programs are installed under one particular user
1.149     asau     1206:     and cannot utilise privileged operations (packages don't create
                   1207:     special users and all special file permissions like setuid are ignored).
                   1208:     </p>
1.82      rillig   1209: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1210: <pre class="screen">
1.167     asau     1211: <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   1212: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1213: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1214:     </pre>
1.149     asau     1215: <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>
                   1216: <p>By default, in privileged mode pkgsrc uses
                   1217:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1218:     where programs will be installed in,
1.230     sevan    1219:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1220:     directory where pkgsrc will do its internal bookkeeping,
                   1221:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1222:     where packages install their persistent data.
                   1223:     In unprivileged mode pkgsrc uses
                   1224:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1225:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1226:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1227:     </p>
                   1228: <p>You can change default layout using command-line arguments.
                   1229:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1230:     </p>
1.148     asau     1231: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1232: <h3 class="title">Note</h3>
1.110     hubertf  1233: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1234:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1235:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1236:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1237: </div>
1.149     asau     1238: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1239: <h3 class="title">Note</h3>
                   1240: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1241:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1242:       corresponding to the installation you're working with to build
                   1243:       and install packages.
                   1244:       </p>
                   1245: </div>
1.75      rillig   1246: </div>
                   1247: </div>
1.148     asau     1248: <div class="chapter">
1.75      rillig   1249: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1250: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1251: <div class="toc">
                   1252: <p><b>Table of Contents</b></p>
1.210     leot     1253: <dl class="toc">
1.267     rillig   1254: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1255: <dd><dl>
1.267     rillig   1256: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1257: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia      1258: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1259: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1260: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1261: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1262: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1263: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267     rillig   1264: </dl></dd>
                   1265: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1266: <dd><dl>
                   1267: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1268: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1269: <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   1270: </dl></dd>
                   1271: </dl>
                   1272: </div>
                   1273: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1274: is to only install the package tools and to use binary packages
1.128     wiz      1275: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1276: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1277: of pkgsrc, too. Then you are able to build your own packages,
                   1278: and you can still use binary packages from someone else.</p>
1.148     asau     1279: <div class="sect1">
1.75      rillig   1280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1281: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317     nia      1282: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1283:   site and mirrors, there are collections of binary packages,
1.109     rillig   1284:   ready to be installed. These binary packages have been built using the
                   1285:   default settings for the directories, that is:</p>
1.148     asau     1286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1287: <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>
                   1288: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1289: <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   1290: </ul></div>
                   1291: <p>If you cannot use these directories for whatever reasons (maybe
                   1292:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1293:   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     1294: <div class="sect2">
1.75      rillig   1295: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1296: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1297: <p>To install binary packages, you first need to know from where
                   1298:     to get them. The first place where you should look is on the main
1.317     nia      1299:     pkgsrc CDN 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   1300: <p>This directory contains binary packages for multiple
1.341     gutterid 1301:     platforms. First, select your operating system. Then, select your
                   1302:     hardware architecture, and in the third step, the OS version and
                   1303:     the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
                   1304: <p>In this directory, you may find a file called
1.109     rillig   1305:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1306:     management tools. If the file is missing, it is likely that your
                   1307:     operating system already provides those tools. Download the file and
                   1308:     extract it in the <code class="filename">/</code> directory. It will create
                   1309:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1310:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1311: </div>
1.148     asau     1312: <div class="sect2">
1.75      rillig   1313: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1314: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1315: <p>In the directory from the last section, there is a
1.196     wiz      1316:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1317:     binary packages that are available for the platform, excluding those
1.317     nia      1318:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1319: <p>To install packages directly from an FTP or HTTP server, run
                   1320:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1321:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1322: <pre class="screen">
1.317     nia      1323: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1324: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1325: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<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   1326: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317     nia      1327: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1328: </pre>
                   1329: <p>Instead of URLs, you can also use local paths, for example if
                   1330:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1331:     repository. If you want to install packages from multiple sources,
                   1332:     you can separate them by a semicolon in
                   1333:     <code class="varname">PKG_PATH</code>.</p>
                   1334: <p>After these preparations, installing a package is very
                   1335:     easy:</p>
                   1336: <pre class="screen">
1.317     nia      1337: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1338: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1339: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1340: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1341: </pre>
                   1342: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1343:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1344: <p>Any prerequisite packages needed to run the
1.88      wiz      1345:     package in question will be installed, too, assuming they are
1.317     nia      1346:     present in the repository.</p>
1.75      rillig   1347: <p>After you've installed packages, be sure to have
1.88      wiz      1348:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1349:     <code class="varname">PATH</code> so you can actually start the just
                   1350:     installed program.</p>
1.75      rillig   1351: </div>
1.148     asau     1352: <div class="sect2">
1.75      rillig   1353: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1354: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
                   1355: <p>To update binary packages, it is recommended that you use
                   1356:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1357:     package repository to your locally installed packages and safely
                   1358:     replace any older packages.</p>
                   1359: <p>Note that pkgsrc is released as quarterly branches.
                   1360:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1361:     need to adjust the repository in
                   1362:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1363: </div>
                   1364: <div class="sect2">
                   1365: <div class="titlepage"><div><div><h3 class="title">
                   1366: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1367: <p>To deinstall a package, it does not matter whether it was
1.317     nia      1368:     installed from source code or from a binary package. Neither the
                   1369:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1370:     command need to know.</p>
                   1371: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1372:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317     nia      1373:     name can be given with or without version number.</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.317     nia      1377: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1378: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317     nia      1379:     installed packages or binary package files.
                   1380:     As with other management tools, it works with packages installed
                   1381:     from source or binaries.</p>
1.82      rillig   1382: </div>
1.148     asau     1383: <div class="sect2">
1.82      rillig   1384: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1385: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1386: <p>
1.279     leot     1387:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317     nia      1388:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1389:       included in pkgsrc.  The list is available from the NetBSD
1.317     nia      1390:       CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
                   1391:     </p>
                   1392: <p>
                   1393:       Please note that not every "vulnerability" with a CVE assignment is
                   1394:       exploitable in every configuration.
                   1395:       Some bugs are marked as active simply because an fix was not
                   1396:       marked as such.
                   1397:       Operating system specific hardening and mitigation features may also
                   1398:       reduce the impact of bugs.
1.88      wiz      1399:     </p>
1.82      rillig   1400: <p>
1.125     wiz      1401:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1402:       this list can be downloaded
                   1403:       automatically, and a security audit of all packages installed on a system
                   1404:       can take place.
                   1405:     </p>
1.82      rillig   1406: <p>
1.125     wiz      1407:       There are two components to auditing.  The first
                   1408:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1409:       is for downloading
1.88      wiz      1410:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1411:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1412:       installed packages are vulnerable.  If a package is vulnerable, you
                   1413:       will see output similar to the following:
                   1414:     </p>
1.82      rillig   1415: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1416:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1417: <p>
1.125     wiz      1418:       You may wish to have the
1.317     nia      1419:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1420:       file downloaded daily so that
                   1421:       it remains current.  This may be done by adding an appropriate entry
1.378     leot     1422:       to the root users <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1423:       </p>
                   1424: <pre class="screen">
1.233     sevan    1425: # Download vulnerabilities file
1.230     sevan    1426: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1427: # Audit the installed packages and email results to root
                   1428: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1429:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1430:       </pre>
                   1431: <p>
1.230     sevan    1432:       will update the vulnerability list every day at 3AM, followed by an audit
                   1433:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1434: 
1.230     sevan    1435:       On NetBSD this may be accomplished instead by adding the following
                   1436:       line to <code class="filename">/etc/daily.conf</code>:
                   1437:       </p>
                   1438: <pre class="screen">
                   1439: fetch_pkg_vulnerabilities=YES
                   1440:       </pre>
                   1441: <p>
                   1442:       to fetch the vulnerability list from the daily security script. The system
                   1443:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1444:       desired (not required), by adding the following line to
1.230     sevan    1445: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1446:       </p>
                   1447: <pre class="screen">
1.230     sevan    1448: check_pkg_vulnerabilities=YES
1.125     wiz      1449:       </pre>
                   1450: <p>
1.378     leot     1451:       see <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1452:     </p>
1.82      rillig   1453: </div>
1.148     asau     1454: <div class="sect2">
1.82      rillig   1455: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1456: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82      rillig   1457: <p>
1.322     leot     1458:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1459:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.317     nia      1460:       argument to check if any packages are stale, e.g.
1.88      wiz      1461:     </p>
                   1462: <pre class="screen">
                   1463: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1464: ...
1.88      wiz      1465: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1466:     </pre>
1.82      rillig   1467: </div>
1.148     asau     1468: <div class="sect2">
1.82      rillig   1469: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1470: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1471: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1472:     administrative functions on the package system.</p>
1.82      rillig   1473: </div>
1.75      rillig   1474: </div>
1.148     asau     1475: <div class="sect1">
1.75      rillig   1476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1477: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1478: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1479:   directory now contains a set of packages, organized into
                   1480:   categories. You can browse the online index of packages, or run
1.110     hubertf  1481:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1482:   directory to build local <code class="filename">README.html</code> files for
1.322     leot     1483:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1484: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1485:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1486:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1487:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1488:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1489:   system (inside a chroot is an exception). </p>
                   1490: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1491:   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      1492:   instructions how to create your own packages.</p>
1.148     asau     1493: <div class="sect2">
1.75      rillig   1494: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1495: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1496: <p>To build packages from source, you need a working C
1.88      wiz      1497:     compiler. On NetBSD, you need to install the
1.128     wiz      1498:     <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      1499:     sets. If you want to build X11-related packages, the
1.128     wiz      1500:     <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      1501:     sets are required, too.</p>
1.75      rillig   1502: </div>
1.148     asau     1503: <div class="sect2">
1.75      rillig   1504: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1505: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1506: <p>The first step for building a package is downloading the
1.88      wiz      1507:     distfiles (i.e. the unmodified source). If they have not yet been
                   1508:     downloaded, pkgsrc will fetch them automatically.</p>
                   1509: <p>If you have all files that you need in the
                   1510:     <code class="filename">distfiles</code> directory,
                   1511:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1512:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1513:     </p>
1.82      rillig   1514: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1515: <p>
1.110     hubertf  1516:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1517: <p>By default a list of distribution sites will be randomly
                   1518:     intermixed to prevent huge load on servers which holding popular
                   1519:     packages (for example, SourceForge.net mirrors). Thus, every
                   1520:     time when you need to fetch yet another distfile all the mirrors
                   1521:     will be tried in new (random) order. You can turn this feature
                   1522:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1523:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1524: <p>You can overwrite some of the major distribution sites to
                   1525:     fit to sites that are close to your own.  By setting one or two
                   1526:     variables you can modify the order in which the master sites are
                   1527:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1528:     delimited list of domain suffixes.
                   1529:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1530:     contains a whitespace delimited list of regular expressions.  It
                   1531:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1532:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1533:     some examples.  This may save some of your bandwidth and
                   1534:     time.</p>
1.75      rillig   1535: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1536:     if you want to keep the settings, by editing the
1.110     hubertf  1537:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1538:     and adding the definitions there.</p>
1.82      rillig   1539: <p>
1.88      wiz      1540:       If a package depends on many other packages (such as
1.322     leot     1541:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1542:       alternate between periods of
                   1543:       downloading source, and compiling. To ensure you have all the source
                   1544:       downloaded initially you can run the command:
                   1545:       </p>
1.82      rillig   1546: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1547: <p>
1.88      wiz      1548:       which will output and run a set of shell commands to fetch the
                   1549:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1550:       also choose to download the files manually.
                   1551:     </p>
1.75      rillig   1552: </div>
1.148     asau     1553: <div class="sect2">
1.75      rillig   1554: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1555: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1556: <p>
1.88      wiz      1557:       Once the software has downloaded, any patches will be applied, then it
                   1558:       will be compiled for you. This may take some time depending on your
                   1559:       computer, and how many other packages the software depends on and their
                   1560:       compile time.
                   1561:     </p>
1.148     asau     1562: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1563: <h3 class="title">Note</h3>
                   1564: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1565:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1566:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1567: </div>
1.87      wiz      1568: <p>For example, type</p>
1.88      wiz      1569: <pre class="screen">
                   1570: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1571: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1572:     </pre>
1.75      rillig   1573: <p>at the shell prompt to build the various components of the
1.88      wiz      1574:     package.</p>
1.82      rillig   1575: <p>The next stage is to actually install the newly compiled
1.88      wiz      1576:     program onto your system. Do this by entering:
1.82      rillig   1577: 
1.88      wiz      1578:     </p>
1.82      rillig   1579: <pre class="screen">
1.88      wiz      1580: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1581:     </pre>
1.82      rillig   1582: <p>
                   1583: 
1.88      wiz      1584:     while you are still in the directory for whatever package you
                   1585:     are installing.</p>
1.82      rillig   1586: <p>Installing the package on your system may require you to
1.88      wiz      1587:     be root.  However, pkgsrc has a
                   1588:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1589:     to only become root for the actual installation step.</p>
1.82      rillig   1590: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1591:     You can now enter:
1.82      rillig   1592: 
1.88      wiz      1593:     </p>
1.82      rillig   1594: <pre class="screen">
1.88      wiz      1595: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1596:     </pre>
1.82      rillig   1597: <p>
                   1598: 
1.88      wiz      1599:     to remove the compiled files in the work directory, as you shouldn't need
                   1600:     them any more. If other packages were also added to your system
                   1601:     (dependencies) to allow your program to compile, you can tidy these up
                   1602:     also with the command:</p>
1.82      rillig   1603: <pre class="screen">
1.88      wiz      1604: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1605:     </pre>
1.75      rillig   1606: <p>Taking the figlet utility as an example, we can install it on our
1.322     leot     1607:     system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88      wiz      1608: <p>The program is installed under the default root of the
                   1609:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1610:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1611:     variable in your environment, and it will use that value as the
                   1612:     root of your packages tree. So, to use
                   1613:     <code class="filename">/usr/local</code>, set
                   1614:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1615:     Please note that you should use a directory which is dedicated to
                   1616:     packages and not shared with other programs (i.e., do not try and
                   1617:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1618:     to add any of your own files or directories (such as
                   1619:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1620:     <code class="filename">pkgsrc/</code>) below the
                   1621:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1622:     conflicts between programs and other files installed by the
                   1623:     package system and whatever else may have been installed
                   1624:     there.</p>
1.110     hubertf  1625: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1626:     alter some configuration options at build time.  Have a look at
                   1627:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1628:     of what will be set there by default.  Environment variables such
                   1629:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1630:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1631:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1632: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1633:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1634:     or being installed. This may be for debugging purposes, or out of
                   1635:     simple curiosity. A number of utility values have been added to
                   1636:     help with this.</p>
1.128     wiz      1637: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1638: <li class="listitem">
1.378     leot     1639: <p>If you invoke the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1640:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1641:        information will be displayed. For example,</p>
1.75      rillig   1642: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1643: <p>will show all the commands that are invoked, up to and
1.128     wiz      1644:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1645: </li>
1.128     wiz      1646: <li class="listitem">
1.378     leot     1647: <p>If you want to know the value of a certain <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1648:        definition, then the <code class="varname">VARNAME</code> definition
                   1649:        should be used, in conjunction with the show-var
1.378     leot     1650:        target. e.g. to show the expansion of the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1651:        variable <code class="varname">LOCALBASE</code>:</p>
                   1652: <pre class="screen">
                   1653: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1654: /usr/pkg
                   1655: <code class="prompt">%</code>
1.88      wiz      1656:        </pre>
1.75      rillig   1657: </li>
                   1658: </ol></div>
                   1659: <p>If you want to install a binary package that you've either
1.88      wiz      1660:     created yourself (see next section), that you put into
                   1661:     pkgsrc/packages manually or that is located on a remote FTP
                   1662:     server, you can use the "bin-install" target. This target will
1.378     leot     1663:     install a binary package - if available - via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1664:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1665:     sites searched is kept in the variable
                   1666:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.378     leot     1667:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1668:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1669:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1670:     details.</p>
                   1671: <p>A final word of warning: If you set up a system that has a
                   1672:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1673:     set that before any packages are installed, as you cannot use
                   1674:     several directories for the same purpose. Doing so will result in
                   1675:     pkgsrc not being able to properly detect your installed packages,
                   1676:     and fail miserably. Note also that precompiled binary packages are
                   1677:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1678:     <code class="filename">/usr/pkg</code>, and that you should
                   1679:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1680:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1681: </div>
                   1682: </div>
                   1683: </div>
1.148     asau     1684: <div class="chapter">
1.75      rillig   1685: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1686: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1687: <div class="toc">
                   1688: <p><b>Table of Contents</b></p>
1.210     leot     1689: <dl class="toc">
1.267     rillig   1690: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1691: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig   1692: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                   1693: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                   1694: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                   1695: <dd><dl>
                   1696: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                   1697: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1698: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1699: </dl></dd>
1.355     rillig   1700: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                   1701: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig   1702: </dl>
                   1703: </div>
1.104     rillig   1704: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1705: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1706: that file depends on the installation. On NetBSD, when you use
1.378     leot     1707: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1708: <code class="filename">/etc/</code>. In all other cases the default location is
                   1709: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1710: bootstrap program to install the binary packages.</p>
                   1711: <p>The format of the configuration file is that of the usual
                   1712: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1713: is done by setting variables in this file. Note that you can define all
                   1714: kinds of variables, and no special error checking (for example for
1.223     rillig   1715: spelling mistakes) takes place.</p>
1.148     asau     1716: <div class="sect1">
1.75      rillig   1717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1718: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1719: <p>The following variables apply to all
1.89      rillig   1720:     pkgsrc packages. A complete list of the variables that can be
                   1721:     configured by the user is available in
                   1722:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1723:     comments that describe each variable's intent.</p>
1.148     asau     1724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1725: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1726:            packages will be installed. The default is
1.76      rillig   1727:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1728:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1729: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1730:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1731:            installed. The default is
1.76      rillig   1732:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1733: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1734:            X11 is installed on the system. The default is
1.194     bsiegert 1735:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1736: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1737:            downloaded copies of the original source distributions used
                   1738:            for building pkgsrc packages. The default is
1.76      rillig   1739:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1740: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1741:            database about installed packages is stored.  The default is
1.230     sevan    1742:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1743: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1744:            If set, override the packages'
                   1745:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1746: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1747:            Backup location(s) for distribution files and patch files
                   1748:            if not found locally or in
1.76      rillig   1749:            <code class="filename">${MASTER_SITES}</code> or
                   1750:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1751:            The defaults is
                   1752:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1753: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1754:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1755:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1756:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1757:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1758: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1759:            List of acceptable licenses. License names are case-sensitive.
                   1760:            Whenever you try to build a package whose license is not in this
                   1761:            list, you will get an error message. If the license condition is
                   1762:            simple enough, the error message will include specific
                   1763:            instructions on how to change this variable.</p></li>
1.75      rillig   1764: </ul></div>
                   1765: </div>
1.148     asau     1766: <div class="sect1">
1.75      rillig   1767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1768: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1769: <p>
1.75      rillig   1770:       </p>
1.148     asau     1771: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1772: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1773:            directory for the binary packages. The default is
1.76      rillig   1774:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1775: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1776:            The top level directory where, if defined, the separate
                   1777:            working directories will get created, and symbolically
1.76      rillig   1778:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1779:            This is useful for building packages on several
1.76      rillig   1780:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1781:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1782:            is local to every architecture. (It should be noted that
                   1783:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1784:            &mdash; it is an internal definition which refers to the
1.75      rillig   1785:            root of the pkgsrc tree. It is possible to have many
                   1786:            pkgsrc tree instances.)</p></li>
1.128     wiz      1787: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1788:            Directory for local patches that aren't part of pkgsrc.
1.299     rillig   1789:            See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1790:            information.</p></li>
1.128     wiz      1791: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1792:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1793:            BSD-style Makefile. If this is not set,
                   1794:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1795:            <code class="filename">/dev/null</code> to avoid picking up
                   1796:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1797: </ul></div>
                   1798: </div>
1.148     asau     1799: <div class="sect1">
1.75      rillig   1800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355     rillig   1801: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
                   1802: <p>Whenever a package depends on a package that has a
                   1803:     <code class="filename">builtin.mk</code> file, the dependent package can
                   1804:     either use the built-in (native) version from the base system or the
                   1805:     pkgsrc-provided version.  This only affects dependencies, so it is
                   1806:     still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
                   1807:     on the native pcre++ version instead.</p>
                   1808: <p>To force using the pkgsrc-provided version for a particular
                   1809:     package, define <span class="quote">&#8220;<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
                   1810:     <em class="replaceable"><code>package-ID</code></em></span>&#8221;</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
                   1811:     using the native package, define
                   1812:     <span class="quote">&#8220;<span class="quote"><code class="varname">PREFER_NATIVE</code> =
                   1813:     <em class="replaceable"><code>package-ID</code></em></span>&#8221;</span>. In both cases, the
                   1814:     <em class="replaceable"><code>package-ID</code></em> is the one from the
                   1815:     <code class="filename">buildlink3.mk</code> of the package. In most cases,
                   1816:     this ID is the same as the directory name of the package, but for
                   1817:     example, <code class="filename">devel/pcre++</code> has the
                   1818:     package ID <span class="quote">&#8220;<span class="quote">pcrexx</span>&#8221;</span>.</p>
                   1819: <p>For the packages that are not listed by their package ID,
                   1820:     pkgsrc uses the pkgsrc-provided version if
                   1821:     <code class="varname">PREFER_PKGSRC</code> contains the word
                   1822:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
                   1823:     contains the word <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, pkgsrc uses the native
                   1824:     version. For example, to require using the pkgsrc-provided versions
                   1825:     for all but the most basic bits on a NetBSD system, you can
                   1826:     set:</p>
                   1827: <pre class="programlisting">
                   1828: PREFER_PKGSRC=  yes
                   1829: PREFER_NATIVE=  getopt skey tcp_wrappers
                   1830: </pre>
                   1831: <p>A package <span class="emphasis"><em>must</em></span> have a
                   1832:     <code class="filename">builtin.mk</code> file to be listed in
                   1833:     <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
                   1834:     that list.</p>
                   1835: <p><code class="varname">PREFER_PKGSRC</code> and
                   1836:     <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
                   1837:     ensure that the bootstrap process does not use inapropriate native
                   1838:     tools as dependencies for core packages.</p>
                   1839: <pre class="screen">
                   1840: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   1841: </pre>
                   1842: <p>Switching between settings globally at a later date can
                   1843:     introduce complications with dependency resolution.  This is caused
                   1844:     by packages built with the opposite preference being installed
                   1845:     alongside each other.  Hence, when changing any of these variables
                   1846:     after bootstrap, you need to rebuild all packages depending on those
                   1847:     whose preference has been changed.  This is not trivial and should
                   1848:     be avoided.</p>
                   1849: <p>When using pkgsrc on Linux systems, there is high risk of
                   1850:     <span class="quote">&#8220;<span class="quote">leakage</span>&#8221;</span>, where programs installed by pkgsrc may
                   1851:     inadvertently use a command or library not installed by pkgsrc, e.g.
                   1852:     those installed by yum or apt.  Such foreign dependencies may be
                   1853:     installed, removed, or upgraded to a version incompatible with the
                   1854:     pkgsrc package at any time, causing pkgsrc packages to subsequently
                   1855:     malfunction.  Pkgsrc cannot prevent this, as it has no control over
                   1856:     other package managers. Another potential problem is that under
                   1857:     Redhat Enterprise and related Linux systems, yum packages are only
                   1858:     patched and never upgraded, so eventually they may become too
                   1859:     outdated for use by pkgsrc.  Even intentionally using foreign
                   1860:     dependencies, not considered leakage, can lead to these problems, so
                   1861:     it is generally discouraged.  In order to minimize such problems,
                   1862:     PREFER_PKGSRC defaults to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> on Linux systems. This ensures that
                   1863:     pkgsrc is aware of any changes to dependency packages and can
                   1864:     rebuild or upgrade the entire dependency tree as needed.  This
                   1865:     default can be overridden by setting --prefer-pkgsrc to a
                   1866:     list of packages and --prefer-native to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
                   1867: </div>
                   1868: <div class="sect1">
                   1869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1870: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256     maya     1872:                 By default, binary packages of built packages are
1.263     leot     1873:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1874:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1875: <p>Packages have to support installation into a
1.103     wiz      1876:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1877:     to be built, before the actual filesystem is touched. DESTDIR
                   1878:     support exists in two variations:</p>
1.148     asau     1879: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1880: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1881:       installation and packaging is still run as root.</p></li>
                   1882: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1883:       build, installation and packaging as normal user. Root
                   1884:       privileges are only needed to add packages.</p></li>
                   1885: </ul></div>
1.103     wiz      1886: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1887:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1888: <p>Considering the <code class="filename">foo/bar</code> package,
                   1889:     DESTDIR full support can be tested using the following commands
                   1890: 
                   1891: </p>
                   1892: <pre class="programlisting">
                   1893: <code class="prompt">$</code> id
                   1894: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1895: <code class="prompt">$</code> mkdir $HOME/packages
                   1896: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1897: </pre>
                   1898: <p>
                   1899: 
                   1900:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1901:     should be needed
                   1902: 
                   1903: </p>
                   1904: <pre class="programlisting">
1.174     asau     1905: <code class="prompt">$</code> make stage-install
1.118     imil     1906: </pre>
                   1907: <p>
                   1908: 
                   1909:     Create a package without root privileges
                   1910: 
                   1911: </p>
                   1912: <pre class="programlisting">
1.174     asau     1913: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1914: </pre>
                   1915: <p>
                   1916: 
                   1917:     For the following command, you must be able to gain root
1.378     leot     1918:     privileges using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1919: 
                   1920: </p>
                   1921: <pre class="programlisting">
1.174     asau     1922: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1923: </pre>
                   1924: <p>
                   1925: 
                   1926:     Then, as a simple user
                   1927: 
                   1928: </p>
                   1929: <pre class="programlisting">
                   1930: <code class="prompt">$</code> make clean
                   1931: </pre>
                   1932: <p>
                   1933: 
                   1934:     </p>
1.103     wiz      1935: </div>
1.148     asau     1936: <div class="sect1">
1.103     wiz      1937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355     rillig   1938: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1939: <div class="sect2">
1.78      rillig   1940: <div class="titlepage"><div><div><h3 class="title">
1.355     rillig   1941: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1942: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1943:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1944: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1945: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1946: <dd>
                   1947: <p>This is a list of values specifying the chain of
                   1948:          compilers to invoke when building packages.  Valid values
                   1949:          are:</p>
1.148     asau     1950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1951: <li class="listitem"><p><code class="varname">ccc</code>:
                   1952:            Compaq C Compilers (Tru64)</p></li>
                   1953: <li class="listitem"><p><code class="varname">ccache</code>:
                   1954:            compiler cache (chainable)</p></li>
                   1955: <li class="listitem"><p><code class="varname">clang</code>:
                   1956:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1957: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1958:            distributed C/C++ (chainable)</p></li>
1.174     asau     1959: <li class="listitem"><p><code class="varname">f2c</code>:
                   1960:            Fortran 77 to C compiler (chainable)</p></li>
                   1961: <li class="listitem"><p><code class="varname">icc</code>:
                   1962:            Intel C++ Compiler (Linux)</p></li>
                   1963: <li class="listitem"><p><code class="varname">ido</code>:
                   1964:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1965: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1966:            GNU C/C++ Compiler</p></li>
1.174     asau     1967: <li class="listitem"><p><code class="varname">hp</code>:
                   1968:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1969: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1970:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1971: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1972:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1973: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1974:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1975: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1976:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1977: </ul></div>
                   1978: <p>The default is
1.128     wiz      1979:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1980:          <code class="varname">ccache</code> and/or
                   1981:          <code class="varname">distcc</code> with an appropriate
                   1982:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1983:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1984:          variable should always be terminated with a value for
                   1985:          a real compiler.  Note that only one real compiler
1.128     wiz      1986:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1987:          is not allowed).</p>
1.89      rillig   1988: </dd>
                   1989: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1990: <dd><p>This specifies the minimum version of GCC to use
                   1991:          when building packages.  If the system GCC doesn't
                   1992:          satisfy this requirement, then pkgsrc will build and
                   1993:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1994: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1995: <dd><p>Specifies which version of python to use when several
                   1996:          options are available.</p></dd>
                   1997: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1998: <dd><p>Specifies the Fortran compiler to use.
                   1999:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     2000: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   2001: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   2002:          <code class="varname">gfortran</code> is used, this option specifies which
                   2003:          version to use.</p></dd>
1.89      rillig   2004: </dl></div>
                   2005: </div>
1.148     asau     2006: <div class="sect2">
1.89      rillig   2007: <div class="titlepage"><div><div><h3 class="title">
1.355     rillig   2008: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2009: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2010:        please make sure to use the <code class="literal">+=</code> operator
                   2011:        instead of the <code class="literal">=</code> operator:</p>
                   2012: <pre class="programlisting">
1.100     rillig   2013: CFLAGS+=        -your -flags
1.78      rillig   2014: </pre>
                   2015: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      2016:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  2017:        need to add their own flags.  You may want to take a look
1.322     leot     2018:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      2019:        package if you're interested in optimization specifically
                   2020:        for the current CPU. </p>
1.78      rillig   2021: </div>
1.148     asau     2022: <div class="sect2">
1.88      wiz      2023: <div class="titlepage"><div><div><h3 class="title">
1.355     rillig   2024: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2025: <p>If you want to pass flags to the linker, both in the configure
                   2026: step and the build step, you can do this in two ways.  Either set
                   2027: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2028: between the two is that <code class="varname">LIBS</code> will be appended to
                   2029: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2030: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2031: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2032: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2033: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2034: settings, use the <code class="literal">+=</code> operator:</p>
                   2035: <pre class="programlisting">
1.100     rillig   2036: LDFLAGS+=        -your -linkerflags
1.88      wiz      2037: </pre>
                   2038: </div>
1.78      rillig   2039: </div>
1.148     asau     2040: <div class="sect1">
1.78      rillig   2041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355     rillig   2042: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 2043: <p>
1.75      rillig   2044:       </p>
1.148     asau     2045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2046: <li class="listitem">
1.75      rillig   2047: <p><code class="varname">PKG_DEVELOPER</code>:
1.347     gutterid 2048:         Run some sanity checks that package developers want:
                   2049:         </p>
1.148     asau     2050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2051: <li class="listitem"><p>make sure patches apply with zero
1.347     gutterid 2052:             fuzz</p></li>
1.128     wiz      2053: <li class="listitem"><p>run check-shlibs to see that all
1.347     gutterid 2054:             binaries will find their shared libs.</p></li>
1.75      rillig   2055: </ul></div>
                   2056: </li>
1.347     gutterid 2057: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>: 
                   2058:         Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
                   2059:         </code> values in PLIST entries.
                   2060:         </p></li>
1.128     wiz      2061: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347     gutterid 2062:         of debugging output which is displayed whilst making and
                   2063:         installing the package.  The default value for this is 0,
                   2064:         which will not display the commands as they are executed
                   2065:         (normal, default, quiet operation); the value 1 will display
                   2066:         all shell commands before their invocation, and the value 2
                   2067:         will display both the shell commands before their invocation,
                   2068:         as well as their actual execution progress with <span class="command"><strong>set
                   2069:         -x</strong></span>.</p></li>
1.75      rillig   2070: </ul></div>
                   2071: <p>
                   2072:     </p>
                   2073: </div>
1.148     asau     2074: <div class="sect1">
1.75      rillig   2075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355     rillig   2076: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.88      wiz      2077: <p>Some packages have build time options, usually to select
                   2078:     between different dependencies, enable optional support for big
                   2079:     dependencies or enable experimental features.</p>
1.75      rillig   2080: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2081:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2082:     show-options</strong></span>, for example:</p>
1.75      rillig   2083: <pre class="programlisting">
                   2084:     The following options are supported by this package:
                   2085:         ssl      Enable SSL support.
                   2086:     Exactly one of the following gecko options is required:
                   2087:         firefox  Use firefox as gecko rendering engine.
                   2088:         mozilla  Use mozilla as gecko rendering engine.
                   2089:     At most one of the following database options may be selected:
                   2090:         mysql    Enable support for MySQL database.
                   2091:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2092: 
1.75      rillig   2093:     These options are enabled by default: firefox
                   2094:     These options are currently enabled: mozilla ssl
1.1       grant    2095: </pre>
1.75      rillig   2096: <p>The following variables can be defined in
1.110     hubertf  2097:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2098:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2099:     which can be used to select or disable options for all packages
                   2100:     that support them, and
                   2101:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2102:     which can be used to select or disable options specifically for
                   2103:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2104:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2105:     are disabled. A few examples:</p>
1.75      rillig   2106: <pre class="screen">
1.110     hubertf  2107: <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   2108: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2109: PKG_OPTIONS.kdebase=    debug -sasl
                   2110: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2111: <p>It is important to note that options that were specifically
1.120     snj      2112:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2113:     you do not wish to include the option.  If you are unsure you can view
                   2114:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2115: <p>The following settings are consulted in the order given, and
                   2116:     the last setting that selects or disables an option is
                   2117:     used:</p>
1.128     wiz      2118: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2119: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2120:       maintainer</p></li>
1.128     wiz      2121: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2122:       variables (see below)</p></li>
1.128     wiz      2123: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2124: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2125: </ol></div>
                   2126: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2127:     selected is used, all others are automatically disabled.  If an
                   2128:     option of the group is explicitly disabled, the previously
                   2129:     selected option, if any, is used.  It is an error if no option
                   2130:     from a required group of options is selected, and building the
                   2131:     package will fail.</p>
                   2132: <p>Before the options framework was introduced, build options
                   2133:     were selected by setting a variable (often named
                   2134:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2135:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2136:     transition to the options framework for the user, these legacy
                   2137:     variables are converted to the appropriate options setting
                   2138:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2139:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2140:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2141:     directly.  Support for the legacy variables will be removed
                   2142:     eventually.</p>
1.75      rillig   2143: </div>
                   2144: </div>
1.148     asau     2145: <div class="chapter">
1.75      rillig   2146: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2147: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2148: <div class="toc">
                   2149: <p><b>Table of Contents</b></p>
1.210     leot     2150: <dl class="toc">
1.267     rillig   2151: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2152: <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   2153: </dl>
                   2154: </div>
1.148     asau     2155: <div class="sect1">
1.75      rillig   2156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2157: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2158: <p>Once you have built and installed a package, you can create
                   2159:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.378     leot     2160:     another system with <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2161:     the same package on a group of hosts and wasting CPU time. It also
                   2162:     provides a simple means for others to install your package, should
                   2163:     you distribute it.</p>
                   2164: <p>To create a binary package, change into the appropriate
1.110     hubertf  2165:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2166:     package</strong></span>:</p>
                   2167: <pre class="screen">
1.223     rillig   2168: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2169: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2170: </pre>
1.356     gutterid 2171: <p>This will build your package (if not already done) and package
                   2172:     it into a binary package. You can then use the
                   2173:     <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
                   2174:     created in <code class="varname">PACKAGES</code>, which defaults to
                   2175:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
                   2176:     tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, &#8220;Packaging figlet&#8221;</a> for a continuation of
                   2177:     the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a>
                   2178:     example.</p>
1.267     rillig   2179: <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      2180:     such a binary package.</p>
1.75      rillig   2181: </div>
1.148     asau     2182: <div class="sect1">
1.75      rillig   2183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2184: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299     rillig   2185: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2186: </div>
                   2187: </div>
1.148     asau     2188: <div class="chapter">
1.106     rillig   2189: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2190: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2191: builds)</h2></div></div></div>
                   2192: <div class="toc">
                   2193: <p><b>Table of Contents</b></p>
1.210     leot     2194: <dl class="toc">
1.267     rillig   2195: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2196: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2197: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2198: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig   2199: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2200: <dd><dl>
1.294     rillig   2201: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2202: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig   2203: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2204: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2205: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2206: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2207: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2208: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2209: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2210: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2211: </dl></dd>
                   2212: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2213: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2214: </dl>
                   2215: </div>
1.290     gutterid 2216: <p>For a number of reasons, you may want to build binary packages
                   2217: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2218: For instance, when you have multiple machines that should run the same software,
                   2219: it is wasted time if they all build their packages themselves from source.
                   2220: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2221: deploying onto production systems.
1.180     wiz      2222: There is a way of getting a set of binary packages:
1.290     gutterid 2223: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2224: This chapter describes how to set it up.</p>
1.148     asau     2225: <div class="sect1">
1.106     rillig   2226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2227: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2228: <p>First of all, you have to decide whether you build all packages
                   2229: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2230: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2231: A number of particularly heavy packages exist that are not actually
                   2232: interesting to a wide audience. (The approximate resource consumption for a
                   2233: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, &#8220;Requirements of a full bulk build&#8221;</a>.)
                   2234: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2235: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2236: </p>
                   2237: <p>During bulk builds various packages are installed and deinstalled
                   2238: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2239: so make sure that you don't need any package during the builds.
1.223     rillig   2240: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2241: or something even more restrictive, depending on what the operating system provides,
                   2242: or dedicate the whole physical machine.
                   2243: As a useful side effect this makes sure that bulk builds cannot
                   2244: break anything in your system. There have been numerous cases where
1.106     rillig   2245: certain packages tried to install files outside the
                   2246: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2247: <code class="filename">/etc</code>.
                   2248: </p>
1.106     rillig   2249: </div>
1.148     asau     2250: <div class="sect1">
1.106     rillig   2251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295     rillig   2252: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2253: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2255: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2256: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2257: </ul></div>
1.148     asau     2258: <div class="sect2">
1.116     rillig   2259: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2260: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2261: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2262: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2263: Configure network access to fetch distribution files.
1.223     rillig   2264: Create a user with name "pbulk".</p>
1.178     asau     2265: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2266: <pre class="screen">
1.264     sevan    2267: <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>
                   2268: <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      2269: <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     2270: </pre>
                   2271: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2272: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2273: <pre class="screen">
1.230     sevan    2274: <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     2275: <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>
                   2276: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2277: </pre>
                   2278: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2279: <h3 class="title">Note</h3>
                   2280: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2281: <code class="filename">mk.conf</code> that contains settings you want to
                   2282: apply to packages you build. For instance,</p>
                   2283: <pre class="programlisting">
1.223     rillig   2284: PKG_DEVELOPER=          yes     # perform more checks
                   2285: X11_TYPE=               modular # use pkgsrc X11
                   2286: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2287:                                 # when building all packages)
1.178     asau     2288: </pre>
                   2289: </div>
                   2290: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2291: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2292: <pre class="programlisting">
                   2293: www/firefox
                   2294: mail/thunderbird
                   2295: misc/libreoffice4
                   2296: </pre>
1.179     asau     2297: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2298: and make final amendments, if wanted.</p>
1.178     asau     2299: <p>Start it:</p>
                   2300: <pre class="screen">
                   2301: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2302: </pre>
                   2303: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2304: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2305: </p>
                   2306: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2307: <h3 class="title">Note</h3>
                   2308: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2309: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2310: The script is kept small enough for better understanding.</p>
                   2311: </div>
                   2312: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2313: <h3 class="title">Note</h3>
                   2314: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320     wiz      2315: unprivileged bulk build and helps configuring distributed bulk builds.
                   2316: Distributed bulk builds support either building in worker chroots
                   2317: (each node is a path to a different chroot)
                   2318: that replicate the target system, including the pbulk prefix,
                   2319: or remote machines (each node is
                   2320: an IP address that must be accessible over SSH without a password).</p>
1.178     asau     2321: </div>
1.106     rillig   2322: </div>
                   2323: </div>
1.148     asau     2324: <div class="sect1">
1.106     rillig   2325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2326: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2327: <p>A complete bulk build requires lots of disk space. Some of the
                   2328: disk space can be read-only, some other must be writable. Some can be on
                   2329: remote filesystems (such as NFS) and some should be local. Some can be
                   2330: temporary filesystems, others must survive a sudden reboot.</p>
                   2331: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320     wiz      2332: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2333: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180     wiz      2334: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2335: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2336: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2337: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2338: </ul></div>
                   2339: </div>
                   2340: <div class="sect1">
                   2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293     rillig   2342: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2343: <p>To ensure that pkgsrc packages work in different configurations, it
                   2344: makes sense to run non-default bulk builds from time to time. This
                   2345: section lists some ideas for bulk builds that intentionally let packages
                   2346: fail if they don't follow the pkgsrc style.</p>
                   2347: <div class="sect2">
                   2348: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2349: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2350: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2351: <pre class="programlisting">
                   2352: GNU_CONFIGURE_STRICT=   yes
                   2353: </pre>
                   2354: <p>When a package fails this additional check, the most common cause
                   2355: is that the configure option was valid for an older version of the
                   2356: package but does not apply anymore. In that case, just remove it.</p>
                   2357: </div>
                   2358: <div class="sect2">
                   2359: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2360: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2361: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2362: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2363: compiler wrappers make it easy to force compiler options when the package
                   2364: is built. This can be used to find typical bugs across all packages that
                   2365: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2366: more reliable with the next updates.</p>
                   2367: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.293     rillig   2368: <pre class="programlisting">
                   2369: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2370: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2371: </pre>
1.294     rillig   2372: <p>When a package fails to build using these stricter compiler
                   2373: options, document the circumstances in which the compiler produced the
                   2374: error message. This includes:</p>
1.293     rillig   2375: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2376: <li class="listitem"><p>The platform
                   2377: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2378: <li class="listitem"><p>The source file</p></li>
                   2379: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2380: part of the diagnostic.</p></li>
1.294     rillig   2381: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2382: </ul></div>
                   2383: <p>If a package produces these error messages, but the package is
1.294     rillig   2384: fine, record this in your local <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, like this, to skip this check
                   2385: in the next builds:</p>
1.293     rillig   2386: <pre class="programlisting">
1.294     rillig   2387: .if ${PKGPATH} == category/package
1.293     rillig   2388: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2389: # error message
                   2390: # code
1.294     rillig   2391: # Reason why the code does not need to be fixed.
1.293     rillig   2392: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2393: .endif
1.293     rillig   2394: </pre>
                   2395: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2396: needs to be fixed, prepare a local patch (see
                   2397: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2398: authors of the package, providing them with the information you collected
                   2399: above.</p>
                   2400: <p>Patches that are not essential for the package to work should only
                   2401: be reported upstream but not committed to pkgsrc, to make future updates
                   2402: easier.</p>
1.293     rillig   2403: </div>
                   2404: <div class="sect2">
                   2405: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2406: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2407: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2408: these apply to all phases of the package build process. Especially in the
                   2409: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2410: decisions. The GNU configure scripts feed many small test programs to the
                   2411: C compiler to see whether certain headers are available, functions are
                   2412: defined in a library and programs can be run. In many cases these
                   2413: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2414: -Wextra -Werror</code>.</p>
                   2415: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2416: options being added between the <code class="literal">configure</code> and
                   2417: <code class="literal">build</code> phases. It's a little more complicated than the
                   2418: other examples in this section but still easy enough.</p>
                   2419: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2420: desired compiler options. The compiler wrapper's original task is to hide
                   2421: unwanted directories of include files and to normalize compiler options.
                   2422: It does this by wrapping the compiler command and rewriting the command
                   2423: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2424: package directory and examine the
                   2425: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2426: individual configurations for the C compiler and the related tools. The
                   2427: plan is to find a hook between the configure and build phases, and to
                   2428: modify these configuration files at that point.</p>
                   2429: <p>To find this hook, have a look at
                   2430: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2431: <code class="literal">pre-build-checks-hook</code>. The word
                   2432: <code class="literal">checks</code> doesn't quite fit, but the
                   2433: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2434: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2435: <pre class="programlisting">
                   2436: # Just a few example options.
                   2437: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2438: 
                   2439: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2440: pre-build-checks-hook: add-build-only-cflags
                   2441: 
                   2442: add-build-only-cflags: .PHONY
                   2443:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2444:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2445:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2446:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2447:         done;                                   \
                   2448:         &gt; ${.TARGET}
                   2449: .endif
                   2450: </pre>
                   2451: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2452: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2453: not with spaces.)</p>
                   2454: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2455: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2456: should be undefined, possibly because it is only defined for a subset of
                   2457: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2458: at least one compiler option, to prevent a syntax error in the shell
                   2459: parser.</p>
                   2460: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2461: that the additional compiler options are only appended once, even if
                   2462: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2463: creates a marker file.</p>
                   2464: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2465: configure</strong></span> in a package directory. Up to now, everything works
                   2466: as usual. Examine the directory
                   2467: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2468: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2469: the file <code class="filename">cc</code>. Examine the tail of the
                   2470: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2471: options are used.</p>
                   2472: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2473: options to the file <code class="filename">cc</code> and will create the marker
                   2474: file in the same directory. After that, the build starts as usual, but
                   2475: with the added compiler options. Examine the tail of the file
                   2476: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2477: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2478: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2479: with these options.</p>
                   2480: <p>Building packages using this setup variant and fixing the resulting
                   2481: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, &#8220;Detect classes of bugs by forcing compiler warnings&#8221;</a>.</p>
                   2482: </div>
                   2483: <div class="sect2">
                   2484: <div class="titlepage"><div><div><h3 class="title">
                   2485: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293     rillig   2486: <p>Some directories like <code class="varname">PREFIX</code>,
                   2487: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2488: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2489: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2490: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2491: <pre class="programlisting">
                   2492: PREFIX=         /a-random-uuid
                   2493: PKG_SYSCONFDIR= /a-random-uuid
                   2494: VARBASE=        /a-random-uuid
                   2495: PKGMANDIR=     a-random-uuid
                   2496: PKG_INFODIR=   a-random-uuid
                   2497: </pre>
                   2498: </div>
                   2499: <div class="sect2">
                   2500: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2501: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2502: <p>When building a package, warnings are typically ignored since they
                   2503: just flow by and do not cause the build to fail immediately. To find
                   2504: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2505: <pre class="programlisting">
                   2506: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2507: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2508: </pre>
                   2509: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2510: them can be redefined with a simple definition like above.</p>
1.294     rillig   2511: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2512: the package Makefile, research whether the package actually needs Perl.
                   2513: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2514: Makefile, and if it doesn't, add
                   2515: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2516: </div>
                   2517: <div class="sect2">
                   2518: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2519: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2520: <p>Using pkglint as part of the regular build process is mostly a
                   2521: waste of time. If you want to fix some of the warnings, just run pkglint
                   2522: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2523: 10), which is much faster than a complete bulk build.</p>
                   2524: </div>
                   2525: <div class="sect2">
                   2526: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2527: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2528: <p>To ensure that the binary packages don't contain references to the
                   2529: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2530: that variable includes the item <code class="literal">extra</code>, it is
                   2531: possible to define additional patterns that must not appear in any
                   2532: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2533: <pre class="programlisting">
                   2534: CHECK_WRKREF=                   extra
                   2535: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2536: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2537: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2538: </pre>
                   2539: <p>The above patterns will probably generate many false positives,
                   2540: therefore the results need to be taken with a grain of salt.</p>
                   2541: </div>
                   2542: <div class="sect2">
                   2543: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2544: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2545: <p>To run the test suites that come with each package, add this line
                   2546: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2547: <pre class="programlisting">
                   2548: PKGSRC_RUN_TEST=        yes
                   2549: </pre>
                   2550: <p>Be prepared that even the most basic packages fail this test. When
                   2551: doing a bulk build with this, it will often abort in the early phase
                   2552: where the packages are scanned for their dependencies since there are
                   2553: cyclic dependencies. There is still a lot to do in this area.</p>
                   2554: </div>
                   2555: <div class="sect2">
                   2556: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2557: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2558: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2559: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2560: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2561: <pre class="programlisting">
                   2562: RUN=    @set -eu;
                   2563: </pre>
1.296     rillig   2564: <p>After that, ensure that none of the bulk build log files (even
                   2565: those for successfully built packages) contains the string
                   2566: <code class="literal">parameter not set</code> or whatever error message the
                   2567: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2568: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2569: definition.</p>
                   2570: </div>
                   2571: <div class="sect2">
                   2572: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2573: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2574: <p>The build logs of a package are often quite long. This allows error
                   2575: messages or other interesting details to hide between the noise. To make
                   2576: the actual error message stand out more, add these lines to
                   2577: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2578: <pre class="programlisting">
                   2579: GNU_CONFIGURE_QUIET=    yes
                   2580: MAKE_FLAGS+=            -s
                   2581: </pre>
                   2582: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2583: Make. On exotic platforms with their own make, it may be a little
                   2584: different.</p>
                   2585: </div>
                   2586: </div>
                   2587: <div class="sect1">
                   2588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2589: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2590: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2591:     create a CD-ROM set of the resulting binary packages to assist
                   2592:     in installing packages on other machines.  The
1.322     leot     2593:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2594:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2595:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2596:     way that keeps all the dependencies for a given package on the same
                   2597:     CD as that package.</p>
1.148     asau     2598: <div class="sect2">
1.75      rillig   2599: <div class="titlepage"><div><div><h3 class="title">
1.293     rillig   2600: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2601: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2602:       man page. The following short example assumes that the binary
                   2603:       packages are left in
                   2604:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2605:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2606:       hold the ISO 9660 images.</p>
                   2607: <pre class="screen">
                   2608: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2609: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2610: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2611:       </pre>
                   2612: <p>If you wish to include a common set of files
                   2613:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2614:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2615:       directory which contains these files, e.g.:</p>
1.87      wiz      2616: <pre class="screen">
                   2617: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2618: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2619: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2620: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2621: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2622: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2623: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2624:       </pre>
1.75      rillig   2625: <p>Now create the images:</p>
                   2626: <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   2627: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2628:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2629:       in their root directories.</p>
1.75      rillig   2630: </div>
                   2631: </div>
                   2632: </div>
1.148     asau     2633: <div class="chapter">
1.75      rillig   2634: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2635: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2636: <div class="toc">
                   2637: <p><b>Table of Contents</b></p>
1.210     leot     2638: <dl class="toc">
1.267     rillig   2639: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2640: <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   2641: </dl>
                   2642: </div>
                   2643: <p>The files that are installed by pkgsrc are organized in a way that
                   2644: is similar to what you find in the <code class="filename">/usr</code> directory
                   2645: of the base system. But some details are different. This is because
                   2646: pkgsrc initially came from FreeBSD and had adopted its file system
                   2647: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2648: which operating system you are using pkgsrc with, you can expect the
                   2649: same layout for pkgsrc.</p>
1.91      rillig   2650: <p>There are mainly four root directories for pkgsrc, which are all
                   2651: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2652: When pkgsrc has been installed as root, the default locations
                   2653: are:</p>
                   2654: <pre class="programlisting">
1.100     rillig   2655: LOCALBASE=              /usr/pkg
                   2656: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2657: VARBASE=                /var
1.231     sevan    2658: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2659: </pre>
                   2660: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2661: user), the default locations are:</p>
                   2662: <pre class="programlisting">
1.100     rillig   2663: LOCALBASE=              ${HOME}/pkg
                   2664: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2665: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2666: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2667: </pre>
                   2668: <p>What these four directories are for, and what they look like is
                   2669: explained below.</p>
1.148     asau     2670: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2671: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2672: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2673: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2674: the well-known subdirectories like <code class="filename">bin</code>,
                   2675: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2676: <code class="filename">share</code> and
                   2677: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2678: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2679: <code class="filename">/var</code> in the base system. Some programs (especially
                   2680: games, network daemons) need write access to it during normal
                   2681: operation.</p></li>
1.128     wiz      2682: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2683: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2684: 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   2685: itself.</p></li>
                   2686: </ul></div>
1.148     asau     2687: <div class="sect1">
1.90      rillig   2688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2689: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2690: </h2></div></div></div>
1.90      rillig   2691: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2692: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2693: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2694: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2695: <dd><p>Contains executable programs that are intended to be
                   2696: directly used by the end user.</p></dd>
                   2697: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2698: <dd><p>Contains files for the emulation layers of various other
                   2699: operating systems, especially for
                   2700: NetBSD.</p></dd>
                   2701: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2702: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2703: <dd><p>Contains
                   2704: the configuration files.</p></dd>
                   2705: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2706: <dd><p>Contains headers for the C and C++ programming
                   2707: languages.</p></dd>
                   2708: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2709: <dd><p>Contains GNU info files of various
                   2710: packages.</p></dd>
                   2711: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2712: <dd><p>Contains shared and static
                   2713: libraries.</p></dd>
                   2714: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2715: <dd><p>Contains data files that don't change after
                   2716: installation. Other data files belong into
                   2717: <code class="filename">${VARBASE}</code>.</p></dd>
                   2718: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2719: <dd><p>Contains programs that are not intended to be used by
                   2720: end users, such as helper programs or network
                   2721: daemons.</p></dd>
                   2722: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2723: <dd><p>Contains programs that are intended to be executed as
                   2724: CGI scripts by a web server.</p></dd>
                   2725: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2726: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2727: <dd><p>Contains brief
                   2728: documentation in form of manual pages.</p></dd>
                   2729: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2730: <dd><p>Contains programs that are intended to be used only by
                   2731: the super-user.</p></dd>
                   2732: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2733: <dd><p>Contains platform-independent data files that don't
                   2734: change after installation.</p></dd>
                   2735: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2736: <dd><p>Contains documentation files provided by the
                   2737: packages.</p></dd>
                   2738: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2739: <dd><p>Contains example files provided by the packages. Among
                   2740: others, the original configuration files are saved here and copied to
                   2741: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2742: installation.</p></dd>
                   2743: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2744: <dd><p>Contains the original files for rc.d
                   2745: scripts.</p></dd>
                   2746: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2747: <code class="filename">${VARBASE}</code>)</span></dt>
                   2748: <dd><p>Contains files
                   2749: that may be modified after
                   2750: installation.</p></dd>
                   2751: </dl></div>
                   2752: </div>
1.148     asau     2753: <div class="sect1">
1.90      rillig   2754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2755: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2756: </h2></div></div></div>
1.148     asau     2757: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2758: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2759: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2760: <dd><p>Contains
                   2761: information about the currently installed
                   2762: packages.</p></dd>
                   2763: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2764: <dd><p>Contains highscore
                   2765: files.</p></dd>
                   2766: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2767: <dd><p>Contains log files.</p></dd>
                   2768: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2769: <dd><p>Contains informational files about daemons that are
                   2770: currently running.</p></dd>
                   2771: </dl></div>
                   2772: </div>
                   2773: </div>
1.148     asau     2774: <div class="chapter">
1.90      rillig   2775: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2776: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2777: <div class="toc">
                   2778: <p><b>Table of Contents</b></p>
1.210     leot     2779: <dl class="toc">
1.267     rillig   2780: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2781: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2782: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2783: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2784: <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>
                   2785: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2786: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2787: <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>
                   2788: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2789: <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      2790: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2791: <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>
1.336     nia      2792: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig   2793: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2794: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2795: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2796: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2797: <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   2798: </dl>
                   2799: </div>
                   2800: <p>This section contains hints, tips &amp; tricks on special things in
                   2801: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2802: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2803: <div class="sect1">
1.75      rillig   2804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2805: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2806: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2807: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2808: <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   2809:          This is a general purpose list for most issues regarding
                   2810:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2811:          for pkgsrc configuration, unexpected build failures, using
                   2812:          particular packages, upgrading pkgsrc installations,
                   2813:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2814:          proposals for changes that impact the pkgsrc user community,
                   2815:          e.g. major infrastructure changes, new features, package
                   2816:          removals, etc., may also be posted.</p></li>
1.289     leot     2817: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2818:          A list where the results of pkgsrc bulk builds are sent and
                   2819:          discussed.</p></li>
1.289     leot     2820: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2821:          This list is for those who are interested in getting a
                   2822:          commit message for every change committed to pkgsrc. It is
                   2823:          also available in digest form, meaning one daily message
                   2824:          containing all commit messages for changes to the package
                   2825:          source tree in that 24 hour period.</p></li>
                   2826: </ul></div>
                   2827: <p>To subscribe, do:</p>
                   2828: <pre class="programlisting">
1.100     rillig   2829: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2830: </pre>
                   2831: <p>Archives for all these mailing lists are available from
1.289     leot     2832: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2833: </div>
1.148     asau     2834: <div class="sect1">
1.75      rillig   2835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2836: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2837: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2838: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2839: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2840: they might be useful, and not to duplicate the documentation that comes
                   2841: with each package.</p>
                   2842: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322     leot     2843: <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/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2844:       Symlinks for use by buildlink.</p></li></ul></div>
                   2845: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2846: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2847: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2848:       Calculates various kinds of checksums (including SHA3).</p></li>
1.322     leot     2849: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2850:       Compatibility library for pkgsrc tools.</p></li>
1.322     leot     2851: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2852:       non-BSD systems due to lack of native mtree.</p></li>
1.322     leot     2853: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2854:       Up-to-date replacement for
1.76      rillig   2855:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2856:       systems where pkg_install is not present.</p></li>
                   2857: </ul></div>
                   2858: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2859: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2860: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2861:       Create a binary package from an
1.110     hubertf  2862:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2863:       save the old package.</p></li>
1.322     leot     2864: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2865:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2866:       from multiple locations. It currently supports the following
                   2867:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322     leot     2868: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2869:       the best compiler flags to optimise code for your current
1.128     wiz      2870:       CPU and compiler. </p></li>
1.75      rillig   2871: </ul></div>
                   2872: <p>Utilities for keeping track of installed packages, being up to date,
                   2873: etc:</p>
1.148     asau     2874: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2875: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2876:     update tool similar to apt(1). Download, install, and upgrade
                   2877:     binary packages easily.</p></li>
1.322     leot     2878: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2879:       packages whose installed versions do not match the latest pkgsrc
                   2880:       entries.</p></li>
1.322     leot     2881: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2882:       dependency graphs of packages, to aid in choosing a strategy for
                   2883:       updating.</p></li>
1.322     leot     2884: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/index.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2885:       graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2886: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2887:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322     leot     2888: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2889:       does various checks on the complete pkgsrc system.</p></li>
1.322     leot     2890: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2891:       packages you have installed.</p></li>
                   2892: </ul></div>
                   2893: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2894: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2895: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2896:       making and maintaining patches for a package (includes pkgdiff,
                   2897:       pkgvi, mkpatches, etc.).</p></li>
1.322     leot     2898: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2899:       converting to pkgsrc.</p></li>
                   2900: </ul></div>
                   2901: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2902: utilities)</p>
1.148     asau     2903: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2904: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2905:       packages in a chrooted area.</p></li>
1.322     leot     2906: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2907:       kernel version for chrooted cross builds.</p></li>
                   2908: </ul></div>
                   2909: </div>
1.148     asau     2910: <div class="sect1">
1.75      rillig   2911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2912: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2913: <p>To install packages from source as a non-root user, download
1.267     rillig   2914: 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   2915: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2916: --unprivileged</strong></span>.</p>
                   2917: <p>This will install the binary part of pkgsrc to
                   2918: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2919: into <code class="filename">~/pkg/etc</code>.</p>
                   2920: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2921: </div>
1.148     asau     2922: <div class="sect1">
1.75      rillig   2923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2924: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2925: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2926: enable this feature by adding the option
                   2927: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2928: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2929: distfile is found, pkgsrc will try to resume it.</p>
                   2930: <p>You can also
1.168     wiz      2931: use a different program than the platform default program by changing the
1.117     jnemeth  2932: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2933: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2934: by using the value manual.  A value of custom disables the system defaults
                   2935: and dependency tracking for the fetch program.  In that case you have to
                   2936: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2937: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2938: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2939: <p>For example, if you want to use
1.117     jnemeth  2940: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2941: like:</p>
                   2942: <pre class="programlisting">
1.223     rillig   2943: FETCH_USING=    wget
1.1       grant    2944: </pre>
1.75      rillig   2945: </div>
1.148     asau     2946: <div class="sect1">
1.75      rillig   2947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2948: <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      2949: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2950: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2951: you will have to add the following line into
1.110     hubertf  2952: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2953: <pre class="programlisting">
1.103     wiz      2954: X11_TYPE=modular
1.1       grant    2955: </pre>
1.75      rillig   2956: </div>
1.148     asau     2957: <div class="sect1">
1.75      rillig   2958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2959: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2960: <p>If you are sitting behind a firewall which does not allow direct
                   2961: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2962: relevant proxy hosts.  This is done using an environment variable in the
                   2963: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2964: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2965: port 80 as the proxy port number.  So the proxy environment variables
                   2966: are:</p>
                   2967: <pre class="programlisting">
1.100     rillig   2968: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2969: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2970: </pre>
1.75      rillig   2971: </div>
1.148     asau     2972: <div class="sect1">
1.75      rillig   2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2974: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2975: <p>Some fetch tools are not prepared to support HTTPS by default
                   2976: (for example, the one in NetBSD 6.0), or the one installed by the
                   2977: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2978: dependency graph).</p>
                   2979: <p>Usually you won't notice, because distribution files are
                   2980: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2981: be often enough if you are following pkgsrc-current. In that case, set
                   2982: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2983: <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
                   2984: with HTTPS support by default. Of course, these tools need to be
                   2985: installed before you can use them this way.</p>
                   2986: </div>
                   2987: <div class="sect1">
                   2988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2989: <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   2990: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2991: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2992: the first available command from the following list:</p>
1.148     asau     2993: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2994: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2995: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2996: </ul></div>
                   2997: <p>On a default NetBSD installation, this will be
1.76      rillig   2998: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2999: connections first, and falls back to active connections if the server
                   3000: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3001: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3002: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3003: <p>Having that option present will prevent
1.76      rillig   3004: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3005: transfers.</p>
                   3006: </div>
1.148     asau     3007: <div class="sect1">
1.75      rillig   3008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3009: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3010: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3011: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3012: 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   3013: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3014: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3015: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3016: resulting list to your machine at work/school and use it there.  If you
1.378     leot     3017: don't have a NetBSD-compatible <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3018: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3019: URL:</p>
                   3020: <p>At home:</p>
                   3021: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3022: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3023: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3024: <p>At work:</p>
                   3025: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3026: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3027: home.</p>
                   3028: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3029: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3030: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3031: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3032: directly by running:</p>
1.75      rillig   3033: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3034: <p>If you even decide to ignore
                   3035: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3036: by running:</p>
                   3037: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3038: </div>
1.148     asau     3039: <div class="sect1">
1.75      rillig   3040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3041: <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      3042: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.322     leot     3043: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3044: package, you get the error from make that it doesn't know how to make
1.76      rillig   3045: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      3046: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   3047: the NetBSD base distribution on your machine.  It is recommended to do
                   3048: that to format man pages.</p>
1.322     leot     3049: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3050: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3051: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3052: </div>
1.148     asau     3053: <div class="sect1">
1.75      rillig   3054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3055: <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      3056: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3057: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3058: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3059: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3060: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3061: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3062: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3063: -r</strong></span>).</p>
                   3064: </div>
1.148     asau     3065: <div class="sect1">
1.75      rillig   3066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336     nia      3067: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75      rillig   3068: <p>When installing packages as non-root user and using the just-in-time
1.378     leot     3069: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.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   3070: password for each required package installed.  To avoid this, the sudo
                   3071: package can be used, which does password caching over a limited time.  To
1.336     nia      3072: use it, install <span class="command"><strong>sudo</strong></span> or
                   3073: <span class="command"><strong>priv</strong></span> (either as binary package, from
                   3074: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.322     leot     3075: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3076: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3077: <span class="emphasis"><em>after</em></span> the definition of the
                   3078: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3079: <pre class="programlisting">
1.100     rillig   3080: .if exists(${LOCALBASE}/bin/sudo)
1.379     wiz      3081: SU_CMD=        ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.100     rillig   3082: .endif
1.1       grant    3083: </pre>
1.379     wiz      3084: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
                   3085: <span class="command"><strong>sudo</strong></span> to preserve the environment.
                   3086: Without this, the bin-install target will fail when building a
                   3087: package with a non-default python version.
                   3088: </p>
1.75      rillig   3089: </div>
1.148     asau     3090: <div class="sect1">
1.75      rillig   3091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3092: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3093: <p>As the system administrator, you can choose where configuration files
                   3094: are installed.  The default settings make all these files go into
1.76      rillig   3095: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3096: be suboptimal depending on your expectations (e.g., a read-only,
                   3097: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3098: configuration of the provided packages).</p>
                   3099: <p>In order to change the defaults, you can modify the
                   3100: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3101: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3102: directory; some common examples include <code class="filename">/etc</code> or
                   3103: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3104: <p>Furthermore, you can change this value on a per-package basis by
                   3105: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3106: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3107: package you would like to modify, that is, the contents of
                   3108: <code class="varname">PKGBASE</code>.</p>
                   3109: <p>Note that after changing these settings, you must rebuild and
                   3110: reinstall any affected packages.</p>
                   3111: </div>
1.148     asau     3112: <div class="sect1">
1.75      rillig   3113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3114: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3115: <p>Please be aware that there can often be bugs in third-party software,
                   3116: and some of these bugs can leave a machine vulnerable to exploitation by
                   3117: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3118: maintains a database of known-exploits to packages which have at one time
                   3119: been included in pkgsrc.  The database can be downloaded automatically, and
                   3120: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3121: do this, refer to the following two tools (installed as part of the
1.322     leot     3122: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3123: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3124: <li class="listitem">
1.122     reed     3125: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3126:     download a list of the security vulnerabilities information.  This list
1.132     spz      3127:     is kept up to date by the pkgsrc security team, and is distributed
                   3128:     from the NetBSD ftp server:</p>
1.292     leot     3129: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75      rillig   3130: </li>
1.128     wiz      3131: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3132:     current machine, checking each known vulnerability.  If a
1.75      rillig   3133:     vulnerable package is installed, it will be shown by output to stdout,
                   3134:     including a description of the type of vulnerability, and a URL
                   3135:     containing more information.</p></li>
                   3136: </ol></div>
1.233     sevan    3137: <p>Use of these tools is strongly recommended!
1.317     nia      3138: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    3139: reporting.</p>
                   3140: <p>If this database is installed, pkgsrc builds will use it to
                   3141: perform a security check before building any package.</p>
1.75      rillig   3142: </div>
1.148     asau     3143: <div class="sect1">
1.75      rillig   3144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3145: <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   3146: <p>When you add your own preferences to the
                   3147:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3148:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3149:        environment variables to the <code class="filename">./configure</code>
1.378     leot     3150:        scripts and to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3151:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3152:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3153:        package.</p>
                   3154: <p>Currently there is no solution to this problem. If you
                   3155:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3156:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3157:        directory and then inspect any <code class="filename">Makefile</code> and
                   3158:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3159:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3160:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3161:        programmers write so bad code that it only works for the
                   3162:        specific combination of <code class="varname">CFLAGS</code> they have
                   3163:        chosen.</p>
1.287     rillig   3164: <p>To find out where the CFLAGS are ignored, add the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
                   3165: <pre class="programlisting">
                   3166: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3167: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3168: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3169: </pre>
                   3170: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3171: to see whether the above flags are passed to the actual build
                   3172: commands in general.</p>
                   3173: <p>To find out whether the flags are passed to individual compiler
                   3174: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3175: most cases, the flags from the original command lines (the lines starting
                   3176: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3177: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3178: missing from the actual compiler command, it must have been removed by
1.299     rillig   3179: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3180: </div>
1.148     asau     3181: <div class="sect1">
1.80      rillig   3182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3183: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3184: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3185: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3186:        case that occurs often is that people only update pkgsrc in
                   3187:        parts, because of performance reasons. Since pkgsrc is one large
                   3188:        system, not a collection of many small systems, there are
                   3189:        sometimes changes that only work when the whole pkgsrc tree is
                   3190:        updated.</p></li>
1.148     asau     3191: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3192:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3193:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3194:        files.</p></li>
1.148     asau     3195: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3196:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3197:        verify this.</p></li>
1.218     rillig   3198: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   3199:        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     3200: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3201:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3202: </ol></div>
                   3203: </div>
1.148     asau     3204: <div class="sect1">
1.88      wiz      3205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3206: <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   3207: <p>You have modified a file from pkgsrc, and someone else has
                   3208: modified that same file afterwards in the CVS repository. Both changes
                   3209: are in the same region of the file, so when you updated pkgsrc, the
                   3210: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3211: file. Because of these markers, the file is no longer a valid
                   3212: <code class="filename">Makefile</code>.</p>
                   3213: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3214: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3215: -dP</strong></span> in that directory to download the current version.</p>
                   3216: </div>
1.75      rillig   3217: </div>
                   3218: </div>
1.148     asau     3219: <div class="part">
1.75      rillig   3220: <div class="titlepage"><div><div><h1 class="title">
                   3221: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3222: <div class="partintro">
1.77      rillig   3223: <div></div>
                   3224: <p>This part of the book deals with creating and
1.128     wiz      3225:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3226:        guide on creating a new package. The remaining chapters are more
                   3227:        like a reference manual for pkgsrc.</p>
1.75      rillig   3228: <div class="toc">
                   3229: <p><b>Table of Contents</b></p>
1.210     leot     3230: <dl class="toc">
1.267     rillig   3231: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3232: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3233: <dd><dl>
1.299     rillig   3234: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3235: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3236: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3237: <dd><dl>
1.299     rillig   3238: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3239: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3240: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3241: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3242: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3243: </dl></dd>
1.299     rillig   3244: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3246: <dd><dl>
                   3247: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3248: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3249: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3250: </dl></dd>
                   3251: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3252: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3253: </dl></dd>
1.299     rillig   3254: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3255: <dd><dl>
1.299     rillig   3256: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3257: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3258: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3259: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3260: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3261: <dd><dl>
1.299     rillig   3262: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3263: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3264: </dl></dd>
1.299     rillig   3265: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3266: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3267: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3268: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3269: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3270: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3271: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3272: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3273: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3274: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3275: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3276: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3277: </dl></dd>
                   3278: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3279: <dd><dl>
                   3280: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3281: <dd><dl>
1.334     nia      3282: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   3283: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   3284: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig   3285: </dl></dd>
1.299     rillig   3286: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3287: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig   3288: </dl></dd>
1.299     rillig   3289: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3290: <dd><dl>
1.299     rillig   3291: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3292: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3293: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3294: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3295: <dd><dl>
1.299     rillig   3296: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3297: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3298: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   3299: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 3300: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig   3301: </dl></dd>
                   3302: </dl></dd>
1.299     rillig   3303: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3304: <dd><dl>
1.299     rillig   3305: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3306: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   3307: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3308: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3309: </dl></dd>
1.299     rillig   3310: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3311: <dd><dl>
1.299     rillig   3312: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3313: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3314: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3315: </dl></dd>
                   3316: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3317: <dd><dl>
                   3318: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3319: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3320: <dd><dl>
1.299     rillig   3321: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3322: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3323:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3324:       and
                   3325:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3326:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3327: </dl></dd>
1.299     rillig   3328: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig   3329: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig   3330: </dl></dd>
                   3331: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3332: <dd><dl>
1.299     rillig   3333: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3334: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3335: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   3336: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3337: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3338: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3339: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3340: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3341: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3342: </dl></dd>
1.299     rillig   3343: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3344: <dd><dl>
                   3345: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3346: <dd><dl>
                   3347: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3348: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3349: </dl></dd>
1.299     rillig   3350: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3351: <dd><dl>
1.299     rillig   3352: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3353: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353     dholland 3354: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   3355: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   3356: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   3357: </dl></dd>
                   3358: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3359: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3360: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3361: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3362: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3363: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3364: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig   3365: </dl></dd>
                   3366: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3367: <dd><dl>
                   3368: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3369: <dd><dl>
                   3370: <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>
                   3371: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3372: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3373: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3374: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3375: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3376: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3377: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3378: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3379: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3380: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3381: </dl></dd>
                   3382: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3383: <dd><dl>
                   3384: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3385: <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>
                   3386: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3387: </dl></dd>
                   3388: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3389: <dd><dl>
                   3390: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3391: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3392: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      3393: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      3394: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   3395: </dl></dd>
                   3396: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3397: <dd><dl>
                   3398: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3399: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      3400: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      3401: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   3402: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   3403: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   3404: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   3405: </dl></dd>
                   3406: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3407: <dd><dl>
                   3408: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3409: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3410: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3411: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   3412: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3413: </dl></dd>
                   3414: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3415: <dd><dl>
                   3416: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3417: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3418: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3419: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3420: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      3421: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      3422: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   3423: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   3424: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   3425: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   3426: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   3427: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   3428: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   3429: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   3430: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   3431: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      3432:     emulation</a></span></dt>
1.369     wiz      3433: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   3434: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig   3435: </dl></dd>
1.267     rillig   3436: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3437: </dl></dd>
1.299     rillig   3438: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3439: <dd><dl>
                   3440: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3441: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3442: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3443: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3444: </dl></dd>
1.267     rillig   3445: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3446: <dd><dl>
1.267     rillig   3447: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3448: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3449: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3450: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3451: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3452: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3453: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3454: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3455: </dl></dd>
1.382     wiz      3456: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                   3457: <dd><dl>
                   3458: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   3459: <dd><dl>
                   3460: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   3461: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   3462: </dl></dd>
                   3463: </dl></dd>
                   3464: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig   3465: </dl>
                   3466: </div>
1.77      rillig   3467: </div>
1.148     asau     3468: <div class="chapter">
1.77      rillig   3469: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3470: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3471: <p>
                   3472:        To get help when developing pkgsrc, the definitive source is this
                   3473:        document, the pkgsrc guide. If you don't find anything here,
                   3474:        there are alternatives:
                   3475: </p>
                   3476: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3477: <li class="listitem">
                   3478: <p>
                   3479:        The built-in pkgsrc help, which is available after bootstrapping
                   3480:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3481:        help for any topic, such as a variable name like
                   3482:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3483:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3484:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322     leot     3485: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267     rillig   3486: </li>
                   3487: <li class="listitem"><p>
1.278     rillig   3488:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3489:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3490: </p></li>
                   3491: <li class="listitem"><p>
                   3492:        To see the values of the most common variables, run
                   3493:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3494:        topic. To see the variables for a single topic, run
                   3495:        <span class="command"><strong>bmake
                   3496:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3497:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3498: </p></li>
                   3499: <li class="listitem"><p>
1.267     rillig   3500:        The tech-pkg mailing list, to which
                   3501:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3502:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3503:        questions</a>.</p></li>
                   3504: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland 3505:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig   3506:        or by using a specialized chat program such as
                   3507:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3508:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3509: </ul></div>
                   3510: </div>
                   3511: <div class="chapter">
                   3512: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3513: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3514: <div class="toc">
                   3515: <p><b>Table of Contents</b></p>
1.210     leot     3516: <dl class="toc">
1.299     rillig   3517: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3518: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3519: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3520: <dd><dl>
                   3521: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3522: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3523: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3524: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3525: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3526: </dl></dd>
                   3527: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3528: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3529: <dd><dl>
                   3530: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3531: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3532: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3533: </dl></dd>
1.299     rillig   3534: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3535: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3536: </dl>
                   3537: </div>
1.299     rillig   3538: <p>Whenever you're preparing a package, there are a number of
                   3539: files involved which are described in the following
                   3540: sections.</p>
                   3541: <div class="sect1">
                   3542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3543: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3544: </h2></div></div></div>
                   3545: <p>Building, installation and creation of a binary package are all
                   3546:   controlled by the package's <code class="filename">Makefile</code>.
                   3547:   The <code class="filename">Makefile</code> describes various things about
                   3548:   a package, for example from where to get it, how to configure,
                   3549:   build, and install it.</p>
                   3550: <p>A package <code class="filename">Makefile</code> contains several
                   3551:   sections that describe the package.</p>
                   3552: <p>In the first section there are the following variables, which
                   3553:   should appear exactly in the order given here.  The order and
                   3554:   grouping of the variables is mostly historical and has no further
                   3555:   meaning.</p>
                   3556: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3557: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3558:     distribution file to be downloaded from the package's
                   3559:     website.</p></li>
                   3560: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3561:     package, as used by pkgsrc. You need to provide it if
                   3562:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3563:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3564:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3565:     directory name together with the version number. It must match the
                   3566:     regular expression
                   3567:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3568:     starts with a letter or digit, and contains only letters, digits,
1.319     nia      3569:     dashes, underscores, dots and plus signs.
                   3570:     New packages should have entirely lower-case names, with the exception
                   3571:     of some that must follow pre-existing conventions
                   3572:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3573:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3574:     the package name.</p></li>
1.299     rillig   3575: <li class="listitem">
                   3576: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3577:     which the package fits in. You can choose any of the top-level
                   3578:     directories of pkgsrc for it.</p>
                   3579: <p>Currently the following values are available for
                   3580:     <code class="varname">CATEGORIES</code>. If more than
                   3581:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3582: <pre class="programlisting">
1.299     rillig   3583: archivers     cross         geography     meta-pkgs     security
                   3584: audio         databases     graphics      misc          shells
                   3585: benchmarks    devel         ham           multimedia    sysutils
                   3586: biology       editors       inputmethod   net           textproc
                   3587: cad           emulators     lang          news          time
                   3588: chat          finance       mail          parallel      wm
                   3589: comms         fonts         math          pkgtools      www
                   3590: converters    games         mbone         print         x11
1.77      rillig   3591: </pre>
                   3592: </li>
1.299     rillig   3593: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3594:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3595:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3596:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3597:     <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
                   3598: </ul></div>
                   3599: <p>The second section contains information about separately
                   3600:   downloaded patches, if any.
                   3601:   </p>
                   3602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3603: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3604:     Name(s) of additional files that contain distribution patches.
                   3605:     There is no default. pkgsrc will look for them at
                   3606:     <code class="varname">PATCH_SITES</code>.
                   3607:     They will automatically be uncompressed before patching if
                   3608:     the names end with <code class="filename">.gz</code> or
                   3609:     <code class="filename">.Z</code>.</p></li>
                   3610: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3611:     Primary location(s) for distribution patch files (see
                   3612:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3613: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.378     leot     3614:     an argument to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   3615:     help find the correct files to patch. It defaults to
                   3616:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3617: </ul></div>
                   3618: <p>The third section contains the following variables.
                   3619:   </p>
                   3620: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.367     gdt      3621: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
                   3622:     of the person who is currently responsible for this package.  In
                   3623:     theory, the maintainer will be aware of upstream release, keep it
                   3624:     updated, and generally resolve problems.  Others contemplating
                   3625:     significant changes should ask the maintainer for advice or review
                   3626:     of a proposed change.  This is not necessary for micro updates,
                   3627:     bug fixes, pkgsrc-wide changes affecting many packages, and other
                   3628:     things expected to be uncontroversial.  It goes with this "should
                   3629:     ask" that the maintainer should respond to inquiries reasonably
                   3630:     promptly (most of the time), and either approve changes or provide
                   3631:     reasons why not.  Typically, when packaging a new program, set
                   3632:     <code class="varname">MAINTAINER</code> to yourself.  If you don't intend to
                   3633:     maintain the package (especially if you feel you have no special
                   3634:     insight), set it to <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.  This
                   3635:     special value is a code point indicating that there is no
                   3636:     maintainer, but the variable is mandatory, absent
                   3637:     <code class="varname">OWNER</code>.</p></li>
                   3638: <li class="listitem">
                   3639: <p><code class="varname">OWNER</code> can be used instead of
                   3640:     <code class="varname">MAINTAINER</code> in relatively rare circumstances
                   3641:     when the package is such that modifying it is riskier than normal.
                   3642:     This is a stronger form of being the maintainer, with an
                   3643:     expectation that others will ask for almost all changes, except
                   3644:     revbumps and accommodating structural changes.  Someone who becomes
                   3645:     <code class="varname">OWNER</code> has a strong obligation to keep the
                   3646:     package very well maintained, to answer queries promptly and to be
                   3647:     a steward of the package on behalf of users.  In this case,
                   3648:     <code class="varname">MAINTAINER</code> should be omitted.</p>
                   3649: <p>Because of the friction that <code class="varname">OWNER</code> adds,
                   3650:     PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
                   3651:     time.</p>
                   3652: </li>
1.299     rillig   3653: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3654:     find more information about the package.</p></li>
                   3655: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3656:     description of the package (should not include the package
                   3657:     name).</p></li>
                   3658: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3659:     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>
                   3660: </ul></div>
                   3661: <p>Other variables that affect the build:
                   3662:   </p>
                   3663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3664: <p><code class="varname">WRKSRC</code>: The directory where the
                   3665:       interesting distribution files of the package are found. The
                   3666:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3667:       works for most packages.</p>
                   3668: <p>If a package doesn't create a subdirectory for itself
                   3669:       (most GNU software does, for instance), but extracts itself in
                   3670:       the current directory, you should set
                   3671:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3672: <p>If a package doesn't create a subdirectory with the
                   3673:       name of <code class="varname">DISTNAME</code> but some different name,
                   3674:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3675:       <code class="filename">${WRKDIR}</code>, for example
                   3676:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322     leot     3677:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.299     rillig   3678: <p>The name of the working directory created by pkgsrc is
                   3679:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3680:       variable. By default, its value is
                   3681:       <code class="filename">work</code>. If you want to use the same
                   3682:       pkgsrc tree for building different kinds of binary packages,
                   3683:       you can change the variable according to your needs. Two
                   3684:       other variables handle common cases of setting
                   3685:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3686:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3687:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3688:       the host's name is attached to the directory name. If
                   3689:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3690:       is attached, which might look like
                   3691:       <code class="filename">work.i386</code> or
                   3692:       <code class="filename">work.sparc</code>.</p>
                   3693: </li></ul></div>
                   3694: <p>Please pay attention to the following gotchas:</p>
                   3695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3696: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3697:       installed in compressed form by the package.  For packages using
                   3698:       BSD-style makefiles which honor MANZ, there is
                   3699:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3700: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3701:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3702:       below).</p></li>
1.369     wiz      3703: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.299     rillig   3704: </ul></div>
                   3705: </div>
1.148     asau     3706: <div class="sect1">
1.91      rillig   3707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   3708: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3709: </h2></div></div></div>
                   3710: <p>The <code class="filename">distinfo</code> file contains the message
                   3711:   digest, or checksum, of each distfile needed for the package. This
                   3712:   ensures that the distfiles retrieved from the Internet have not been
                   3713:   corrupted during transfer or altered by a malign force to introduce
                   3714:   a security hole. To provide maximum security, all distfiles are
1.357     gutterid 3715:   protected using two different message digest algorithms (BLAKE2s
                   3716:   and SHA512), as well as the file size.</p>
1.299     rillig   3717: <p>The <code class="filename">distinfo</code> file also contains the
                   3718:   checksums for all the patches found in the
                   3719:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>). These checksums ensure that patches
                   3720:   are only applied intentionally and that they don't accidentally change,
                   3721:   e.g. when merging different changes together. They also make sure that
                   3722:   new patches are actually added to CVS and old ones are removed.
                   3723:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3724:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3725: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3726:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3727: <p>Some packages have different sets of distfiles depending on
1.322     leot     3728:   the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.299     rillig   3729:   <code class="filename">distinfo</code> file and care should be taken when
                   3730:   upgrading such a package to ensure distfile information is not
                   3731:   lost.</p>
                   3732: </div>
                   3733: <div class="sect1">
                   3734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3735: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3736: </h2></div></div></div>
                   3737: <p>Some packages don't work out-of-the box on the various
                   3738:   platforms that are supported by pkgsrc. These packages need
                   3739:   to be patched to make them work. The patch files can be
                   3740:   found in the <code class="filename">patches/</code> directory.</p>
                   3741: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3742:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3743:   extracting them, in alphabetic order.</p>
1.148     asau     3744: <div class="sect2">
1.91      rillig   3745: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3746: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3747: <p>The <code class="filename">patch-*</code> files should be in
                   3748:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3749:   problems. (To force patches to apply with fuzz you can set
                   3750:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3751:   should contain only changes for a single file, and no file should be
                   3752:   patched by more than one patch file. This helps to keep future
                   3753:   modifications simple.</p>
                   3754: <p>Each patch file is structured as follows: In the first line,
                   3755:   there is the RCS Id of the patch itself. The second line should be
                   3756:   empty for aesthetic reasons. After that, there should be a comment for
                   3757:   each change that the patch does. There are a number of standard
                   3758:   cases:</p>
                   3759: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3760: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3761:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3762: <li class="listitem"><p>Patches that change source code should mention the
                   3763:   platform and other environment (for example, the compiler) that the
                   3764:   patch is needed for.</p></li>
                   3765: </ul></div>
                   3766: <p>The patch should be commented so that any
                   3767:   developer who knows the code of the application can make some use of
                   3768:   the patch. Special care should be taken for the upstream developers,
                   3769:   since we generally want that they accept our patches, so we have less
                   3770:   work in the future.</p>
1.91      rillig   3771: </div>
1.148     asau     3772: <div class="sect2">
1.91      rillig   3773: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3774: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3775: <p>One important thing to mention is to pay attention that no RCS
                   3776:   IDs get stored in the patch files, as these will cause problems when
                   3777:   later checked into the NetBSD CVS tree. Use the
1.322     leot     3778:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.299     rillig   3779:   problems.</p>
                   3780: <p>For even more automation, we recommend using
                   3781:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337     gutterid 3782:   whole set of patches. You just have to back up files before you
                   3783:   edit them to <code class="filename">filename.orig</code>, e.g., with
1.299     rillig   3784:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3785:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3786:   you upgrade a package this way, you can easily compare the new
                   3787:   set of patches with the previously existing one with
                   3788:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3789:   are replaced by new files, so carefully check if you want to take all
                   3790:   the changes.</p>
                   3791: <p>When you have finished a package, remember to generate
                   3792:   the checksums for the patch files by using the <span class="command"><strong>make
                   3793:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="12.2. distinfo">Section 12.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
                   3794: <p>When adding a patch that corrects a problem in the
                   3795:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3796:   man pages should go), send the patch as a bug report to the
                   3797:   maintainer.  This benefits non-pkgsrc users of the package,
                   3798:   and usually makes it possible to remove the patch in future
                   3799:   version.</p>
                   3800: <p>The file names of the patch files are usually of the form
                   3801:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3802:   Many packages still use the previous convention
                   3803:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3804:   but new patches should be of the form containing the filename.
1.322     leot     3805:   <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.299     rillig   3806:   automatically.</p>
1.337     gutterid 3807: <p>When updating pre-existing patch files, if a file uses the old
                   3808:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
                   3809:   convention, it's best not to change it to the new form, as that will
                   3810:   just cause churn that makes it harder to track changes to patching
                   3811:   over time. Similarly, if a patch now applies at different line offsets,
                   3812:   but still applies cleanly as-is, there's no need to update it, as that
                   3813:   also unnecessarily complicates the patch history.</p>
1.118     imil     3814: </div>
1.275     brook    3815: <div class="sect2">
                   3816: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3817: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3818: <p>If you want to share patches between multiple packages
                   3819:   in pkgsrc, e.g. because they use the same distfiles, set
                   3820:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3821:   can be found, e.g.:</p>
                   3822: <pre class="programlisting">
                   3823: PATCHDIR=       ../../editors/xemacs/patches
                   3824: </pre>
                   3825: <p>Patch files that are distributed by the author or other
                   3826:     maintainers can be listed in
                   3827:     <code class="varname">PATCHFILES</code>.</p>
                   3828: <p>If it is desired to store any patches that should not be
                   3829:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3830:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3831:     directory tree there is expected to have the same
                   3832:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3833:     patches are expected to be stored inside these dirs (also
                   3834:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3835:     example, if you want to keep a private patch for
                   3836:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3837:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3838:     files in the named directory are expected to be patch files,
                   3839:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3840:     applied</em></span>.</p>
1.275     brook    3841: </div>
                   3842: <div class="sect2">
                   3843: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3844: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3845: <p>When fixing a portability issue in the code do not use
                   3846:       preprocessor magic to check for the current operating system nor
                   3847:       platform.  Doing so hurts portability to other platforms because
                   3848:       the OS-specific details are not abstracted appropriately.</p>
                   3849: <p>The general rule to follow is: instead of checking for the
                   3850:       operating system the application is being built on, check for the
                   3851:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3852:       instead of assuming that kqueue is available under NetBSD and
                   3853:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3854:       kqueue support, add a check that detects kqueue itself &mdash;
                   3855:       yes, this generally involves patching the
                   3856:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3857:       that prevents some OSes from adopting interfaces from other OSes
                   3858:       (e.g. Linux implementing kqueue), something that the above checks
                   3859:       cannot take into account.</p>
                   3860: <p>Of course, checking for features generally involves more
                   3861:       work on the developer's side, but the resulting changes are
                   3862:       cleaner and there are chances they will work on many other
                   3863:       platforms.  Not to mention that there are higher chances of being
                   3864:       later integrated into the mainstream sources.  Remember:
                   3865:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3866: <p>Some typical examples:</p>
                   3867: <div class="table">
                   3868: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3869: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3870: <colgroup>
                   3871: <col>
                   3872: <col>
                   3873: <col>
                   3874: </colgroup>
                   3875: <thead><tr>
                   3876: <th>Where</th>
                   3877: <th>Incorrect</th>
                   3878: <th>Correct</th>
                   3879: </tr></thead>
                   3880: <tbody>
                   3881: <tr>
                   3882: <td>configure script</td>
                   3883: <td>
1.275     brook    3884: <pre class="programlisting">
1.299     rillig   3885: case ${target_os} in
                   3886: netbsd*) have_kvm=yes ;;
                   3887: *)       have_kvm=no  ;;
                   3888: esac
1.275     brook    3889: </pre>
1.299     rillig   3890:              </td>
                   3891: <td>
1.275     brook    3892: <pre class="programlisting">
1.299     rillig   3893: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3894: </pre>
1.299     rillig   3895:              </td>
                   3896: </tr>
                   3897: <tr>
                   3898: <td>C source file</td>
                   3899: <td>
1.91      rillig   3900: <pre class="programlisting">
1.299     rillig   3901: #if defined(__NetBSD__)
                   3902: #  include &lt;sys/event.h&gt;
                   3903: #endif
1.91      rillig   3904: </pre>
1.299     rillig   3905:              </td>
                   3906: <td>
1.91      rillig   3907: <pre class="programlisting">
1.299     rillig   3908: #if defined(HAVE_SYS_EVENT_H)
                   3909: #  include &lt;sys/event.h&gt;
                   3910: #endif
1.91      rillig   3911: </pre>
1.299     rillig   3912:              </td>
                   3913: </tr>
                   3914: <tr>
                   3915: <td>C source file</td>
                   3916: <td>
1.91      rillig   3917: <pre class="programlisting">
1.299     rillig   3918: int
                   3919: monitor_file(...)
                   3920: {
                   3921: #if defined(__NetBSD__)
                   3922:         int fd = kqueue();
                   3923:         ...
                   3924: #else
                   3925:         ...
                   3926: #endif
                   3927: }
1.91      rillig   3928: </pre>
1.299     rillig   3929:              </td>
                   3930: <td>
1.91      rillig   3931: <pre class="programlisting">
1.299     rillig   3932: int
                   3933: monitor_file(...)
                   3934: {
                   3935: #if defined(HAVE_KQUEUE)
                   3936:         int fd = kqueue();
                   3937:         ...
                   3938: #else
                   3939:         ...
                   3940: #endif
                   3941: }
1.91      rillig   3942: </pre>
1.299     rillig   3943:              </td>
                   3944: </tr>
                   3945: </tbody>
                   3946: </table></div>
                   3947: </div>
                   3948: <br class="table-break">
                   3949: </div>
                   3950: <div class="sect2">
                   3951: <div class="titlepage"><div><div><h3 class="title">
                   3952: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3953: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3954:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3955:       improvements you do to a package to the mainstream developers.
                   3956:       This is the only way to get their attention on portability issues
                   3957:       and to ensure that future versions can be built out-of-the box on
                   3958:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3959:       the fixes straight from the packaged code.</p>
                   3960: <p>This generally involves cleaning up the patches
                   3961:       (because sometimes the patches that are
                   3962:       added to pkgsrc are quick hacks), filing bug reports in the
                   3963:       appropriate trackers for the projects and working with the
                   3964:       mainstream authors to accept your changes.  It is
                   3965:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3966:       the packages in pkgsrc are kept simple and thus further changes
                   3967:       can be done without much hassle.</p>
                   3968: <p>When you have done this, please add a URL to the upstream
                   3969:       bug report to the patch comment.</p>
                   3970: <p>Support the idea of free software!</p>
                   3971: </div>
1.91      rillig   3972: </div>
1.299     rillig   3973: <div class="sect1">
                   3974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3975: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3976: <div class="variablelist"><dl class="variablelist">
                   3977: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3978: <dd><p>A multi-line description of the piece of software.  This should include
                   3979:          any credits where they are due.  Please bear in mind that others do not
                   3980:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3981:          will read everything that you write here.</p></dd>
                   3982: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3983: <dd><p>This file governs the files that are installed on your
                   3984:          system: all the binaries, manual pages, etc. There are other
                   3985:          directives which may be entered in this file, to control the
                   3986:          creation and deletion of directories, and the location of
                   3987:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3988:          information.</p></dd>
                   3989: </dl></div>
                   3990: </div>
                   3991: <div class="sect1">
                   3992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3993: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3994: <div class="sect2">
                   3995: <div class="titlepage"><div><div><h3 class="title">
                   3996: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3997: <div class="variablelist"><dl class="variablelist">
                   3998: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3999: <dd>
1.378     leot     4000: <p>This shell script is invoked twice by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   4001:            First time after package extraction and before files are
                   4002:            moved in place, the second time after the files to install
                   4003:            are moved in place. This can be used to do any custom
                   4004:            procedures not possible with @exec commands in
1.378     leot     4005:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4006:            <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.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="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.299     rillig   4007:            Please note that you can modify variables in it easily by using
                   4008:            <code class="varname">FILES_SUBST</code> in the package's
                   4009:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4010: <pre class="programlisting">
1.299     rillig   4011: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4012: </pre>
1.299     rillig   4013: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4014:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4015:            performed for <code class="varname">PREFIX</code>,
                   4016:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4017:            <code class="varname">VARBASE</code>, and a few others, type
                   4018:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4019:            complete list.</p>
                   4020: </dd>
                   4021: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4022: <dd><p>This script is executed before and after any files are removed.  It is
                   4023:            this script's responsibility to clean up any additional messy details
                   4024:            around the package's installation, since all pkg_delete knows is how to
                   4025:            delete the files created in the original distribution.
1.378     leot     4026:            See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4027:            and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   4028:            The same methods to replace variables can be used as for
                   4029:            the <code class="filename">INSTALL</code> file.</p></dd>
                   4030: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4031: <dd>
                   4032: <p>This file is displayed after installation of the package.
1.312     gdt      4033:            While this was used often in the past, it has two
                   4034:            problems: the display will be missed if many packages are
1.375     jkoshy   4035:            installed at once, and the person installing the package
1.312     gdt      4036:            and the one using or configuring it may be different.  It
                   4037:            should therefore be used only in exceptional circumstances
                   4038:            where lasting negative consequences would result from
                   4039:            someone not reading it.</p>
                   4040: <p>MESSAGE should not be used for:</p>
                   4041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4042: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   4043: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   4044: <li class="listitem"><p>anything that should be explained in the
                   4045:              installation/configuration documentation that should
                   4046:              come with the package</p></li>
                   4047: </ul></div>
                   4048: <p>If the documentation provided by upstream needs
1.313     leot     4049:            enhancing, create e.g. files/README.pkgsrc and install it
                   4050:            in the package's documentation directory.
1.312     gdt      4051:            </p>
                   4052: <p>Note that MESSAGE is shown for all operating
                   4053:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     4054:            it should be narrowed to only those operating systems and
1.312     gdt      4055:            init systems to which it applies.</p>
                   4056: <p>Note that you can modify variables in it easily by using
1.299     rillig   4057:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4058:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4059: <pre class="programlisting">
1.299     rillig   4060: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4061: </pre>
1.299     rillig   4062: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   4063:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4064:            performed for <code class="varname">PKGNAME</code>,
                   4065:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4066:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4067:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4068:            <code class="varname">ROOT_GROUP</code>, and
                   4069:            <code class="varname">ROOT_USER</code>.</p>
                   4070: <p>You can display a different or additional files by
                   4071:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4072:            default is <code class="filename">MESSAGE</code>, if the file
                   4073:            exists.</p>
                   4074: </dd>
                   4075: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4076: <dd>
                   4077: <p>This file is used by the alternatives framework.
                   4078:            It creates, configures, and destroys generic wrappers used to
                   4079:            run programs with similar interfaces.
                   4080:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4081:             for more information.</p>
                   4082: <p>Each line of the file contains two filenames, first
                   4083:            the wrapper and then the alternative provided by the package.
                   4084:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4085: </dd>
                   4086: </dl></div>
                   4087: </div>
                   4088: <div class="sect2">
                   4089: <div class="titlepage"><div><div><h3 class="title">
                   4090: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   4091: <div class="variablelist"><dl class="variablelist">
                   4092: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4093: <dd><p>This file contains arbitrary things that could
                   4094:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4095:        to be used by more than one package. This file should only be
                   4096:        used when the packages that will use the file are known in
                   4097:        advance. For other purposes it is often better to write a
                   4098:        <code class="filename">*.mk</code> file and give it a good name that
                   4099:        describes what it does.</p></dd>
                   4100: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4101: <dd><p>This file contains the dependency information
                   4102:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   4103: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4104: <dd><p>This file contains workarounds for compiler bugs
                   4105:        and similar things. It is included automatically by the pkgsrc
                   4106:        infrastructure, so you don't need an extra
                   4107:        <code class="literal">.include</code> line for
                   4108:        it.</p></dd>
                   4109: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4110: <dd><p>This file contains the code for the
                   4111:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   4112:        selected by the user. If a package has only one or two options,
                   4113:        it is equally acceptable to put the code directly into the
                   4114:        <code class="filename">Makefile</code>.</p></dd>
                   4115: </dl></div>
                   4116: </div>
                   4117: <div class="sect2">
                   4118: <div class="titlepage"><div><div><h3 class="title">
                   4119: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   4120: <div class="variablelist"><dl class="variablelist">
                   4121: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4122: <dd><p>These files do not take place in the creation of
                   4123:        a package and thus are purely informative to the package
                   4124:        developer.</p></dd>
                   4125: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4126: <dd><p>This file contains things that need to be done
                   4127:        to make the package even
                   4128:        better.</p></dd>
                   4129: </dl></div>
                   4130: </div>
                   4131: </div>
                   4132: <div class="sect1">
                   4133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4134: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   4135: </h2></div></div></div>
                   4136: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4137:     unpacked into the directory denoted by
                   4138:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4139:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4140:     directory is also used to keep various timestamp files.
                   4141:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4142:     The default is <code class="filename">${.CURDIR}/work</code>
                   4143:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4144:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   4145: </div>
1.299     rillig   4146: <div class="sect1">
                   4147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4148: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   4149: </h2></div></div></div>
                   4150: <p>If you have any files that you wish to be placed in the package
                   4151:     prior to configuration or building, you can place these files here
                   4152:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4153:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   4154: <p>If you want to share files in this way with other
                   4155:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4156:     to the other package's <code class="filename">files</code> directory,
                   4157:     e.g.:</p>
1.91      rillig   4158: <pre class="programlisting">
1.299     rillig   4159: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4160: </pre>
                   4161: </div>
                   4162: </div>
1.148     asau     4163: <div class="chapter">
1.75      rillig   4164: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   4165: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4166: <div class="toc">
                   4167: <p><b>Table of Contents</b></p>
1.210     leot     4168: <dl class="toc">
1.299     rillig   4169: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4170: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4171: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4172: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4173: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4174: <dd><dl>
                   4175: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4176: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4177: </dl></dd>
                   4178: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4179: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4180: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4181: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4182: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4183: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4184: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4185: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4186: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4187: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4188: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4189: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4190: </dl>
                   4191: </div>
1.148     asau     4192: <div class="sect1">
1.75      rillig   4193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4194: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4195: <p>This chapter gives a detailed description on how a package is
                   4196:     built. Building a package is separated into different
                   4197:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4198:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4199:     described in the following sections. Each phase is split into
                   4200:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4201:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4202:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4203:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4204:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4205: <p>Never override the regular targets (like
                   4206:     <code class="varname">fetch</code>), if you have to, override the
                   4207:     <code class="varname">do-*</code> ones instead.</p>
                   4208: <p>The basic steps for building a program are always the same.  First
                   4209:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4210:     the local system and then extracted. After any pkgsrc-specific patches
                   4211:     to compile properly are applied, the software can be configured, then
                   4212:     built (usually by compiling), and finally the generated binaries, etc.
                   4213:     can be put into place on the system.</p>
                   4214: <p>To get more details about what is happening at each step,
                   4215:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4216:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4217:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4218: </div>
                   4219: <div class="sect1">
                   4220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4221: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4222: <p>Before outlining the process performed by the NetBSD package system in
                   4223:     the next section, here's a brief discussion on where programs are
                   4224:     installed, and which variables influence this.</p>
                   4225: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4226:     where all files of the final program shall be installed. It is
                   4227:     usually set to <code class="varname">LOCALBASE</code>
                   4228:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4229:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4230:     <code class="varname">PREFIX</code> needs to be put
                   4231:     into the various places in the program's source where paths to
                   4232:     these files are encoded.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.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>
                   4233: <p>When choosing which of these variables to use,
                   4234:     follow the following rules:</p>
1.148     asau     4235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4236: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4237:        where the current pkg will be installed.  When referring to a
                   4238:        pkg's own installation path, use
                   4239:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
1.338     nia      4240: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299     rillig   4241:        are installed.  If you need to construct a -I or -L argument
                   4242:        to the compiler to find includes and libraries installed by
1.338     nia      4243:        another pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.299     rillig   4244:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4245:        installed all packages in <code class="filename">/usr/local</code>. As
                   4246:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4247:        administrator, this variable is a misnomer.</p></li>
                   4248: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4249:        distribution (from xsrc, etc.) is installed. When looking for
                   4250:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4251:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4252: <li class="listitem"><p>X11-based packages using imake must set
                   4253:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4254:        <code class="varname">LOCALBASE</code>.</p></li>
                   4255: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.378     leot     4256:        install files according to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4257:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4258:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4259: </ul></div>
                   4260: </div>
                   4261: <div class="sect1">
                   4262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4263: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4264: <p>When building a package, various directories are used to store
                   4265:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4266:     directories are explained here.</p>
                   4267: <p>Some of the directory variables contain relative pathnames. There
                   4268:     are two common base directories for these relative directories:
                   4269:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4270:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4271:     inside the package itself.</p>
                   4272: <div class="variablelist"><dl class="variablelist">
                   4273: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4274: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4275:       root directory. Generally, you don't need
                   4276:       it.</p></dd>
                   4277: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4278: <dd><p>This is an absolute pathname that points to the
                   4279:       current package.</p></dd>
                   4280: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343     gutterid 4281: <dd>
                   4282: <p>This is a pathname relative to
                   4283:       <code class="varname">PKGSRCDIR</code> that points to the current package.
                   4284:       It is defined after including <code class="filename">bsd.prefs.mk</code>
                   4285:       and can be used in makefile fragments that are used by several
                   4286:       packages to distinguish between these packages. Other variables
                   4287:       that would serve the same purpose are <code class="varname">PKGBASE</code>
                   4288:       and <code class="varname">PKGNAME</code>, but these are only defined after
                   4289:       including <code class="filename">bsd.pkg.mk</code>, which is too
                   4290:       late.</p>
                   4291: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
                   4292:       <code class="varname">PKGPATH</code> to tweak variables like
                   4293:       <code class="varname">MAKE_JOBS</code> and
                   4294:       <code class="varname">CFLAGS</code>.</p>
                   4295: </dd>
1.299     rillig   4296: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4297: <dd><p>This is an absolute pathname pointing to the directory
                   4298:       where all work takes place. The distfiles are extracted to this
                   4299:       directory. It also contains temporary directories and log files used by
                   4300:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4301:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4302: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4303: <dd><p>This is an absolute pathname pointing to the directory
                   4304:       where the distfiles are extracted. It is usually a direct subdirectory
                   4305:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4306:       that isn't hidden. This variable may be changed by a package
                   4307:       <code class="filename">Makefile</code>.</p></dd>
                   4308: </dl></div>
                   4309: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4310:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4311:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4312:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4313:     If users would like to have their pkgsrc trees behave in a
                   4314:     read-only manner, then the value of
                   4315:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4316:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4317: </div>
1.148     asau     4318: <div class="sect1">
1.75      rillig   4319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4320: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4321: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343     gutterid 4322:     <em class="replaceable"><code>phase</code></em></strong></span>, where
                   4323:     <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
                   4324:     automatically run all phases that are required for this phase. The
                   4325:     default phase is <code class="varname">build</code>, that is, when you run
                   4326:     <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299     rillig   4327:     the package will be built, but not installed.</p>
1.75      rillig   4328: </div>
1.148     asau     4329: <div class="sect1">
1.75      rillig   4330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4331: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4332: <p>The first step in building a package is to fetch the
                   4333:     distribution files (distfiles) from the sites that are providing
                   4334:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4335:     phase.</p>
1.148     asau     4336: <div class="sect2">
1.93      rillig   4337: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4338: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4339: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4340:       defines all URLs from where the distfile, whose name is
                   4341:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4342:       fetched. The more complicated cases are described
                   4343:       below.</p>
                   4344: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4345:       the list of distfiles that have to be fetched. Its value
                   4346:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4347:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4348:       so that most packages don't need to define it at all.
                   4349:       <code class="varname">EXTRACT_SUFX</code> is
                   4350:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4351:       freely. Note that if your package requires additional
                   4352:       distfiles to the default one, you cannot just append the
                   4353:       additional filenames using the <code class="literal">+=</code>
                   4354:       operator, but you have write for example:</p>
                   4355: <pre class="programlisting">
                   4356: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4357: </pre>
                   4358: <p>Each distfile is fetched from a list of sites, usually
                   4359:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4360:       <code class="varname">DISTFILES</code> or multiple
                   4361:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4362:       set
                   4363:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4364:       to the list of URLs where the file
                   4365:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4366:       (including the suffix) can be found.</p>
                   4367: <pre class="programlisting">
                   4368: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4369: DISTFILES+=     foo-file.tar.gz
                   4370: SITES.foo-file.tar.gz= \
                   4371: https://www.somewhere.com/somehow/ \
                   4372: https://www.somewhereelse.com/mirror/somehow/
                   4373: </pre>
                   4374: <p>When actually fetching the distfiles, each item from
                   4375:       <code class="varname">MASTER_SITES</code> or
                   4376:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4377:       appended to it, without an intermediate slash. Therefore,
                   4378:       all site values have to end with a slash or other separator
                   4379:       character. This allows for example to set
                   4380:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4381:       that gets the name of the distfile as a parameter. In this
                   4382:       case, the definition would look like:</p>
                   4383: <pre class="programlisting">
                   4384: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4385: </pre>
                   4386: <p> The exception to this rule are URLs starting with a dash.
                   4387:       In that case the URL is taken as is, fetched and the result
                   4388:       stored under the name of the distfile. You can use this style
                   4389:       for the case when the download URL style does not match the
                   4390:       above common case. For example, if permanent download URL is a
                   4391:       redirector to the real download URL, or the download file name
                   4392:       is offered by an HTTP Content-Disposition header. In the
                   4393:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4394:       created instead of the default
                   4395:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4396: <pre class="programlisting">
                   4397: DISTNAME=       foo-1.0.0
                   4398: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4399: </pre>
                   4400: <p>There are some predefined values for
                   4401:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4402:       packages.  The names of the variables should speak for
                   4403:       themselves.</p>
                   4404: <table border="0" summary="Simple list" class="simplelist">
                   4405: <tr>
                   4406: <td>MASTER_SITE_APACHE</td>
                   4407: <td>MASTER_SITE_BACKUP</td>
                   4408: </tr>
                   4409: <tr>
                   4410: <td>MASTER_SITE_CRATESIO</td>
                   4411: <td>MASTER_SITE_CYGWIN</td>
                   4412: </tr>
                   4413: <tr>
                   4414: <td>MASTER_SITE_DEBIAN</td>
                   4415: <td>MASTER_SITE_FREEBSD</td>
                   4416: </tr>
                   4417: <tr>
                   4418: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4419: <td>MASTER_SITE_GENTOO</td>
                   4420: </tr>
                   4421: <tr>
                   4422: <td>MASTER_SITE_GITHUB</td>
1.340     gutterid 4423: <td>MASTER_SITE_GITLAB</td>
                   4424: </tr>
                   4425: <tr>
1.299     rillig   4426: <td>MASTER_SITE_GNOME</td>
1.340     gutterid 4427: <td>MASTER_SITE_GNU</td>
1.299     rillig   4428: </tr>
                   4429: <tr>
1.379     wiz      4430: <td>MASTER_SITE_GNUPG</td>
1.299     rillig   4431: <td>MASTER_SITE_GNUSTEP</td>
                   4432: </tr>
                   4433: <tr>
1.379     wiz      4434: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299     rillig   4435: <td>MASTER_SITE_IFARCHIVE</td>
                   4436: </tr>
                   4437: <tr>
1.379     wiz      4438: <td>MASTER_SITE_KDE</td>
1.299     rillig   4439: <td>MASTER_SITE_MOZILLA</td>
                   4440: </tr>
                   4441: <tr>
1.379     wiz      4442: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299     rillig   4443: <td>MASTER_SITE_MYSQL</td>
                   4444: </tr>
                   4445: <tr>
1.379     wiz      4446: <td>MASTER_SITE_NETLIB</td>
1.299     rillig   4447: <td>MASTER_SITE_OPENBSD</td>
                   4448: </tr>
                   4449: <tr>
1.379     wiz      4450: <td>MASTER_SITE_OPENOFFICE</td>
1.299     rillig   4451: <td>MASTER_SITE_OSDN</td>
                   4452: </tr>
                   4453: <tr>
1.379     wiz      4454: <td>MASTER_SITE_PERL_CPAN</td>
1.299     rillig   4455: <td>MASTER_SITE_PGSQL</td>
                   4456: </tr>
                   4457: <tr>
1.379     wiz      4458: <td>MASTER_SITE_PYPI</td>
1.299     rillig   4459: <td>MASTER_SITE_RUBYGEMS</td>
                   4460: </tr>
                   4461: <tr>
1.379     wiz      4462: <td>MASTER_SITE_R_CRAN</td>
1.299     rillig   4463: <td>MASTER_SITE_SOURCEFORGE</td>
                   4464: </tr>
1.85      jmmv     4465: <tr>
1.379     wiz      4466: <td>MASTER_SITE_SUNSITE</td>
1.299     rillig   4467: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4468: </tr>
                   4469: <tr>
1.379     wiz      4470: <td>MASTER_SITE_TEX_CTAN</td>
1.299     rillig   4471: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4472: </tr>
                   4473: <tr>
1.379     wiz      4474: <td>MASTER_SITE_XEMACS</td>
1.299     rillig   4475: <td>MASTER_SITE_XORG</td>
                   4476: </tr>
                   4477: </table>
                   4478: <p>Some explanations for the less self-explaining ones:
                   4479:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.369     wiz      4480:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.299     rillig   4481:       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>
                   4482: <p>If you choose one of these predefined sites, you may
                   4483:       want to specify a subdirectory of that site. Since these
                   4484:       macros may expand to more than one actual site, you
                   4485:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4486:       specify a subdirectory:</p>
1.100     rillig   4487: <pre class="programlisting">
1.299     rillig   4488: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4489: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4490: </pre>
1.299     rillig   4491: <p>Note the trailing slash after the subdirectory
                   4492:       name.</p>
                   4493: </div>
                   4494: <div class="sect2">
                   4495: <div class="titlepage"><div><div><h3 class="title">
                   4496: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4497: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4498:       all the distfiles exist in a local directory
                   4499:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4500:       user). If the files do not exist, they are fetched using
                   4501:       commands of the form</p>
1.100     rillig   4502: <pre class="programlisting">
1.299     rillig   4503: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4504: </pre>
                   4505: <p>where <code class="literal">${site}</code> varies through
                   4506:       several possibilities in turn: first,
                   4507:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4508:       sites specified in either <code class="varname">SITES.file</code> if
                   4509:       defined, else <code class="varname">MASTER_SITES</code> or
                   4510:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4511:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4512:       all except the first and the last can be optionally sorted
                   4513:       by the user, via setting either
                   4514:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4515:       <code class="varname">MASTER_SORT_AWK</code> or
                   4516:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4517: <p> The specific command and arguments used depend on the
                   4518:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4519:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4520: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4521:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4522:       distfiles, if they are freely distributable.  Packages setting
                   4523:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4524:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4525:       mirrored.</p>
1.85      jmmv     4526: </div>
                   4527: </div>
1.299     rillig   4528: <div class="sect1">
                   4529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4530: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4531: <p>After the distfile(s) are fetched, their checksum is
                   4532:     generated and compared with the checksums stored in the
                   4533:     distinfo file. If the checksums don't match, the build is
                   4534:     aborted. This is to ensure the same distfile is used for
                   4535:     building, and that the distfile wasn't changed, e.g. by some
                   4536:     malign force, deliberately changed distfiles on the master
                   4537:     distribution site or network lossage.</p>
1.75      rillig   4538: </div>
1.148     asau     4539: <div class="sect1">
1.75      rillig   4540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4541: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4542: <p>When the distfiles are present on the local system, they
                   4543:     need to be extracted, as they usually come in the form of some
                   4544:     compressed archive format.</p>
                   4545: <p>By default, all <code class="varname">DISTFILES</code> are
                   4546:     extracted. If you only need some of them, you can set the
                   4547:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4548:     files.</p>
                   4549: <p>Extracting the files is usually done by a little
                   4550:     program, <code class="filename">mk/extract/extract</code>, which
                   4551:     already knows how to extract various archive formats, so most
                   4552:     likely you will not need to change anything here. But if you
                   4553:     need, the following variables may help you:</p>
1.148     asau     4554: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4555: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4556: <dd><p>Use these variables to override the default
                   4557:       options for an extract command, which are defined in
                   4558:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4559: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4560: <dd><p>This variable can be set to
                   4561:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4562:       (which is the default value), <code class="literal">pax</code>, or an
                   4563:       absolute pathname pointing to the command with which tar
                   4564:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4565:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4566: </dl></div>
1.299     rillig   4567: <p>If the <code class="filename">extract</code> program doesn't
                   4568:     serve your needs, you can also override the
                   4569:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4570:     command used for extracting the files. This command is
                   4571:     executed in the <code class="filename">${WRKSRC}</code>
                   4572:     directory. During execution of this command, the shell
                   4573:     variable <code class="varname">extract_file</code> holds the absolute
                   4574:     pathname of the file that is going to be extracted.</p>
                   4575: <p>And if that still does not suffice, you can override the
                   4576:     <code class="varname">do-extract</code> target in the package
                   4577:     Makefile.</p>
1.75      rillig   4578: </div>
1.148     asau     4579: <div class="sect1">
1.75      rillig   4580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4581: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4582: <p>After extraction, all the patches named by the
                   4583:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4584:     subdirectory of the package as well as in
                   4585:     $LOCALPATCHES/$PKGPATH (e.g.
                   4586:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4587:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4588:     <code class="filename">.gz</code> are uncompressed before they are
                   4589:     applied, files ending in <code class="filename">.orig</code> or
                   4590:     <code class="filename">.rej</code> are ignored. Any special options to
1.378     leot     4591:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299     rillig   4592:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.378     leot     4593: <p>By default <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4594:     fail if the expected text from the patch context is not found in the
                   4595:     patched file. If that happens, fix the patch file by comparing it
                   4596:     with the actual text in the file to be patched.</p>
1.78      rillig   4597: </div>
1.148     asau     4598: <div class="sect1">
1.75      rillig   4599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4600: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4601: <p>This is covered in <a class="xref" href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
                   4602:     </p>
1.75      rillig   4603: </div>
1.148     asau     4604: <div class="sect1">
1.75      rillig   4605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4606: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4607: <p>This phase creates wrapper programs for the compilers and
                   4608:     linkers. The following variables can be used to tweak the
                   4609:     wrappers.</p>
                   4610: <div class="variablelist"><dl class="variablelist">
                   4611: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4612: <dd><p>The command used to print progress
                   4613:       messages. Does nothing by default. Set to
                   4614:       <code class="literal">${ECHO}</code> to see the progress
                   4615:       messages.</p></dd>
                   4616: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4617: <dd><p>This variable can be set to
                   4618:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4619:       depending on whether you want additional information in the
                   4620:       wrapper log file.</p></dd>
                   4621: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4622: <dd><p>This variable can be set to
                   4623:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4624:       on whether the wrapper should use its cache, which will
                   4625:       improve the speed. The default value is
                   4626:       <code class="literal">yes</code>, but is forced to
                   4627:       <code class="literal">no</code> if the platform does not support
                   4628:       it.</p></dd>
                   4629: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4630: <dd><p>A list of reordering commands. A reordering
                   4631:       command has the form
                   4632:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4633:       It ensures that that
                   4634:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4635:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4636:       </p></dd>
                   4637: </dl></div>
                   4638: </div>
                   4639: <div class="sect1">
                   4640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4641: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4642: <p>Most pieces of software need information on the header
                   4643:     files, system calls, and library routines which are available
                   4644:     on the platform they run on. The process of determining this
                   4645:     information is known as configuration, and is usually
                   4646:     automated. In most cases, a script is supplied with the
                   4647:     distfiles, and its invocation results in generation of header
                   4648:     files, Makefiles, etc.</p>
                   4649: <p>If the package contains a configure script, this can be
                   4650:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4651:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4652:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301     rillig   4653:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4654: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4655:     equivalent of the following command is run. See
                   4656:     <code class="filename">mk/configure/configure.mk</code>, target
                   4657:     <code class="literal">do-configure-script</code> for the exact
                   4658:     definition.</p>
                   4659: <pre class="programlisting">
                   4660: .for dir in ${CONFIGURE_DIRS}
                   4661:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4662:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4663:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4664: .endfor
1.100     rillig   4665: </pre>
1.299     rillig   4666: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4667:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4668:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4669:     configure script is run with the environment
                   4670:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4671:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4672:     <code class="varname">CONFIGURE_ENV</code>,
                   4673:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4674:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4675:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4676:     package.</p>
                   4677: <p>If the program uses the Perl way of configuration (mainly Perl
                   4678:     modules, but not only), i.e. a file called
                   4679:     <code class="filename">Makefile.PL</code>, it should include
                   4680:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4681:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4682:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4683: <p>If the program uses an <code class="filename">Imakefile</code>
                   4684:     for configuration, the appropriate steps can be invoked by
                   4685:     setting <code class="varname">USE_IMAKE</code> to
                   4686:     <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>.
                   4687:     You can add variables to xmkmf's environment by adding them to the
                   4688:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4689: <p>If the program uses <code class="filename">cmake</code>
                   4690:     for configuration, the appropriate steps can be invoked by
1.348     wiz      4691:     including <code class="filename">../../devel/cmake/build.mk</code>.
1.299     rillig   4692:     You can add variables to cmake's environment by adding them to the
                   4693:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.373     wiz      4694:     by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.348     wiz      4695:     If you want to add arguments only for particular stages, you can use the
                   4696:     <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
                   4697:     <code class="varname">CMAKE_BUILD_ARGS</code>, and
                   4698:     <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
                   4699:     You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
                   4700:     directories in which CMake should be run, relative to
                   4701:     <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>.
                   4702:     </p>
1.374     wiz      4703: <p>Any package using the now-deprecated
                   4704:     <code class="varname">USE_CMAKE=yes</code> should be converted.
                   4705:     Essentially, replace with an include of
                   4706:     <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
                   4707:     directory and settings to use it, and check/fix settings that
                   4708:     intend to perform the build in a subdirectory.
                   4709:     </p>
1.299     rillig   4710: <p>If there is no configure step at all, set
                   4711:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4712: </div>
1.148     asau     4713: <div class="sect1">
1.75      rillig   4714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4715: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4716: <p>For building a package, a rough equivalent of the following
                   4717:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4718:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4719: <pre class="programlisting">
1.301     rillig   4720: .for dir in ${BUILD_DIRS}
                   4721:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4722:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4723:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4724:                 -f ${MAKE_FILE} \
                   4725:                 ${BUILD_TARGET}
                   4726: .endfor
1.97      rillig   4727: </pre>
1.299     rillig   4728: <p><code class="varname">BUILD_DIRS</code> (default:
                   4729:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4730:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4731:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4732:     <code class="varname">MAKE_ENV</code> and arguments
                   4733:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4734:     <code class="varname">MAKE_ENV</code>,
                   4735:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4736:     <code class="varname">MAKE_FILE</code> and
                   4737:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4738:     package.</p>
                   4739: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4740:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4741:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4742:     default value of <code class="varname">MAKE_FILE</code> is
                   4743:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4744:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4745: <p>If there is no build step at all, set
                   4746:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4747: </div>
1.148     asau     4748: <div class="sect1">
1.97      rillig   4749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4750: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4751: <p>[TODO]</p>
1.75      rillig   4752: </div>
1.148     asau     4753: <div class="sect1">
1.75      rillig   4754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4755: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4756: <p>Once the build stage has completed, the final step is to
                   4757:     install the software in public directories, so users can
                   4758:     access the programs and files.</p>
1.301     rillig   4759: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4760:     of the following code is executed; see
                   4761:     <code class="filename">mk/install/install.mk</code>, target
                   4762:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4763:     before and after this code, several consistency checks are run
                   4764:     against the files-to-be-installed, see
                   4765:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4766: <pre class="programlisting">
                   4767: .for dir in ${INSTALL_DIRS}
                   4768:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4769:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4770:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4771:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4772: .endfor
1.220     wiz      4773: </pre>
1.299     rillig   4774: <p>The variable's meanings are analogous to the ones in the
                   4775:     <span class="emphasis"><em>build</em></span> phase.
                   4776:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4777:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4778:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4779:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4780:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4781:     defined.</p>
                   4782: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4783:     variables are useful. They are all variations of the
1.378     leot     4784:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4785:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4786:     install command. The specialized variants, together with their
                   4787:     intended use, are:</p>
                   4788: <div class="variablelist"><dl class="variablelist">
                   4789: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4790: <dd><p>directories that contain
                   4791:       binaries</p></dd>
                   4792: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4793: <dd><p>directories that contain
                   4794:       scripts</p></dd>
                   4795: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4796: <dd><p>directories that contain shared and static
                   4797:       libraries</p></dd>
                   4798: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4799: <dd><p>directories that contain data
                   4800:       files</p></dd>
                   4801: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4802: <dd><p>directories that contain man
                   4803:       pages</p></dd>
                   4804: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4805: <dd><p>directories that contain data files for games
                   4806:       </p></dd>
                   4807: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4808: <dd><p>binaries that can be stripped from debugging
                   4809:       symbols</p></dd>
                   4810: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4811: <dd><p>binaries that cannot be
                   4812:       stripped</p></dd>
                   4813: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4814: <dd><p>game
                   4815:       binaries</p></dd>
                   4816: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4817: <dd><p>shared and static
                   4818:       libraries</p></dd>
                   4819: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4820: <dd><p>data files</p></dd>
                   4821: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4822: <dd><p>data files for
                   4823:       games</p></dd>
                   4824: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4825: <dd><p>man pages</p></dd>
                   4826: </dl></div>
                   4827: <p>Some other variables are:</p>
                   4828: <div class="variablelist"><dl class="variablelist">
                   4829: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.378     leot     4830: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4831:       when installing binaries. Any debugging sections and symbols present in
                   4832:       binaries will be preserved.
                   4833:       </p></dd>
                   4834: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4835: <dd><p>A list of directories relative to
                   4836:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4837:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4838:       The package is supposed to create all needed directories itself
                   4839:       before installing files to it and list all other directories here.
                   4840:       </p></dd>
                   4841: </dl></div>
                   4842: <p>In the rare cases that a package shouldn't install anything,
                   4843:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4844:     mostly relevant for packages in the <code class="filename">regress</code>
                   4845:     category.</p>
1.75      rillig   4846: </div>
1.148     asau     4847: <div class="sect1">
1.75      rillig   4848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4849: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4850: <p>Once the install stage has completed, a binary package of
                   4851:     the installed files can be built.  These binary packages can be
                   4852:     used for quick installation without previous compilation, e.g. by
                   4853:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4854:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4855: <p>By default, the binary packages are created in
                   4856:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4857:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4858:     one for each category in the <code class="varname">CATEGORIES</code>
                   4859:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4860:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4861: </div>
1.148     asau     4862: <div class="sect1">
1.75      rillig   4863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4864: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4865: <p>Once you're finished with a package, you can clean the work
                   4866:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4867:     to clean the work directories of all dependencies too, use
                   4868:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4869: </div>
1.148     asau     4870: <div class="sect1">
1.75      rillig   4871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4872: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4873: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4874: <dt><span class="term">pre/post-*</span></dt>
                   4875: <dd>
                   4876: <p>For any of the main targets described in the previous
                   4877:          section (configure, build, install, etc.), two auxiliary
                   4878:          targets exist with
                   4879:          <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
                   4880:          prefix for the main target's name.  These targets are
                   4881:          invoked before and after the main target is called,
                   4882:          allowing extra configuration or installation steps be
                   4883:          performed from a package's Makefile, for example, which
                   4884:          a program's configure script or install target
                   4885:          omitted.</p>
                   4886: <p>About 5% of the pkgsrc packages define their custom
                   4887:          post-extract target, another 5% define pre-configure, and 10%
                   4888:          define post-install. The other pre/post-* targets are defined
                   4889:          even less often.</p>
                   4890: </dd>
                   4891: <dt><span class="term">do-*</span></dt>
1.75      rillig   4892: <dd>
1.299     rillig   4893: <p>Should one of the main targets do the wrong thing,
                   4894:          and should there be no variable to fix this, you can
                   4895:          redefine it with the do-* target.  (Note that redefining
                   4896:          the target itself instead of the do-* target is a bad
                   4897:          idea, as the pre-* and post-* targets won't be called
                   4898:          anymore, etc.)</p>
                   4899: <p>About 15% of the pkgsrc packages override the default
                   4900:          do-install, the other do-* targets are overridden even less
                   4901:          often.</p>
1.75      rillig   4902: </dd>
1.299     rillig   4903: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4904: <dd>
1.299     rillig   4905: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4906:          you noticed some file was not installed properly, you
                   4907:          can repeat the installation with this target, which will
                   4908:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4909: <p>This is the default value of
                   4910:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4911:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4912:          package</strong></span>, where the defaults are
                   4913:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4914:          respectively.</p>
1.75      rillig   4915: </dd>
1.299     rillig   4916: <dt><span class="term">deinstall</span></dt>
                   4917: <dd>
1.378     leot     4918: <p>This target does a <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4919:          current directory, effectively de-installing the
                   4920:          package. The following variables can be used to tune the
                   4921:          behaviour:</p>
                   4922: <div class="variablelist"><dl class="variablelist">
                   4923: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.378     leot     4924: <dd><p>Add a "-v" to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4925: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4926: <dd><p>Remove all packages that require (depend on)
                   4927:                the given package.  This can be used to remove any
                   4928:                packages that may have been pulled in by a given
                   4929:                package, e.g. if <span class="command"><strong>make deinstall
                   4930:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4931:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4932:                likely to remove whole KDE. Works by adding
1.378     leot     4933:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   4934:                command line.</p></dd>
                   4935: </dl></div>
                   4936: </dd>
                   4937: <dt><span class="term">bin-install</span></dt>
                   4938: <dd><p>Install a binary package from local disk and via FTP
                   4939:          from a list of sites (see the
                   4940:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4941:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4942:          available anywhere.  The arguments given to
                   4943:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4944:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4945:          operation, etc.</p></dd>
                   4946: <dt><span class="term">install-clean</span></dt>
                   4947: <dd><p>This target removes the state files for the "install" and later
                   4948:          phases so that the "install" target may be re-invoked. This can be
                   4949:          used after editing the PLIST to install the package without
                   4950:          rebuilding it.</p></dd>
                   4951: <dt><span class="term">build-clean</span></dt>
                   4952: <dd><p>This target removes the state files for the "build" and later
                   4953:          phases so that the "build" target may be re-invoked.</p></dd>
                   4954: <dt><span class="term">update</span></dt>
                   4955: <dd>
                   4956: <p>This target causes the current package to be
                   4957:          updated to the latest version.  The package and all
                   4958:          depending packages first get de-installed, then current
                   4959:          versions of the corresponding packages get compiled and
                   4960:          installed.  This is similar to manually noting which
                   4961:          packages are currently installed, then performing a
                   4962:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4963:          <span class="command"><strong>make install</strong></span> (or whatever
                   4964:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4965:          packages.</p>
                   4966: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4967:          resume package updating in case a previous <span class="command"><strong>make
                   4968:          update</strong></span> was interrupted for some reason.
                   4969:          However, in this case, make sure you don't call
                   4970:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4971:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4972:          Otherwise, you lose the ability to automatically update
                   4973:          the current package along with the dependent packages
                   4974:          you have installed.</p>
                   4975: <p>Resuming an interrupted <span class="command"><strong>make
                   4976:          update</strong></span> will only work as long as the package
                   4977:          tree remains unchanged.  If the source code for one of
                   4978:          the packages to be updated has been changed, resuming
                   4979:          <span class="command"><strong>make update</strong></span> will most certainly
                   4980:          fail!</p>
                   4981: <p>The following variables can be used either on the
                   4982:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4983:          alter the behaviour of <span class="command"><strong>make
                   4984:          update</strong></span>:</p>
                   4985: <div class="variablelist"><dl class="variablelist">
                   4986: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4987: <dd><p>Install target to recursively use for the
                   4988:                updated package and the dependent packages.
                   4989:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4990:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4991:                <span class="command"><strong>make update</strong></span>.  Other good
                   4992:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4993:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4994:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4995:                endless loop!</p></dd>
                   4996: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4997: <dd><p>Don't clean up after updating.  Useful if
                   4998:                you want to leave the work sources of the updated
                   4999:                packages around for inspection or other purposes.
                   5000:                Be sure you eventually clean up the source tree
                   5001:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   5002:                or you may run into troubles with old source code
                   5003:                still lying around on your next
                   5004:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   5005:                update</strong></span>.</p></dd>
                   5006: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   5007: <dd><p>Deinstall each package before installing
                   5008:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   5009:                may be necessary if the
                   5010:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   5011:                called after interrupting a running <span class="command"><strong>make
                   5012:                update</strong></span>.</p></dd>
                   5013: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   5014: <dd><p>Allows you to disable recursion and hardcode
                   5015:                the target for packages.  The default is
                   5016:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   5017:                facilitating a recursive update of prerequisite
                   5018:                packages.  Only set
                   5019:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   5020:                disable recursive updates. Use
                   5021:                <code class="varname">UPDATE_TARGET</code> instead to just
                   5022:                set a specific target for each package to be
                   5023:                installed during <span class="command"><strong>make update</strong></span>
                   5024:                (see above).</p></dd>
                   5025: </dl></div>
                   5026: </dd>
                   5027: <dt><span class="term">clean-update</span></dt>
                   5028: <dd>
                   5029: <p>Clean the source tree for all packages that would
                   5030:          get updated if <span class="command"><strong>make update</strong></span> was called
                   5031:          from the current directory.  This target should not be
                   5032:          used if the current package (or any of its depending
                   5033:          packages) have already been de-installed (e.g., after
                   5034:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   5035:          some packages you intended to update. As a rule of
                   5036:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   5037:          the first time you run <span class="command"><strong>make update</strong></span>
                   5038:          and only if you have a dirty package tree (e.g., if you
                   5039:          used <code class="varname">NOCLEAN</code>).</p>
                   5040: <p>If you are unsure about whether your tree is
                   5041:          clean, you can either perform a <span class="command"><strong>make
                   5042:          clean</strong></span> at the top of the tree, or use the
                   5043:          following sequence of commands from the directory of the
                   5044:          package you want to update (<span class="emphasis"><em>before</em></span>
                   5045:          running <span class="command"><strong>make update</strong></span> for the first
                   5046:          time, otherwise you lose all the packages you wanted to
                   5047:          update!):</p>
                   5048: <pre class="screen">
                   5049: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   5050: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   5051: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   5052:          </pre>
                   5053: <p>The following variables can be used either on the
                   5054:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   5055:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   5056: <div class="variablelist"><dl class="variablelist">
                   5057: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   5058: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   5059:                reconstruct the list of directories to update for
                   5060:                this package.  Only use this if <span class="command"><strong>make
                   5061:                update</strong></span> successfully installed all
                   5062:                packages you wanted to update.  Normally, this is
                   5063:                done automatically on <span class="command"><strong>make
                   5064:                update</strong></span>, but may have been suppressed by
                   5065:                the <code class="varname">NOCLEAN</code> variable (see
                   5066:                above).</p></dd>
                   5067: </dl></div>
                   5068: </dd>
                   5069: <dt><span class="term">replace</span></dt>
                   5070: <dd>
                   5071: <p>Update the installation of the current package.  This
                   5072:          differs from update in that it does not replace dependent
1.322     leot     5073:          packages.  You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.299     rillig   5074:          target to work.</p>
                   5075: <p><span class="emphasis"><em>Be careful when using this
                   5076:          target!</em></span> There are no guarantees that dependent
                   5077:          packages will still work, in particular they will most
                   5078:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   5079:          library package whose shared library major version changed
                   5080:          between your installed version and the new one.  For this
                   5081:          reason, this target is not officially supported and only
                   5082:          recommended for advanced users.</p>
                   5083: </dd>
                   5084: <dt><span class="term">info</span></dt>
1.378     leot     5085: <dd><p>This target invokes <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   5086:          package. You can use this to check which version of a
                   5087:          package is installed.</p></dd>
                   5088: <dt><span class="term">index</span></dt>
                   5089: <dd>
                   5090: <p>This is a top-level command, i.e. it should be used in
                   5091:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   5092:          database of all packages in the local pkgsrc tree, including
                   5093:          dependencies, comment, maintainer, and some other useful
                   5094:          information.  Individual entries are created by running
                   5095:          <span class="command"><strong>make describe</strong></span> in the packages'
                   5096:          directories.  This index file is saved as
                   5097:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   5098:          verbose format by running <span class="command"><strong>make
                   5099:          print-index</strong></span>.  You can search in it with
                   5100:          <span class="command"><strong>make search
                   5101:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   5102:          extract a list of all packages that depend on a particular
                   5103:          one by running <span class="command"><strong>make show-deps
                   5104:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   5105: <p>Running this command takes a very long time, some
                   5106:          hours even on fast machines!</p>
                   5107: </dd>
                   5108: <dt><span class="term">readme</span></dt>
                   5109: <dd>
                   5110: <p>This target generates a
1.314     nia      5111:          <code class="filename">index.html</code> file, which can be
1.322     leot     5112:          viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.299     rillig   5113:          contain references to any packages which are in the
                   5114:          <code class="varname">PACKAGES</code> directory on the local
                   5115:          host. The generated files can be made to refer to URLs
                   5116:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   5117:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      5118:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   5119:          files which pointed to binary packages on the local
                   5120:          machine, in the directory
                   5121:          <code class="filename">/usr/packages</code>, set
                   5122:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   5123:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   5124:          <code class="varname">${PACKAGES}</code> directory and its
                   5125:          subdirectories will be searched for all the binary
                   5126:          packages.</p>
                   5127: <p>The target can be run at the toplevel or in category
                   5128:          directories, in which case it descends recursively.</p>
                   5129: </dd>
                   5130: <dt><span class="term">readme-all</span></dt>
                   5131: <dd><p>This is a top-level command, run it in
                   5132:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   5133:          file <code class="filename">README-all.html</code> which contains a
                   5134:          list of all packages currently available in the NetBSD
                   5135:          Packages Collection, together with the category they belong
                   5136:          to and a short description. This file is compiled from the
1.314     nia      5137:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   5138:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   5139:          readme</strong></span>.</p></dd>
                   5140: <dt><span class="term">cdrom-readme</span></dt>
                   5141: <dd><p>This is very much the same as the
                   5142:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   5143:          used when generating a pkgsrc tree to be written to a
                   5144:          CD-ROM.  This target also produces
1.314     nia      5145:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   5146:          to refer to URLs based on
                   5147:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   5148:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   5149: <dt><span class="term">show-distfiles</span></dt>
                   5150: <dd><p>This target shows which distfiles and patchfiles
                   5151:          are needed to build the package
                   5152:          (<code class="varname">ALLFILES</code>, which contains all
                   5153:          <code class="varname">DISTFILES</code> and
                   5154:          <code class="varname">PATCHFILES</code>, but not
                   5155:          <code class="filename">patches/*</code>).</p></dd>
                   5156: <dt><span class="term">show-downlevel</span></dt>
                   5157: <dd><p>This target shows nothing if the package is not
                   5158:          installed. If a version of this package is installed,
                   5159:          but is not the version provided in this version of
                   5160:          pkgsrc, then a warning message is displayed. This target
                   5161:          can be used to show which of your installed packages are
                   5162:          downlevel, and so the old versions can be deleted, and
                   5163:          the current ones added.</p></dd>
                   5164: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5165: <dd><p>This target shows the directory in the pkgsrc
                   5166:          hierarchy from which the package can be built and
                   5167:          installed. This may not be the same directory as the one
                   5168:          from which the package was installed. This target is
                   5169:          intended to be used by people who may wish to upgrade
                   5170:          many packages on a single host, and can be invoked from
                   5171:          the top-level pkgsrc Makefile by using the
                   5172:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   5173: <dt><span class="term">show-installed-depends</span></dt>
                   5174: <dd><p>This target shows which installed packages match
                   5175:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5176:          if out of date dependencies are causing build
                   5177:          problems.</p></dd>
                   5178: <dt><span class="term">print-build-depends-list</span></dt>
                   5179: <dd><p>This target shows the list of packages that the current package
                   5180:            depends on for building.</p></dd>
                   5181: <dt><span class="term">print-run-depends-list</span></dt>
                   5182: <dd><p>This target shows the list of packages that the current package
                   5183:            depends on for running.</p></dd>
                   5184: <dt><span class="term">check-shlibs</span></dt>
                   5185: <dd><p>After a package is installed, check all its
                   5186:          binaries and (on ELF platforms) shared libraries to see
                   5187:          if they find the shared libs they need.  Run by default
                   5188:          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>
                   5189: <dt><span class="term">print-PLIST</span></dt>
                   5190: <dd>
                   5191: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5192:          upgraded pkg, this prints out an attempt to generate a
                   5193:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5194:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5195:          to care for shared libs etc., but it is
                   5196:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5197:          result before putting it into
                   5198:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5199:          diff the output of this command against an already
                   5200:          existing <code class="filename">PLIST</code> file.</p>
1.378     leot     5201: <p>If the package installs files via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5202:          other methods that don't update file access times, be
                   5203:          sure to add these files manually to your
                   5204:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5205:          -newer</span>&#8221;</span> command used by this target won't catch
                   5206:          them!</p>
                   5207: <p>See <a class="xref" href="#print-PLIST" title="19.3. Tweaking output of make print-PLIST">Section 19.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
                   5208:          information on this target.</p>
                   5209: </dd>
1.371     cheusov  5210: <dt><span class="term">rebuild</span></dt>
                   5211: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
                   5212:          noticed some further modifications of sources are needed,
                   5213:          you can repeat the build with this target, which will ignore
                   5214:          the <span class="quote">&#8220;<span class="quote">already built</span>&#8221;</span> flag. This target is
                   5215:          helpful while working with patches.</p></dd>
                   5216: <dt><span class="term">repackage</span></dt>
                   5217: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
                   5218:          noticed some further modifications of sources are needed,
                   5219:          you can repeat the package with this target, which will ignore
                   5220:          the <span class="quote">&#8220;<span class="quote">already packaged</span>&#8221;</span> flag. This target is
                   5221:          helpful while working with patches, PLIST* files etc.</p></dd>
                   5222: <dt><span class="term">retest</span></dt>
                   5223: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
                   5224:          noticed some further modifications of sources are needed,
                   5225:          you can repeat the test with this target, which will ignore
                   5226:          the <span class="quote">&#8220;<span class="quote">already tested</span>&#8221;</span> flag. This target is
                   5227:          helpful while working with patches.</p></dd>
1.299     rillig   5228: </dl></div>
                   5229: </div>
                   5230: </div>
                   5231: <div class="chapter">
                   5232: <div class="titlepage"><div><div><h2 class="title">
                   5233: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5234: <div class="toc">
                   5235: <p><b>Table of Contents</b></p>
                   5236: <dl class="toc">
                   5237: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5238: <dd><dl>
1.334     nia      5239: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   5240: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   5241: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299     rillig   5242: </dl></dd>
                   5243: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5244: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   5245: </dl>
                   5246: </div>
                   5247: <p>When you find a package that is not yet in pkgsrc, you
                   5248: most likely have a URL from where you can download the source
                   5249: code. Starting with this URL, creating a package involves only a
                   5250: few steps.</p>
                   5251: <div class="procedure"><ol class="procedure" type="1">
                   5252: <li class="step"><p>In your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, set <code class="code">PKG_DEVELOPER=yes</code> to
                   5253: enable the basic quality checks.</p></li>
                   5254: <li class="step">
1.322     leot     5255: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.299     rillig   5256: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5257: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5258: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5259: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5260: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5261: </li>
                   5262: <li class="step">
                   5263: <p>Choose one of the top-level directories as the category in
                   5264: which you want to place your package. You can also create a directory of
1.334     nia      5265: your own (maybe called <code class="filename">local</code>). Change into that
                   5266: category directory:</p>
                   5267: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.299     rillig   5268: </li>
                   5269: <li class="step">
1.334     nia      5270: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
                   5271: argument the URL of the distribution file (in most cases a
                   5272: <code class="filename">.tar.gz</code> file). This will download the distribution
                   5273: file and create the necessary files of the package, based on what's in
                   5274: the distribution file:</p>
1.299     rillig   5275: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>url2pkg <em class="replaceable"><code>https://www.example.org/packages/package-1.0.tar.gz</code></em></code></strong></pre>
                   5276: </li>
                   5277: <li class="step">
                   5278: <p>Examine the extracted files to determine the dependencies of
                   5279: your package. Ideally, this is mentioned in some
                   5280: <code class="filename">README</code> file, but things may differ. For each of
                   5281: these dependencies, look where it exists in pkgsrc, and if there is a
                   5282: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5283: line to your package <code class="filename">Makefile</code> which includes that
                   5284: file just before the last line. If the
                   5285: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5286: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5287: that the package's include files and libraries are provided.</p>
1.334     nia      5288: <p>If you just need binaries from a dependent package, add a
1.299     rillig   5289: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5290: version of the dependency and where it can be found in pkgsrc. This line
                   5291: should be placed in the third paragraph. If the dependency is only
                   5292: needed for building the package, but not when using it, use
                   5293: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5294: instead of <code class="varname">DEPENDS</code>.
                   5295: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5296: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5297: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334     nia      5298: packages, i.e. packages for the platform where the package is built;
1.299     rillig   5299: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334     nia      5300: packages, i.e. packages for the platform for which the package
                   5301: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
                   5302: specifies a dependency used only for testing the resulting package
                   5303: built, using the upstream project's included test suite, on the native
                   5304: platform.
1.299     rillig   5305: Your package may then look like this:</p>
                   5306: <pre class="programlisting">
                   5307: [...]
                   5308: 
                   5309: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5310: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5311: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5312: 
                   5313: [...]
                   5314: 
                   5315: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5316: .include "../../devel/glib2/buildlink3.mk"
                   5317: .include "../../mk/bsd.pkg.mk"
                   5318: </pre>
                   5319: </li>
                   5320: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5321: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5322: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5323: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5324: additional explanations.</p></li>
                   5325: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5326: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="14.1. Common types of packages">Section 14.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
                   5327: over there, you can hopefully continue here.</p></li>
                   5328: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5329: directory from the extracted files. Besides these files, a lot of cache
1.334     nia      5330: files and other system information have been saved in the working
                   5331: directory, which may have become outdated after you edited the
1.299     rillig   5332: <code class="filename">Makefile</code>.</p></li>
                   5333: <li class="step">
                   5334: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5335: 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>
1.334     nia      5336: <p>If the extracted files from the package need to be fixed, run
                   5337: multiple rounds of these commands:</p>
                   5338: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299     rillig   5339: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5340: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334     nia      5341: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
                   5342: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299     rillig   5343: </li>
                   5344: <li class="step"><p>When the package builds fine, the next step is to install
                   5345: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5346: everything works.</p></li>
                   5347: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5348: contains a list of the files that are installed by the package, is
                   5349: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5350: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5351: the file using your preferred text editor to see if the list of
                   5352: files looks plausible.</p></li>
                   5353: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5354: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5355: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5356: had been registered in the database of installed files, but with an
                   5357: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5358: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5359: registered with the list of files from
                   5360: <code class="filename">PLIST</code>.</p></li>
                   5361: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5362: from above again in a single step, making sure that the PLIST is correct
                   5363: and the whole package is created as intended.</p></li>
1.334     nia      5364: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
                   5365: left to do.</p></li>
1.299     rillig   5366: <li class="step"><p>Commit the package to pkgsrc-wip or main pkgsrc; see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
                   5367: </ol></div>
                   5368: <div class="sect1">
                   5369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5370: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5371: <div class="sect2">
                   5372: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5373: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299     rillig   5374: <p>Python modules and programs packages are easily created using a
                   5375: set of predefined variables.</p>
                   5376: <p>
                   5377: If some Python versions are not supported by the software, set the
                   5378: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5379: that are not supported, e.g.
                   5380: </p>
                   5381: <pre class="programlisting">
                   5382: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5383: </pre>
                   5384: <p>
1.363     gutterid 5385: If the packaged software is a Python module, include
1.372     wiz      5386: <code class="filename">../../lang/python/wheel.mk</code>.  Note per PEP-518,
1.376     wiz      5387: the minimum and default requirement to create .whl files is <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a>; however, there are various
                   5388: other possible tools that projects can use. Thus inclusion of
1.372     wiz      5389: <code class="filename">wheel.mk</code> does not imply these defaults are
                   5390: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
                   5391: specifically requires as packaging tools must be defined in the
                   5392: package Makefile.
1.330     wiz      5393: </p>
1.362     wiz      5394: <p>The package directory should be called
1.299     rillig   5395: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5396: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5397: </p>
                   5398: <pre class="programlisting">
                   5399: DISTNAME=   foopymodule-1.2.10
                   5400: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5401: </pre>
1.341     gutterid 5402: <p>
                   5403: For software in PyPi, the name should match what PyPi specifies for
                   5404: "pip install software".
                   5405: </p>
1.299     rillig   5406: <p>If it is an application, include
                   5407: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5408: In order to correctly set the path to the Python interpreter, use the
                   5409: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5410: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5411: For example:
                   5412: </p>
                   5413: <pre class="programlisting">
                   5414: REPLACE_PYTHON=   *.py
                   5415: </pre>
                   5416: </div>
                   5417: <div class="sect2">
                   5418: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5419: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299     rillig   5420: <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>
                   5421: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322     leot     5422: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.299     rillig   5423: Individual packages (and optionally their dependencies) may be created
                   5424: and updated.  R packages generally follow the same form, and most of
                   5425: the relevant information needed is contained in a
                   5426: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5427: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5428: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5429: creates or updates a package in the canonical form.  The resulting
                   5430: package should be reviewed for correctness.</p>
                   5431: </div>
                   5432: <div class="sect2">
                   5433: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5434: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299     rillig   5435: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322     leot     5436: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.299     rillig   5437: <p>If the TeXlive package name is not known, it may be useful to
                   5438: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5439: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5440: 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
                   5441: archive</a>.</p>
                   5442: <p>If the TeXlive package name is known, download the files from
                   5443: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5444: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5445: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5446: also have associated documentation packages, so download
                   5447: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5448: should be placed in the appropriate category directory, which is often
                   5449: but not always <code class="filename">print</code>.  Then run the following
                   5450: command in the category directory.</p>
                   5451: <pre class="programlisting">
                   5452: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5453: </pre>
                   5454: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5455: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5456: are correct.</p>
                   5457: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5458: currently does not include version information in package filenames
                   5459: and changes their contents periodically when updates occur.
                   5460: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5461: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5462: main one and the corresponding documentation, upload the distfiles
                   5463: with the following command in each package directory.</p>
                   5464: <pre class="programlisting">
                   5465: make upload-distfiles
                   5466: </pre>
                   5467: </div>
                   5468: </div>
                   5469: <div class="sect1">
                   5470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5471: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5472: <div class="sect2">
                   5473: <div class="titlepage"><div><div><h3 class="title">
                   5474: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5475: <div class="sect3">
                   5476: <div class="titlepage"><div><div><h4 class="title">
                   5477: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5478: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5479: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5480: pkgsrc. As the description says it has to do with the web, the obvious
                   5481: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5482: <pre class="programlisting">
                   5483: <code class="prompt">$</code> mkdir www/nvu
                   5484: <code class="prompt">$</code> cd www/nvu
                   5485: </pre>
                   5486: <p>The web site says that the sources are available as a tar file, so
                   5487: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5488: <pre class="programlisting">
                   5489: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5490: </pre>
                   5491: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5492: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5493: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5494: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5495: <code class="varname">COMMENT</code> fields. Then the package
                   5496: <code class="filename">Makefile</code> looked like that:</p>
                   5497: <pre class="programlisting">
                   5498: # $NetBSD $
                   5499: #
                   5500: 
                   5501: DISTNAME=       nvu-1.0-sources
                   5502: PKGNAME=        nvu-1.0
                   5503: CATEGORIES=     www
                   5504: MASTER_SITES=   http://cvs.nvu.com/download/
                   5505: EXTRACT_SUFX=   .tar.bz2
                   5506: 
                   5507: MAINTAINER=     rillig@NetBSD.org
                   5508: HOMEPAGE=       http://cvs.nvu.com/
                   5509: COMMENT=        Web Authoring System
                   5510: 
                   5511: # url2pkg-marker (please do not remove this line.)
                   5512: .include "../../mk/bsd.pkg.mk"
                   5513: </pre>
                   5514: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5515: this is a workaround to prevent CVS expanding to the filename of the
                   5516: guide.</p>
                   5517: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5518: source archive:</p>
                   5519: <pre class="programlisting">
                   5520: url2pkg&gt; Running "make makesum" ...
                   5521: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5522: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5523: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5524: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5525: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5526: url2pkg&gt; Running "make extract" ...
                   5527: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5528: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5529: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5530: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5531: ===&gt; Installing dependencies for nvu-1.0
                   5532: ===&gt; Overriding tools for nvu-1.0
                   5533: ===&gt; Extracting for nvu-1.0
                   5534: url2pkg&gt; Adjusting the Makefile.
                   5535: 
                   5536: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5537: 
                   5538: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5539: </pre>
                   5540: </div>
                   5541: <div class="sect3">
                   5542: <div class="titlepage"><div><div><h4 class="title">
                   5543: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5544: <p>Now that the package has been extracted, let's see what's inside
                   5545: it. The package has a <code class="filename">README.txt</code>, but that only
                   5546: says something about mozilla, so it's probably useless for seeing what
                   5547: dependencies this package has. But since there is a GNU configure script
                   5548: in the package, let's hope that it will complain about everything it
                   5549: needs.</p>
                   5550: <pre class="programlisting">
                   5551: <code class="prompt">$</code> bmake
                   5552: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5553: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5554: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5555: ===&gt; Patching for nvu-1.0
                   5556: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5557: ===&gt; Configuring for nvu-1.0
                   5558: [...]
                   5559: configure: error: Perl 5.004 or higher is required.
                   5560: [...]
                   5561: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5562: [...]
                   5563: </pre>
                   5564: <p>That worked quite well. So I opened the package Makefile in my
                   5565: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5566: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5567: package have changed now, and since a perl wrapper is automatically
                   5568: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5569: from scratch.</p>
                   5570: <pre class="programlisting">
                   5571: <code class="prompt">$</code> bmake clean
                   5572: ===&gt; Cleaning for nvu-1.0
                   5573: <code class="prompt">$</code> bmake
                   5574: [...]
                   5575: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5576: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5577: [...]
                   5578: </pre>
                   5579: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5580: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5581: <pre class="programlisting">
                   5582: [...]
                   5583: checking for GTK - version &gt;= 1.2.0... no
                   5584: *** Could not run GTK test program, checking why...
                   5585: [...]
                   5586: </pre>
                   5587: <p>Now to the other dependencies. The first question is: Where is the
                   5588: GTK package hidden in pkgsrc?</p>
                   5589: <pre class="programlisting">
                   5590: <code class="prompt">$</code> echo ../../*/gtk*
                   5591: [many packages ...]
                   5592: <code class="prompt">$</code> echo ../../*/gtk
                   5593: ../../x11/gtk
                   5594: <code class="prompt">$</code> echo ../../*/gtk2
                   5595: ../../x11/gtk2
                   5596: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5597: ../../x11/gtk2/buildlink3.mk
                   5598: </pre>
                   5599: <p>The first try was definitely too broad. The second one had exactly
                   5600: one result, which is very good. But there is one pitfall with GNOME
                   5601: packages. Before GNOME 2 had been released, there were already many
                   5602: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5603: packages, the GNOME 2 packages were imported as separate packages, and
                   5604: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5605: whether this was the case here, and indeed it was.</p>
                   5606: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5607: file, adding the dependency is very easy. I just inserted an
                   5608: <code class="literal">.include</code> line before the last line of the package
                   5609: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5610: <pre class="programlisting">
                   5611: [...]
                   5612: .include "../../x11/gtk2/buildlink3.mk"
                   5613: .include "../../mk/bsd.pkg.mk
                   5614: </pre>
                   5615: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5616: was:</p>
1.75      rillig   5617: <pre class="programlisting">
1.299     rillig   5618: [...]
                   5619: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5620: checking for GTK - version &gt;= 1.2.0... no
                   5621: *** Could not run GTK test program, checking why...
                   5622: *** The test program failed to compile or link. See the file config.log for the
                   5623: *** exact error that occured. This usually means GTK was incorrectly installed
                   5624: *** or that you have moved GTK since it was installed. In the latter case, you
                   5625: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5626: configure: error: Test for GTK failed.
                   5627: [...]
1.222     sevan    5628: </pre>
1.299     rillig   5629: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5630: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5631: told me that this package really wanted to have the GNOME 1 version of
                   5632: GTK. If the package had looked for GTK2, it would have looked for
                   5633: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5634: So I changed the <code class="literal">x11/gtk2</code> to
                   5635: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5636: and tried again.</p>
1.119     mishka   5637: <pre class="programlisting">
1.299     rillig   5638: [...]
                   5639: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5640: In file included from xpidl.c:42:
                   5641: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5642: In file included from xpidl.c:42:
                   5643: xpidl.h:132: error: parse error before "IDL_ns"
                   5644: [...]
1.222     sevan    5645: </pre>
1.299     rillig   5646: <p>The package still does not find all of its dependencies. Now the
                   5647: question is: Which package provides the
                   5648: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5649: <pre class="programlisting">
1.299     rillig   5650: <code class="prompt">$</code> echo ../../*/*idl*
                   5651: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5652: <code class="prompt">$</code> echo ../../*/*IDL*
                   5653: ../../net/libIDL
1.222     sevan    5654: </pre>
1.299     rillig   5655: <p>Let's take the one from the second try. So I included the
                   5656: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5657: again. But the error didn't change. After digging through some of the
                   5658: code, I concluded that the build process of the package was broken and
                   5659: couldn't have ever worked, but since the Mozilla source tree is quite
                   5660: large, I didn't want to fix it. So I added the following to the package
                   5661: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5662: <pre class="programlisting">
1.299     rillig   5663: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5664: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5665: </pre>
1.299     rillig   5666: <p>The latter line is needed because the package expects the library
                   5667: <code class="filename">libIDL.so</code>, but only
                   5668: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5669: wrapper to rewrite that on the fly.</p>
                   5670: <p>The next problem was related to a recent change of the FreeType
1.322     leot     5671: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.299     rillig   5672: which patch files were relevant for this issue and copied them to the
                   5673: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5674: patches so that they applied cleanly and retried again. This time,
                   5675: everything worked.</p>
1.197     wiz      5676: </div>
1.299     rillig   5677: <div class="sect3">
                   5678: <div class="titlepage"><div><div><h4 class="title">
                   5679: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5680: <pre class="programlisting">
1.299     rillig   5681: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5682: [...]
                   5683: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5684: <code class="prompt">$</code> bmake deinstall
                   5685: <code class="prompt">$</code> bmake install
1.222     sevan    5686: </pre>
1.299     rillig   5687: </div>
                   5688: </div>
1.75      rillig   5689: </div>
                   5690: </div>
1.148     asau     5691: <div class="chapter">
1.75      rillig   5692: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5693: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5694: <div class="toc">
                   5695: <p><b>Table of Contents</b></p>
1.210     leot     5696: <dl class="toc">
1.299     rillig   5697: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5698: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5699: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5700: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5701: <dd><dl>
                   5702: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5703: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5704: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   5705: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 5706: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75      rillig   5707: </dl></dd>
                   5708: </dl>
                   5709: </div>
1.299     rillig   5710: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5711:   each of which forms a well-defined part of the pkgsrc system. Using
1.378     leot     5712:   the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299     rillig   5713:   like pkgsrc requires some discipline to keep the code correct and
                   5714:   understandable.</p>
                   5715: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5716:   programming are variables and shell
                   5717:   commands. Among these shell commands may even be more complex ones
1.378     leot     5718:   like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299     rillig   5719:   as intended it is necessary to quote all variables correctly when they
                   5720:   are used.</p>
                   5721: <p>This chapter describes some patterns that appear quite often in
                   5722:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5723:   with them.</p>
1.148     asau     5724: <div class="sect1">
1.75      rillig   5725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5726: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5727: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5728: <p>When you are creating a file as a
                   5729:     target of a rule, always write the data to a temporary file first
                   5730:     and finally rename that file. Otherwise there might occur an error
                   5731:     in the middle of generating the file, and when the user runs
1.378     leot     5732:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299     rillig   5733:     regenerated properly. Example:</p>
1.75      rillig   5734: <pre class="programlisting">
1.299     rillig   5735: wrong:
                   5736:         @echo "line 1" &gt; ${.TARGET}
                   5737:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5738:         @false
                   5739: 
                   5740: correct:
                   5741:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5742:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5743:         @false
                   5744:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5745: </pre>
1.299     rillig   5746: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5747:     <code class="filename">wrong</code> will exist, although there was an error
                   5748:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5749:     correct</strong></span> gives an error message twice, as expected.</p>
1.378     leot     5750: <p>You might remember that <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5751:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5752:     happens when it is interrupted, for example by pressing
                   5753:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.378     leot     5754:     when one of the commands fails (like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5755: </li></ul></div>
                   5756: </div>
                   5757: <div class="sect1">
                   5758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5759: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5760: <p><code class="filename">Makefile</code> variables contain strings that
                   5761:     can be processed using the five operators <code class="code">=</code>,
                   5762:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.378     leot     5763:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5764:     page.</p>
                   5765: <p>When a variable's value is parsed from a
                   5766:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5767:     the backslash character <code class="code">\</code> are handled specially. If a
                   5768:     backslash is the last character in a line, that backslash is removed
                   5769:     from the line and the line continues with the next line of the file.</p>
                   5770: <p>The <code class="code">#</code> character starts a comment that reaches
                   5771:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5772:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5773: <p>The evaluation of variables either happens immediately or lazy.
                   5774:     It happens immediately when the variable occurs on the right-hand
                   5775:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5776:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5777:     In the other cases, it is evaluated lazily.</p>
                   5778: <p>Some of the modifiers split the string into words and then
                   5779:     operate on the words, others operate on the string as a whole. When a
                   5780:     string is split into words, double quotes and single quotes are
1.378     leot     5781:     interpreted as delimiters, just like in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5782: <div class="sect2">
                   5783: <div class="titlepage"><div><div><h3 class="title">
                   5784: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5785: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5786: <li class="listitem"><p>All variable names starting with an underscore
                   5787:        are reserved for use by the pkgsrc infrastructure. They shall
                   5788:        not be used by packages.</p></li>
                   5789: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5790:        lowercase variable names for the iteration
                   5791:        variables.</p></li>
                   5792: <li class="listitem"><p>All list variables should have a plural name,
                   5793:        such as <code class="varname">PKG_OPTIONS</code> or
                   5794:        <code class="varname">DISTFILES</code>.</p></li>
                   5795: </ul></div>
                   5796: </div>
                   5797: </div>
                   5798: <div class="sect1">
                   5799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5800: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5801: <div class="sect2">
                   5802: <div class="titlepage"><div><div><h3 class="title">
                   5803: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5804: <p>When adding a string that possibly contains whitespace or quotes to
                   5805: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5806: modifier.</p>
                   5807: <p>When adding another list to a list (example 2), it must not be
                   5808: quoted, since its elements are already quoted.</p>
1.75      rillig   5809: <pre class="programlisting">
1.299     rillig   5810: STRING=         foo * bar `date`
                   5811: LIST=           # empty
                   5812: ANOTHER_LIST=   a=b c=d
                   5813: 
                   5814: LIST+=          ${STRING:Q}       # 1
                   5815: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5816: </pre>
1.299     rillig   5817: </div>
                   5818: <div class="sect2">
                   5819: <div class="titlepage"><div><div><h3 class="title">
                   5820: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5821: <p>Echoing a string containing special characters needs special
                   5822: work.</p>
1.75      rillig   5823: <pre class="programlisting">
1.299     rillig   5824: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5825: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5826: 
                   5827: all:
                   5828:         echo ${STRING}                  # 1
                   5829:         echo ${STRING:Q}                # 2
                   5830:         printf '%s\n' ${STRING:Q}''     # 3
                   5831:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5832: </pre>
1.299     rillig   5833: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5834: are just copied.</p>
                   5835: <p>Example 2 quotes the string so that the shell interprets it
                   5836: correctly. But the echo command may additionally interpret strings with a
                   5837: leading dash or those containing backslashes.</p>
1.378     leot     5838: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5839: interprets the format string, but not the next argument. The trailing
                   5840: single quotes handle the case when the string is empty. In that case, the
                   5841: :Q modifier would result in an empty string too, which would then be
1.378     leot     5842: skipped by the shell. For <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5843: but other programs may care.</p>
                   5844: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5845: need to be quoted because the quoting has already been done
                   5846: when adding elements to the list.</p>
1.75      rillig   5847: </div>
1.148     asau     5848: <div class="sect2">
1.75      rillig   5849: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5850: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5851: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5852: GNU-style configure script (especially those that call other configure
                   5853: scripts), it must not have leading or trailing whitespace, since
                   5854: otherwise the configure script gets confused. To trim leading and
                   5855: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5856: following example:</p>
1.75      rillig   5857: <pre class="programlisting">
1.299     rillig   5858: CPPFLAGS=               # empty
                   5859: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5860: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5861: 
1.299     rillig   5862: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5863: 
1.299     rillig   5864: all:
                   5865:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5866:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5867: </pre>
                   5868: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5869: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5870: space.</p>
                   5871: </div>
                   5872: <div class="sect2">
                   5873: <div class="titlepage"><div><div><h3 class="title">
                   5874: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5875: <p>When a possibly empty variable is used in a shell program, it may
                   5876: lead to a syntax error.</p>
                   5877: <pre class="programlisting">
                   5878: EGFILES=        # empty
1.87      wiz      5879: 
1.299     rillig   5880: install-examples:   # produces a syntax error in the shell
                   5881:         for egfile in ${EGFILES}; do            \
                   5882:                 echo "Installing $$egfile";     \
                   5883:         done
                   5884: </pre>
                   5885: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.378     leot     5886: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5887: To fix this syntax error, use one of the snippets below.</p>
                   5888: <pre class="programlisting">
1.344     gutterid 5889: EGFILES=        # empty
1.87      wiz      5890: 
1.299     rillig   5891: install-examples:
                   5892:         for egfile in ${EGFILES} ""; do         \
                   5893:                 [ -n "$$egfile" ] || continue;  \
                   5894:                 echo "Installing $$egfile";     \
                   5895:         done
                   5896: </pre>
                   5897: <p>In this case, an empty string is appended to the iteration list (to
                   5898: prevent the syntax error) and filtered out later.</p>
                   5899: <pre class="programlisting">
                   5900: EGFILES=        # empty
1.87      wiz      5901: 
1.299     rillig   5902: install-examples:
                   5903: .for egfile in ${EGFILES}
                   5904:         echo "Installing ${egfile}"
                   5905: .endfor
1.100     rillig   5906: </pre>
1.299     rillig   5907: <p>If one of the filenames contains special characters, it should be
                   5908: enclosed in single or double quotes.</p>
                   5909: <p>To have a shell command test whether a make variable is empty, use
                   5910: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5911: </div>
1.344     gutterid 5912: <div class="sect2">
                   5913: <div class="titlepage"><div><div><h3 class="title">
                   5914: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
                   5915: <p>When a variable can have the values <code class="literal">yes</code> or
                   5916: <code class="literal">no</code>, use the following pattern to test the variable:</p>
                   5917: <pre class="programlisting">
                   5918: .if ${VAR:U:tl} == "yes"
                   5919: # do something
                   5920: .endif
                   5921: </pre>
                   5922: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
                   5923: can be undefined. If the variable is guaranteed to be defined, the
                   5924: <code class="literal">:U</code> can be omitted.</p>
                   5925: <p>The <code class="literal">:tl</code> modifier converts the variable value to
                   5926: lowercase, allowing for the values <code class="literal">yes</code>,
                   5927: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
                   5928: </div>
1.299     rillig   5929: </div>
                   5930: </div>
                   5931: <div class="chapter">
                   5932: <div class="titlepage"><div><div><h2 class="title">
                   5933: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5934: <div class="toc">
                   5935: <p><b>Table of Contents</b></p>
                   5936: <dl class="toc">
                   5937: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5938: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   5939: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5940: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5941: </dl>
1.75      rillig   5942: </div>
1.299     rillig   5943: <p>Many packages have the ability to be built to support different
                   5944: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5945: in pkgsrc that provides generic handling of those options that
                   5946: determine different ways in which the packages can be built.  It's
                   5947: possible for the user to specify exactly which sets of options will be
                   5948: built into a package or to allow a set of global default options
                   5949: apply.</p>
                   5950: <p>There are two broad classes of behaviors that one might want to
                   5951: control via options.  One is whether some particular feature is
                   5952: enabled in a program that will be built anyway, often by including or
                   5953: not including a dependency on some other package.  The other is
                   5954: whether or not an additional program will be built as part of the
                   5955: package.  Generally, it is better to make a split package for such
                   5956: additional programs instead of using options, because it enables
                   5957: binary packages to be built which can then be added separately.  For
                   5958: example, the foo package might have minimal dependencies (those
                   5959: packages without which foo doesn't make sense), and then the foo-gfoo
                   5960: package might include the GTK frontend program gfoo.  This is better
                   5961: than including a gtk option to foo that adds gfoo, because either that
                   5962: option is default, in which case binary users can't get foo without
                   5963: gfoo, or not default, in which case they can't get gfoo.  With split
                   5964: packages, they can install foo without having GTK, and later decide to
                   5965: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5966: source users too, avoiding the need for rebuilds.</p>
                   5967: <p>Plugins with widely varying dependencies should usually be split
                   5968: instead of options.</p>
                   5969: <p>It is often more work to maintain split packages, especially if
                   5970: the upstream package does not support this.  The decision of split
                   5971: vs. option should be made based on the likelihood that users will want
                   5972: or object to the various pieces, the size of the dependencies that are
                   5973: included, and the amount of work.</p>
                   5974: <p>A further consideration is licensing.  Non-free parts, or parts
                   5975: that depend on non-free dependencies (especially plugins) should
                   5976: almost always be split if feasible.</p>
                   5977: <div class="sect1">
                   5978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5979: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5980: <p>Global default options are listed in
                   5981: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5982: that should be built into every package if that option is supported.
                   5983: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5984: </div>
1.148     asau     5985: <div class="sect1">
1.75      rillig   5986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5987: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5988: </h2></div></div></div>
                   5989: <p>The following example shows how
                   5990: <code class="filename">bsd.options.mk</code> should be used
                   5991: by the hypothetical ``wibble'' package, either in the package
                   5992: <code class="filename">Makefile</code>, or in a file,
                   5993: e.g. <code class="filename">options.mk</code>, that is included by the
                   5994: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5995: <pre class="programlisting">
1.299     rillig   5996: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5997: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5998: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5999: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6000: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6001: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6002: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6003: 
                   6004: .include "../../mk/bsd.prefs.mk"
                   6005: 
                   6006: # this package was previously named wibble2
                   6007: .if defined(PKG_OPTIONS.wibble2)
                   6008: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6009: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6010:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6011: .endif
                   6012: 
                   6013: .include "../../mk/bsd.options.mk"
                   6014: 
                   6015: # Package-specific option-handling
1.100     rillig   6016: 
1.299     rillig   6017: ###
                   6018: ### FOO support
                   6019: ###
                   6020: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6021: CONFIGURE_ARGS+=    --enable-foo
                   6022: .endif
1.100     rillig   6023: 
1.299     rillig   6024: ###
                   6025: ### LDAP support
                   6026: ###
                   6027: .if !empty(PKG_OPTIONS:Mldap)
                   6028: .  include "../../databases/openldap-client/buildlink3.mk"
                   6029: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6030: .endif
1.100     rillig   6031: 
1.299     rillig   6032: ###
                   6033: ### database support
                   6034: ###
                   6035: .if !empty(PKG_OPTIONS:Mmysql)
                   6036: .  include "../../mk/mysql.buildlink3.mk"
                   6037: .endif
                   6038: .if !empty(PKG_OPTIONS:Mpgsql)
                   6039: .  include "../../mk/pgsql.buildlink3.mk"
                   6040: .endif
                   6041: </pre>
                   6042: <p>The first section contains the information about which build
                   6043: options are supported by the package, and any default options settings
                   6044: if needed.</p>
                   6045: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6046: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.378     leot     6047: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299     rillig   6048: options.  It should be set to
                   6049: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6050: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6051: at the point where the options are processed.</p></li>
                   6052: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6053: build options supported by the package.</p></li>
                   6054: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6055: list of names of groups of mutually exclusive options.  The options in
                   6056: each group are listed in
                   6057: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6058: The most specific setting of any option from the group takes
                   6059: precedence over all other options in the group.  Options from the
                   6060: groups will be automatically added to
                   6061: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6062: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6063: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6064: packages will fail if no option from the group is
                   6065: selected.</p></li>
                   6066: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6067: of names of sets of options.  At least one option from each set must
                   6068: be selected.  The options in each set are listed in
                   6069: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6070: Options from the sets will be automatically added to
                   6071: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6072: fail if no option from the set is selected.</p></li>
                   6073: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6074: build options which are enabled by default.</p></li>
                   6075: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6076: of
                   6077: <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>
                   6078: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   6079: their option counterparts.  Pairs should be added with
                   6080: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   6081: warning will be issued if the user uses a legacy
                   6082: variable.</p></li>
                   6083: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6084: of
                   6085: <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>
                   6086: pairs that map options that have been renamed to their new
                   6087: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   6088: the listing of global legacy options.  A warning will be issued if
                   6089: the user uses a legacy option.</p></li>
                   6090: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6091: options implied by deprecated variables used.  This can be used for
                   6092: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6093: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6094: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6095: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6096: a list of warnings about deprecated variables or options used, and
                   6097: what to use instead.</p></li>
                   6098: </ol></div>
                   6099: <p>A package should never modify
                   6100: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6101: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6102: To suggest a default set of options, use
                   6103: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6104: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6105: including <code class="filename">bsd.options.mk</code>.  If none of
                   6106: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6107: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6108: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6109: happen with platform-specific options if none of them is supported on
                   6110: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6111: empty list and the package is otherwise treated as not using the
                   6112: options framework.</p>
                   6113: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6114: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6115: build options, properly filtered to remove unsupported and duplicate
                   6116: options.</p>
                   6117: <p>The remaining sections contain the logic that is specific to
                   6118: each option.  The correct way to check for an option is to check
                   6119: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6120: <pre class="programlisting">
                   6121: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   6122: </pre>
1.75      rillig   6123: </div>
1.299     rillig   6124: <div class="sect1">
                   6125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6126: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   6127: <p>Options that enable similar features in different packages (like
                   6128: optional support for a library) should use a common name in all
                   6129: packages that support it (like the name of the library).  If another
                   6130: package already has an option with the same meaning, use the same
                   6131: name.</p>
                   6132: <p>Options that enable features specific to one package, where it's
                   6133: unlikely that another (unrelated) package has the same (or a similar)
                   6134: optional feature, should use a name prefixed with
                   6135: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6136: <p>If a group of related packages share an optional feature
                   6137: specific to that group, prefix it with the name of the
                   6138: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   6139: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6140: <p>For new options, add a line to
                   6141: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6142: fields, separated by tab.  The first field is the option name, the
                   6143: second its description.  The description should be a whole sentence
                   6144: (starting with an uppercase letter and ending with a period) that
                   6145: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6146: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   6147: </div>
                   6148: <div class="sect1">
                   6149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6150: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   6151: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   6152: different dependencies based on the options with which the package was
                   6153: built. For querying these options, the file
                   6154: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6155: typical example looks like this:</p>
1.87      wiz      6156: <pre class="programlisting">
1.299     rillig   6157: pkgbase := libpurple
                   6158: .include "../../mk/pkg-build-options.mk"
                   6159: 
                   6160: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6161: ...
                   6162: .endif
1.229     sevan    6163: </pre>
1.299     rillig   6164: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6165: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6166: options of the libpurple package, which can then be queried like
                   6167: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6168: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6169: details.</p>
1.75      rillig   6170: </div>
                   6171: </div>
1.148     asau     6172: <div class="chapter">
1.75      rillig   6173: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6174: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6175: <div class="toc">
                   6176: <p><b>Table of Contents</b></p>
1.210     leot     6177: <dl class="toc">
1.299     rillig   6178: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   6179: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   6180: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6181: </dl>
                   6182: </div>
1.299     rillig   6183: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6184: by pkgsrc and also for individual packages to define what commands
                   6185: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6186: or for later run-time of an installed packaged (such as
                   6187: <code class="varname">DEPENDS</code>).
                   6188: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6189: package will not be used.</p>
                   6190: <p>When building a package, the replacement tools are
                   6191: made available in a directory (as symlinks or wrapper scripts)
                   6192: that is early in the executable search path. Just like the buildlink
                   6193: system, this helps with consistent builds.</p>
                   6194: <p>A tool may be needed to help build a specific package. For example,
                   6195: perl, GNU make (gmake) or yacc may be needed.</p>
                   6196: <p>Also a tool may be needed, for example, because the native system's supplied
                   6197: tool may be inefficient for building a package with pkgsrc.
                   6198: For example, a package may need GNU awk, bison (instead of
                   6199: yacc) or a better sed.</p>
                   6200: <p>The tools used by a package can be listed by running
                   6201: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6202: <div class="sect1">
1.75      rillig   6203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6204: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6205: <p>The default set of tools used by pkgsrc is defined in
                   6206: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6207: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6208: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6209: These can be seen by running:
                   6210: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6211: <p>If a package needs a specific program to build
                   6212: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6213: to define the tools needed.</p>
1.75      rillig   6214: </div>
1.299     rillig   6215: <div class="sect1">
                   6216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6217: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6218: <p>In the following examples, the :run means that it is needed at
                   6219: run-time (and becomes a DEPENDS).
                   6220: The default is a build dependency which can be set with
                   6221: :build. (So in this example, it is the same as gmake:build
                   6222: and pkg-config:build.)</p>
1.75      rillig   6223: <pre class="programlisting">
1.299     rillig   6224: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6225: </pre>
1.299     rillig   6226: <p>When using the tools framework, a
                   6227: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6228: which contains the full path to the appropriate tool. For example,
                   6229: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6230: on Linux systems.</p>
                   6231: <p>If you always need a pkgsrc version of the
                   6232: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6233: </p>
1.75      rillig   6234: </div>
1.299     rillig   6235: <div class="sect1">
                   6236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6237: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6238: <p>When improving or porting pkgsrc to a new platform, have a look
                   6239: at (or create) the corresponding platform specific make file fragment under
                   6240: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6241: the name of the common tools. For example:</p>
1.75      rillig   6242: <pre class="programlisting">
1.299     rillig   6243: .if exists(/usr/bin/bzcat)
                   6244: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6245: .elif exists(/usr/bin/bzip2)
                   6246: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6247: .endif
                   6248: 
                   6249: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6250: </pre>
1.75      rillig   6251: </div>
                   6252: </div>
1.299     rillig   6253: <div class="chapter">
                   6254: <div class="titlepage"><div><div><h2 class="title">
                   6255: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6256: <div class="toc">
                   6257: <p><b>Table of Contents</b></p>
                   6258: <dl class="toc">
                   6259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6260: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6261: <dd><dl>
                   6262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6264:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6265:       and
                   6266:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6267:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6268: </dl></dd>
                   6269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig   6270: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig   6271: </dl>
1.75      rillig   6272: </div>
1.299     rillig   6273: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6274:   are seen by a package's configure and build processes.  This is implemented
                   6275:   in a two step process:</p>
                   6276: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6277: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6278:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6279:       of <code class="varname">WRKDIR</code>.</p></li>
                   6280: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6281:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6282:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6283:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6284:       native compiler on some operating systems look like GCC, so that
                   6285:       packages that expect GCC won't require modifications to build with
                   6286:       those native compilers.</p></li>
                   6287: </ol></div>
                   6288: <p>This normalizes the environment in which a package is built so that the
                   6289:   package may be built consistently despite what other software may be
                   6290:   installed. Please note that the normal system header and library paths,
                   6291:   e.g. <code class="filename">/usr/include</code>,
                   6292:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6293:   designed to insulate the package build from non-system-supplied
                   6294:   software.</p>
1.148     asau     6295: <div class="sect1">
1.75      rillig   6296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6297: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6298: <p>The process of converting packages to use the buildlink3
                   6299:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6300:     The things to keep in mind are:</p>
1.128     wiz      6301: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6302: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6303:        instead of the actual toolchain.  Some packages are tricky,
                   6304:        and the only way to know for sure is the check
                   6305:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6306:        wrappers are being invoked.</p></li>
                   6307: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6308:        the package Makefile, e.g. Java VMs, standalone shells,
                   6309:        etc., because the code to symlink files into
                   6310:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6311:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6312:        </p></li>
                   6313: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6314:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6315:        package's Makefile are added as dependencies for that package.
                   6316:        </p></li>
                   6317: </ol></div>
                   6318: <p>If a dependency on a particular package is required for its libraries and
                   6319:     headers, then we replace:</p>
                   6320: <pre class="programlisting">
                   6321: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6322: </pre>
                   6323: <p>with</p>
                   6324: <pre class="programlisting">
                   6325: .include "../../category/foo/buildlink3.mk"
                   6326: </pre>
                   6327: <p>The buildlink3.mk files usually define the required dependencies.
                   6328:     If you need a newer version of the dependency when using buildlink3.mk
                   6329:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6330: <pre class="programlisting">
1.299     rillig   6331: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6332: .include "../../category/foo/buildlink3.mk"
1.1       grant    6333: </pre>
1.299     rillig   6334: <p>There are several <code class="filename">buildlink3.mk</code>
                   6335:     files in <code class="filename">pkgsrc/mk</code>
                   6336:     that handle special package issues:</p>
                   6337: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6338: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6339:        the native or a pkgsrc Berkeley DB implementation based on
                   6340:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6341:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6342: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6343:        comes with neither Curses nor NCurses, this will take care
1.322     leot     6344:        to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.299     rillig   6345: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6346:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6347:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6348:        require a Kerberos 5 implementation.</p></li>
                   6349: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6350:        system-provided Motif installation or adds a dependency on
1.322     leot     6351:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.299     rillig   6352:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6353:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6354:        to choose which Motif version will be used.</p></li>
                   6355: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6356:        system-provided GNU readline or editline (libedit) installation,
1.322     leot     6357:        or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/index.html" target="_top"><code class="filename">devel/readline</code></a>,
                   6358:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.299     rillig   6359:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6360:        If your package really needs GNU readline library, its Makefile
                   6361:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6362:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6363: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6364:        variables that may be used by packages that use the
                   6365:        Open Sound System (OSS) API.</p></li>
                   6366: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6367:        any of the Postgres versions in the variable
                   6368:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6369:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6370:        the file for more information.</p></li>
                   6371: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6372:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322     leot     6373:        a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.299     rillig   6374: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6375:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6376:        library.</p></li>
                   6377: </ul></div>
                   6378: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6379:     files provide a more complete
                   6380:     description of how to use them properly.</p>
1.75      rillig   6381: </div>
1.148     asau     6382: <div class="sect1">
1.75      rillig   6383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6384: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6385: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6386:     included by Makefiles to indicate the need to compile and link
                   6387:     against header files and libraries provided by the package.  A
                   6388:     <code class="filename">buildlink3.mk</code> file should always provide
                   6389:     enough information to add the correct type of dependency
                   6390:     relationship and include any other
                   6391:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6392:     headers and libraries that it needs in turn.</p>
                   6393: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322     leot     6394:     file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.299     rillig   6395:     package is highly recommended.  For most packages, the following
                   6396:     command will generate a good starting point for
                   6397:     <code class="filename">buildlink3.mk</code> files:</p>
                   6398: <pre class="screen">
                   6399: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6400: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6401:     </pre>
1.148     asau     6402: <div class="sect2">
1.75      rillig   6403: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6404: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6405: <p>The following real-life example
                   6406:       <code class="filename">buildlink3.mk</code> is taken
                   6407:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6408: <pre class="programlisting">
1.299     rillig   6409: BUILDLINK_TREE+=        tiff
                   6410: 
                   6411: .if !defined(TIFF_BUILDLINK3_MK)
                   6412: TIFF_BUILDLINK3_MK:=
                   6413: 
                   6414: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6415: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6416: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6417: 
                   6418: .include "../../devel/zlib/buildlink3.mk"
                   6419: .include "../../graphics/jpeg/buildlink3.mk"
                   6420: .endif # TIFF_BUILDLINK3_MK
                   6421: 
                   6422: BUILDLINK_TREE+=        -tiff
1.1       grant    6423: </pre>
1.299     rillig   6424: <p>The header and footer manipulate
                   6425:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6426:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6427:       the dependency tree.</p>
                   6428: <p>The main section is protected from multiple inclusion
                   6429:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6430:       added.  Several important variables are set in the section:</p>
                   6431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6432: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6433:          is the dependency version recorded in the installed
1.299     rillig   6434:          package; this should always be set using
                   6435:          <span class="command"><strong>+=</strong></span> to ensure that
                   6436:          we're appending to any pre-existing list of values.  This
1.300     wiz      6437:          variable should be set to the last version of the
1.299     rillig   6438:          package that had an backwards-incompatible API change.
                   6439:          </p></li>
                   6440: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6441:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6442:          pkgsrc directory.</p></li>
                   6443: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6444:          (not shown above) controls whether we use
1.350     gutterid 6445:          <code class="varname">BUILD_DEPENDS</code> or
1.299     rillig   6446:          <code class="varname">DEPENDS</code> to add the dependency on
                   6447:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6448:          selected by setting
                   6449:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.350     gutterid 6450:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.299     rillig   6451:          used.</p></li>
                   6452: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6453:            and
                   6454:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6455:            (not shown above) are lists of subdirectories of
                   6456:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6457:            to add to the header and library search paths.  These
                   6458:            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>
                   6459:          respectively.</p></li>
                   6460: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6461:            (not shown above) is the list of preprocessor flags to add
                   6462:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6463:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6464:            should be avoided and instead be handled using
                   6465:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6466:          above.</p></li>
                   6467: </ul></div>
                   6468: <p>The following variables are all optionally defined within
                   6469:       this second section (protected against multiple inclusion) and
                   6470:       control which package files are symlinked into
                   6471:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6472:       transformed during the symlinking:</p>
                   6473: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6474: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6475:            (not shown above) is a shell glob pattern relative to
                   6476:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6477:            to be symlinked into
                   6478:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6479:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6480: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6481:            (not shown above) is a shell pipeline that
                   6482:            outputs to stdout a list of files relative to
                   6483:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6484:            The resulting files are to be symlinked
                   6485:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6486:            this takes the <code class="filename">+CONTENTS</code> of a
                   6487:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6488:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6489: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6490:            (not shown above) is a filter command that filters
                   6491:            <code class="filename">+CONTENTS</code> input into a list of files
                   6492:            relative to
                   6493:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6494:            on stdout.  By default,
                   6495:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6496:            outputs the contents of the <code class="filename">include</code>
                   6497:            and <code class="filename">lib</code> directories in the package
                   6498:            <code class="filename">+CONTENTS</code>.</p></li>
                   6499: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6500:            (not shown above) is a list of sed arguments used to
                   6501:            transform the name of the source filename into a
                   6502:            destination filename, e.g. <span class="command"><strong>-e
                   6503:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6504: </ul></div>
                   6505: <p>This section can additionally include any
                   6506:       <code class="filename">buildlink3.mk</code> needed for
                   6507:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6508:       Including these <code class="filename">buildlink3.mk</code> files
                   6509:       means that the headers and libraries for these
                   6510:       dependencies are also symlinked into
                   6511:       <code class="filename">${BUILDLINK_DIR}</code>
                   6512:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6513:       <code class="filename">buildlink3.mk</code>
                   6514:       file is included. Dependencies are only added for directly
                   6515:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6516: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6517:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6518:       please only add necessary ones, i.e., those whose libraries or
                   6519:       header files are automatically exposed when the package is
                   6520:       use.</p>
                   6521: <p>In particular, if only an executable
                   6522:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6523:       library does not need to be propagated in the
                   6524:       <code class="filename">buildlink3.mk</code> file.</p>
                   6525: <p>The following steps should help you decide if a
                   6526:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6527:       </p>
                   6528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6529: <li class="listitem"><p>Look at the installed header files: What
                   6530:        headers do they include? The packages providing these files
                   6531:        must be buildlinked.</p></li>
                   6532: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6533:        libraries and look against what other libraries they link.
                   6534:        Some of the packages providing these probably need to be
                   6535:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6536:        some systems pulls in the X libraries, so they will show up in
                   6537:        the <code class="filename">ldd</code> output, while on others (like OS
                   6538:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6539:        used as a hint.</p></li>
                   6540: </ul></div>
                   6541: <p>
                   6542:       </p>
                   6543: </div>
1.148     asau     6544: <div class="sect2">
1.75      rillig   6545: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6546: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6547:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6548:       and
                   6549:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6550:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6551: <p>Both variables set lower bounds for a version of this package.
                   6552:       The two variables differ in that one describes source
1.299     rillig   6553:       compatibility (API) and the other binary compatibility (ABI).
                   6554:       The difference is that a change in the API breaks compilation of
                   6555:       programs while changes in the ABI stop compiled programs from
                   6556:       running.</p>
1.300     wiz      6557: <p>The
                   6558:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6559:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6560:       changed very rarely.  (One possible scenario: If all packages
                   6561:       using this package need a higher version than defined in the
                   6562:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6563:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6564:       could be updated to that higher version.)</p>
                   6565: <p>On the other hand, changes to
1.299     rillig   6566:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6567:       are more common.  The variable will need to be updated every
                   6568:       time the major version of one of its shared libraries is changed,
                   6569:       or any other change where a binary built against the previous
                   6570:       version of the package will not run against the new version any
                   6571:       longer.</p>
                   6572: <p>In such a case, the package's
1.299     rillig   6573:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6574:       must be increased to require the new package version.  Then the
                   6575:       <code class="varname">PKGREVISION</code> of all packages
                   6576:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6577:       to be increased, and if they have
                   6578:       <code class="filename">buildlink3.mk</code> files,
                   6579:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6580:       in their <code class="filename">buildlink3.mk</code> files must be
                   6581:       increased to the new version as well. This is required so that a
                   6582:       package will pull in the versions of the packages that use the
                   6583:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6584:       uniquely identify the packages built against the new ABI. The
1.322     leot     6585:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.300     wiz      6586:       help with these updates.</p>
                   6587: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, &#8220;Handling dependencies&#8221;</a> for more information
                   6588:       about dependencies on other packages, including the
                   6589:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6590: <p>Please take careful consideration before adjusting
                   6591:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6592:       or
                   6593:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6594:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6595:       cause unneeded package deletions and rebuilds.  In many cases,
                   6596:       new versions of packages work just fine with older
                   6597:       dependencies.</p>
1.326     gutterid 6598: <p>Also, it is not needed to set
1.299     rillig   6599:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6600:       when it is identical to
1.326     gutterid 6601:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6602: <p>Note there is also the distinction that users are able to disable
                   6603:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6604:       variable, but there is no equivalent option for API dependencies.</p>
1.75      rillig   6605: </div>
                   6606: </div>
1.148     asau     6607: <div class="sect1">
1.75      rillig   6608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6609: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6610: <p>Some packages in pkgsrc install headers and libraries that
                   6611:       coincide with headers and libraries present in the base system.
                   6612:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6613:       packages should also include a <code class="filename">builtin.mk</code>
                   6614:       file that includes the necessary checks to decide whether using
                   6615:       the built-in software or the pkgsrc software is
                   6616:     appropriate.</p>
                   6617: <p>The only requirements of a builtin.mk file for
                   6618:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6619: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6620: <li class="listitem"><p>It should set
                   6621:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6622:        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>
                   6623:        after it is included.</p></li>
                   6624: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6625:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6626:        which is already set before the
                   6627:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6628: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6629:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6630:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6631: </ol></div>
                   6632: <div class="sect2">
                   6633: <div class="titlepage"><div><div><h3 class="title">
                   6634: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6635: <p>The following is the recommended template for builtin.mk
                   6636:       files:</p>
1.75      rillig   6637: <pre class="programlisting">
1.299     rillig   6638: .if !defined(IS_BUILTIN.foo)
                   6639: #
                   6640: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6641: # genuinely exists in the system or not.
                   6642: #
                   6643: IS_BUILTIN.foo?=        no
1.100     rillig   6644: 
1.299     rillig   6645: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6646: # version can be determined.
                   6647: #
                   6648: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6649: BUILTIN_PKG.foo?=       foo-1.0
                   6650: .  endif
                   6651: .endif  # IS_BUILTIN.foo
1.100     rillig   6652: 
1.299     rillig   6653: .if !defined(USE_BUILTIN.foo)
                   6654: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6655: .  if defined(BUILTIN_PKG.foo)
                   6656: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6657: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6658: USE_BUILTIN.foo!=                                                       \
                   6659:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6660:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6661: .      endif
                   6662: .    endfor
                   6663: .  endif
                   6664: .endif  # USE_BUILTIN.foo
1.100     rillig   6665: 
1.299     rillig   6666: CHECK_BUILTIN.foo?=     no
                   6667: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6668: #
                   6669: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6670: # "yes" or "no".
                   6671: #
                   6672: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6673: </pre>
1.299     rillig   6674: <p>The first section sets
                   6675:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6676:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6677:       in the base system.  This should not be a base system software
                   6678:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6679:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6680:       included as part of the base system.  This variable is only
                   6681:       used internally within the <code class="filename">builtin.mk</code>
                   6682:       file.</p>
                   6683: <p>The second section sets
                   6684:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6685:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6686:       system if it exists (if
                   6687:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6688:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6689:       within the <code class="filename">builtin.mk</code> file.</p>
                   6690: <p>The third section sets
                   6691:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6692:       and is <span class="emphasis"><em>required</em></span> in all
                   6693:       <code class="filename">builtin.mk</code> files.  The code in this
                   6694:       section must make the determination whether the built-in
                   6695:       software is adequate to satisfy the dependencies listed in
                   6696:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6697:       This is typically done by comparing
                   6698:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6699:       against each of the dependencies in
                   6700:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6701:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6702:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6703:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6704:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6705:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6706:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6707:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6708:       that the built-in version of the software is similar enough to
                   6709:       be used as a replacement.</p>
                   6710: <p>The last section is guarded by
                   6711:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6712:       and includes code that uses the value of
                   6713:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6714:       set in the previous section.  This typically includes, e.g.,
                   6715:       adding additional dependency restrictions and listing additional
                   6716:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6717:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6718: </div>
1.107     rillig   6719: </div>
1.75      rillig   6720: </div>
1.148     asau     6721: <div class="chapter">
1.75      rillig   6722: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6723: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6724: <div class="toc">
                   6725: <p><b>Table of Contents</b></p>
1.210     leot     6726: <dl class="toc">
1.299     rillig   6727: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6728: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6729: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   6730: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6731: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6732: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6733: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6734: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6735: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6736: </dl>
                   6737: </div>
1.299     rillig   6738: <p>The <code class="filename">PLIST</code> file contains a package's
                   6739:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6740:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6741:   directory it's been installed in) plus some additional statements
1.378     leot     6742:   - see the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6743:   This chapter addresses some issues that need attention when
                   6744:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6745:   below!).</p>
1.148     asau     6746: <div class="sect1">
1.75      rillig   6747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6748: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6749: <p>Be sure to add a RCS ID line as the first thing in any
                   6750:     <code class="filename">PLIST</code> file you write:</p>
                   6751: <pre class="programlisting">
                   6752: @comment $NetBSD $
                   6753: </pre>
                   6754: <p>An artificial space has been added between NetBSD and $, this is a
                   6755: workaround here to prevent CVS expanding to the filename of the guide. When
                   6756: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6757: </div>
1.148     asau     6758: <div class="sect1">
1.75      rillig   6759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6760: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6761: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6762:     to output a PLIST that matches any new files since the package
                   6763:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, &#8220;Other helpful targets&#8221;</a> for
                   6764:     more information on this target.</p>
1.75      rillig   6765: </div>
1.148     asau     6766: <div class="sect1">
1.75      rillig   6767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6768: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6769: </h2></div></div></div>
                   6770: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6771:     of AWK patterns and actions that are used to filter the output of
                   6772:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6773:     scripting you like to it, but be careful with quoting.</p>
                   6774: <p>For example, to get all files inside the
                   6775:     <code class="filename">libdata/foo</code> directory removed from the
                   6776:     resulting PLIST:</p>
1.88      wiz      6777: <pre class="programlisting">
1.299     rillig   6778: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6779: </pre>
1.300     wiz      6780: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6781:     evaluated after the file list and directory list are sorted.
                   6782:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6783:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6784:     list and directory list are sorted.</p>
1.299     rillig   6785: </div>
                   6786: <div class="sect1">
                   6787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6788: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6789: <p>A number of variables are substituted automatically in
                   6790:     PLISTs when a package is installed on a system. This includes the
                   6791:     following variables:</p>
                   6792: <div class="variablelist"><dl class="variablelist">
                   6793: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6794: <dd>
                   6795: <p>Some packages like emacs and perl embed information
                   6796:          about which architecture they were built on into the
                   6797:          pathnames where they install their files. To handle this
                   6798:          case, PLIST will be preprocessed before actually used, and
                   6799:          the symbol
                   6800:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6801:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6802:          same is done if the string
                   6803:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6804:          PLIST somewhere - use this on packages that have GNU
                   6805:          autoconf-created configure scripts.</p>
                   6806: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6807: <h3 class="title">Legacy note</h3>
                   6808: <p>There used to be a symbol
                   6809:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6810:            was replaced by the output of <span class="command"><strong>uname
                   6811:            -m</strong></span>, but that's no longer supported and has
                   6812:            been removed.</p>
                   6813: </div>
                   6814: </dd>
                   6815: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6816: <dd>
                   6817: <p>Some packages want to embed the OS name and version
                   6818:          into some paths.  To do this, use these variables in the
                   6819:          <code class="filename">PLIST</code>:
                   6820:          </p>
                   6821: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6822: <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>
                   6823: <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>
                   6824: <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>
                   6825: </ul></div>
                   6826: </dd>
                   6827: </dl></div>
                   6828: <p>For a list of values which are replaced by
                   6829:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6830: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6831: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6832: <p>If you want to change other variables not listed above, you
                   6833:     can add variables and their expansions to this variable in the
                   6834:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, &#8220;Optional files&#8221;</a>):</p>
1.81      rillig   6835: <pre class="programlisting">
1.299     rillig   6836: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6837: </pre>
1.299     rillig   6838: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6839:     in the <code class="filename">PLIST</code> with
                   6840:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6841: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6842:     the common case of conditionally including some
                   6843:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6844:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6845:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6846:     to <code class="literal">yes</code> if the entry should be included.
                   6847:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6848:     in the <code class="filename">PLIST</code> with either
                   6849:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6850:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6851:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6852: <pre class="programlisting">
1.299     rillig   6853: PLIST_VARS+=    foo
                   6854: .if <em class="replaceable"><code>condition</code></em>
                   6855: PLIST.foo=      yes
                   6856: .else
1.174     asau     6857: </pre>
1.299     rillig   6858: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6859: <pre class="programlisting">
1.299     rillig   6860: @comment $NetBSD $
                   6861: bin/bar
                   6862: man/man1/bar.1
                   6863: ${PLIST.foo}bin/foo
                   6864: ${PLIST.foo}man/man1/foo.1
                   6865: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6866: </pre>
1.299     rillig   6867: <p>An artificial space has been added between NetBSD and $, this is a
                   6868: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6869: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6870: </div>
1.299     rillig   6871: <div class="sect1">
                   6872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6873: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6874: <p>Man pages should be installed in compressed form if
                   6875:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6876:     and uncompressed otherwise. To handle this in the
                   6877:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6878:     appended/removed automatically for man pages according to
                   6879:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6880:     or not, see above for details. This modification of the
                   6881:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6882:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6883: </div>
1.148     asau     6884: <div class="sect1">
1.75      rillig   6885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6886: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6887: </h2></div></div></div>
                   6888: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6889:     in generating the binary package, set the variable
                   6890:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.378     leot     6891:     The files are later concatenated using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6892:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6893:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6894: </div>
1.148     asau     6895: <div class="sect1">
1.75      rillig   6896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6897: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6898: <p>Some packages decide to install a different set of files based on
                   6899:     the operating system being used. These differences can be
                   6900:     automatically handled by using the following files:</p>
                   6901: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6902: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6903: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6904: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6905: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6906: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6907: </ul></div>
1.75      rillig   6908: </div>
1.148     asau     6909: <div class="sect1">
1.75      rillig   6910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6911: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6912: <p>Some packages decide to generate hard-to-guess file names
                   6913:     during installation that are hard to wire down.</p>
                   6914: <p>In such cases, you can set the
                   6915:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6916:     terminated (with a semicolon) that will output PLIST entries which
                   6917:     will be appended to the PLIST</p>
                   6918: <p>You can find one example in editors/xemacs:</p>
                   6919: <pre class="programlisting">
                   6920: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6921: </pre>
                   6922: <p>which will append something like
                   6923:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6924:     <code class="filename">PLIST</code>.
                   6925:     </p>
1.75      rillig   6926: </div>
1.148     asau     6927: <div class="sect1">
1.75      rillig   6928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6929: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6930: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6931:     multiple (and unrelated) packages install files.  These
                   6932:     directories were problematic because you had to add special
                   6933:     tricks in the PLIST to conditionally remove them, or have some
                   6934:     centralized package handle them.</p>
                   6935: <p>In pkgsrc, it is now easy: Each package should create
                   6936:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6937:     will remove any directories left empty after uninstalling a
                   6938:     package.</p>
                   6939: <p>If a package needs an empty directory to work, create
                   6940:     the directory during installation as usual, and also add an
                   6941:     entry to the PLIST:
                   6942: 
                   6943: </p>
                   6944: <pre class="programlisting">
                   6945: @pkgdir path/to/empty/directory
                   6946: </pre>
                   6947: <p>
                   6948: 
                   6949:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6950:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6951:     </p>
1.75      rillig   6952: </div>
1.299     rillig   6953: </div>
                   6954: <div class="chapter">
                   6955: <div class="titlepage"><div><div><h2 class="title">
                   6956: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6957: <div class="toc">
                   6958: <p><b>Table of Contents</b></p>
                   6959: <dl class="toc">
                   6960: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6961: <dd><dl>
                   6962: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6963: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6964: </dl></dd>
                   6965: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6966: <dd><dl>
                   6967: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6968: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353     dholland 6969: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   6970: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   6971: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   6972: </dl></dd>
                   6973: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6974: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   6975: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6976: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6977: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6978: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6979: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   6980: </dl>
                   6981: </div>
                   6982: <p>This chapter describes the framework known as
                   6983: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6985: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6986:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6987: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6988:     provided that packages are correctly designed.</p></li>
                   6989: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6990: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6991: <li class="listitem"><p>Registration of system shells.</p></li>
                   6992: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6993: </ul></div>
                   6994: <p>The following sections inspect each of the above points in detail.</p>
                   6995: <p>You may be thinking that many of the things described here could be
                   6996: easily done with simple code in the package's post-installation target
                   6997: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6998: as the code in them is only executed when building from source.  Machines
                   6999: using binary packages could not benefit from it at all (as the code itself
                   7000: could be unavailable).  Therefore, the only way to achieve any of the items
                   7001: described above is by means of the installation scripts, which are
                   7002: automatically generated by pkginstall.</p>
1.148     asau     7003: <div class="sect1">
1.75      rillig   7004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7005: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   7006: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   7007: of files and directories that belong to a package.  The names used in it
                   7008: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   7009: which means that it cannot register files outside this directory (absolute
                   7010: path names are not allowed).  Despite this restriction, some packages need
                   7011: to install files outside this location; e.g., under
                   7012: <code class="filename">${VARBASE}</code> or
                   7013: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   7014: is to create such files during installation time by using
                   7015: installation scripts.</p>
                   7016: <p>The generic installation scripts are shell scripts that can
                   7017: contain arbitrary code.  The list of scripts to execute is taken from
                   7018: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   7019: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   7020: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   7021: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   7022: commands, so they have the potential to create and manage files
                   7023: anywhere in the file system.</p>
                   7024: <p>Using these general installation files is not recommended, but
                   7025: may be needed in some special cases.  One reason for avoiding them is
                   7026: that the user has to trust the packager that there is no unwanted or
                   7027: simply erroneous code included in the installation script. Also,
                   7028: previously there were many similar scripts for the same functionality,
                   7029: and fixing a common error involved finding and changing all of
                   7030: them.</p>
                   7031: <p>The pkginstall framework offers another, standardized way.  It
                   7032: provides generic scripts to abstract the manipulation of such files
                   7033: and directories based on variables set in the package's
                   7034: <code class="filename">Makefile</code>.  The rest of this section describes
                   7035: these variables.</p>
                   7036: <div class="sect2">
                   7037: <div class="titlepage"><div><div><h3 class="title">
                   7038: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   7039: <p>The following variables can be set to request the creation of
                   7040: directories anywhere in the file system:</p>
                   7041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7042: <li class="listitem">
                   7043: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   7044:     contain a list of directories that should be created and should attempt
                   7045:     to be destroyed by the installation scripts.  The difference between
                   7046:     the two is that the latter prompts the administrator to remove any
                   7047:     directories that may be left after deinstallation (because they were
                   7048:     not empty), while the former does not.  Example:</p>
                   7049: <pre class="programlisting">
                   7050: MAKE_DIRS+=             ${VARBASE}/foo/private
                   7051: </pre>
                   7052: </li>
                   7053: <li class="listitem">
                   7054: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   7055:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   7056:     which directories should be created and should attempt to be destroyed
                   7057:     by the installation scripts.  Each tuple holds the following values,
                   7058:     separated by spaces: the directory name, its owner, its group and its
                   7059:     numerical mode.  For example:</p>
                   7060: <pre class="programlisting">
                   7061: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   7062:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   7063: </pre>
                   7064: <p>The difference between the two is exactly the same as their
                   7065:     non-<code class="varname">PERMS</code> counterparts.</p>
                   7066: </li>
                   7067: </ul></div>
1.75      rillig   7068: </div>
1.299     rillig   7069: <div class="sect2">
                   7070: <div class="titlepage"><div><div><h3 class="title">
                   7071: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   7072: <p>Creating non-empty files outside the installation prefix is tricky
                   7073: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.353     dholland 7074: To overcome this problem, the only solution is to extract the file in a
1.299     rillig   7075: known place (i.e., inside the installation prefix) and copy it to the
                   7076: appropriate location during installation (done by the installation scripts
1.353     dholland 7077: generated by pkginstall).  We will call the former the <span class="emphasis"><em>reference
1.299     rillig   7078: file</em></span> in the following paragraphs, which describe the variables
                   7079: that can be used to automatically and consistently handle files outside the
                   7080: installation prefix:</p>
                   7081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.353     dholland 7082: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
                   7083:     and target files.  At installation time, the reference file is copied
                   7084:     to the target if and only if the latter does not exist.  Upon
                   7085:     deinstallation, the reference file is removed provided that it was
                   7086:     not modified by the installation.</p></li>
1.299     rillig   7087: <li class="listitem">
1.353     dholland 7088: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
                   7089:     reference files and targets, including owner, group, and numeric
                   7090:     permissions that should be set. For example:</p>
1.88      wiz      7091: <pre class="programlisting">
1.299     rillig   7092: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   7093:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   7094: </pre>
1.299     rillig   7095: </li>
1.353     dholland 7096: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
                   7097:     <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
                   7098:     <code class="varname">REQD_FILES</code> and
                   7099:     <code class="varname">REQD_FILES_PERMS</code> respectively.  The difference
                   7100:     is that these variables are specifically intended for handling
                   7101:     configuration files, for which additional conventions and
                   7102:     constraints apply.  See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, &#8220;Configuration files&#8221;</a> for further
                   7103:     discussion.  Note in particular that while handling of
                   7104:     configuration files can be disabled by the user (see <a class="xref" href="#conf-files-disable" title="20.2.5. Disabling handling of configuration files">Section 20.2.5, &#8220;Disabling handling of configuration files&#8221;</a>), this setting does not affect
                   7105:     <code class="varname">REQD_FILES</code> and
                   7106:     <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.299     rillig   7107: </ul></div>
1.353     dholland 7108: <p>To install an empty file, one can use these macros and
                   7109:   <code class="filename">/dev/null</code> as the reference file.</p>
1.299     rillig   7110: </div>
1.75      rillig   7111: </div>
1.148     asau     7112: <div class="sect1">
1.75      rillig   7113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7114: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.353     dholland 7115: <p>There are two principles that govern the handling of
                   7116: configuration files in pkgsrc: first, the user's configuration must
                   7117: not be lost or overwritten by upgrades or reinstallations; and second,
                   7118: the default configuration should always be available for reference.
                   7119: To that end, pkgsrc has a framework specifically for handling
                   7120: configuration files.  In general, configuration files are installed
                   7121: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
                   7122: there to the pertinent <code class="filename">etc</code> directory as a
                   7123: separate step and only as needed.</p>
                   7124: <p>To make this work, there are three things that need to happen,
                   7125: any of which may require patching.  First, the package must be told to
                   7126: read its configuration from the correct place at runtime; this place
                   7127: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
                   7128: of it) which is often but not always
                   7129: <code class="filename">${PREFIX}/etc</code>.  Second, the package must be
                   7130: taught to install its default configuration files in
                   7131: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
                   7132: point at which patching often becomes required because it is not the
                   7133: same place as the runtime location.  Third, the configuration files
                   7134: need to be declared in the package makefile; this is the easy part.
                   7135: </p>
                   7136: <p>With those elements in place, the right things will happen: the
                   7137: package install phase and resulting binary package will not touch
                   7138: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
                   7139: will be copied into place by the pkgsrc framework only if not already
                   7140: present.  Similarly, upon deinstall the configuration will not be
                   7141: removed if it has been modified.  (This means that in the case of
                   7142: reinstallation and upgrades, unmodified configuration files are
                   7143: updated but modifications are never discarded.)</p>
                   7144: <p>The following sections describe how to make these things happen
                   7145: and document other relevant knobs available in the pkgsrc
                   7146: infrastructure.</p>
1.299     rillig   7147: <div class="sect2">
                   7148: <div class="titlepage"><div><div><h3 class="title">
                   7149: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   7150: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7151: specifies where configuration files shall be installed.  Its contents are
                   7152: set based upon the following variables:</p>
                   7153: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7154: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7155:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.353     dholland 7156:     be overridden by the user to point to their preferred location (e.g.,
1.299     rillig   7157:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7158:     Packages must not use it directly.</p></li>
                   7159: <li class="listitem">
                   7160: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7161:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7162:     for the package being built shall be installed.  The definition of this
                   7163:     variable only makes sense in the package's
                   7164:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7165: <p>As an example, consider the Apache package,
1.322     leot     7166:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.299     rillig   7167:     configuration files under the
                   7168:     <code class="filename">httpd/</code> subdirectory of
                   7169:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7170:     Makefile.</p>
                   7171: </li>
                   7172: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7173:     variable that holds this package's configuration directory (if
                   7174:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7175:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7176:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7177: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7178:     directory where the configuration files for the package identified by
                   7179:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7180: </ul></div>
                   7181: <p>Based on the above variables, pkginstall determines the value of
                   7182: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.353     dholland 7183: variable that may be used within a package to refer to its configuration
1.299     rillig   7184: directory.  The algorithm used to set its value is basically the
                   7185: following:</p>
                   7186: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7187: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7188:     its value is used.</p></li>
                   7189: <li class="listitem"><p>If the previous variable is not defined but
                   7190:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7191:     <code class="filename">Makefile</code>, the resulting value is
                   7192:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7193: <li class="listitem"><p>Otherwise, it is set to
                   7194:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7195: </ol></div>
                   7196: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.353     dholland 7197: automatically added to <code class="filename">OWN_DIRS</code>.  This causes it
                   7198: to be automatically created if needed.  See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, &#8220;Directory manipulation&#8221;</a> for further details.  This does not apply to
                   7199: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
                   7200: created with <code class="varname">OWN_DIRS</code> or
                   7201: <code class="varname">MAKE_DIRS</code>.</p>
1.299     rillig   7202: </div>
                   7203: <div class="sect2">
                   7204: <div class="titlepage"><div><div><h3 class="title">
                   7205: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7206: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.353     dholland 7207: known place, you need to teach each package where to install its files.  In
                   7208: some cases you will have to patch the package Makefiles to achieve it.  If
                   7209: you are lucky, though, it may be as easy as passing an extra flag to the
                   7210: configuration script.  This is the case for packages using GNU
                   7211: autoconf:</p>
1.75      rillig   7212: <pre class="programlisting">
1.299     rillig   7213: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7214: </pre>
1.299     rillig   7215: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.353     dholland 7216: for</em></span> its configuration files, not where they will be installed.
                   7217: Fortunately, there is a different way to specify the latter, as seen
1.354     gutterid 7218: in the next section, although the combination is rather confusing at
1.353     dholland 7219: first glance.</p>
1.75      rillig   7220: </div>
1.299     rillig   7221: <div class="sect2">
                   7222: <div class="titlepage"><div><div><h3 class="title">
1.353     dholland 7223: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
                   7224: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.299     rillig   7225: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7226: directly</strong></span>.  Bad news is that many software installation scripts
                   7227: will, out of the box, mess with the contents of that directory.  So what is
                   7228: the correct procedure to fix this issue?</p>
                   7229: <p>You must teach the package (usually by manually patching it) to
                   7230: install any configuration files under the examples hierarchy,
                   7231: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7232: <code class="filename">PLIST</code> registers them and the administrator always
                   7233: has the original copies available.</p>
1.353     dholland 7234: <p>It turns out that for packages using GNU autoconf it is possible
                   7235: to create the desired effect by setting <code class="varname">sysconfdir</code>
                   7236: on the make command line at install time.  Consider this example taken
                   7237: from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a>:</p>
                   7238: <pre class="programlisting">
                   7239: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7240: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
                   7241: </pre>
                   7242: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
                   7243: used for this purpose, is local to that package and has no meaning
                   7244: outside it.</p>
                   7245: </div>
                   7246: <div class="sect2">
                   7247: <div class="titlepage"><div><div><h3 class="title">
                   7248: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.299     rillig   7249: <p>Once the required configuration files are in place (i.e., under the
1.353     dholland 7250: examples hierarchy), the pkginstall framework can use them as reference copies
1.299     rillig   7251: during the package installation to update what is in
                   7252: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7253: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.353     dholland 7254: used.  Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, &#8220;File manipulation&#8221;</a> for further
                   7255: information about their syntax and their purpose.  Here is an example,
                   7256: taken from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
                   7257: <pre class="programlisting">
                   7258: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7259: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7260: </pre>
                   7261: <p>Note that (as in the previous section's example) the
                   7262: <code class="varname">EGDIR</code> variable is specific to the package and has
                   7263: no meaning outside it.</p>
                   7264: <p>For reference, the complete example from Mutt is as follows:</p>
1.88      wiz      7265: <pre class="programlisting">
1.353     dholland 7266: CONFIGURE_ARGS+=        --sysconfdir=${PKG_SYSCONFDIR}
                   7267: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7268: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7269: INSTALLATION_DIRS+=     ${EGDIR}
                   7270: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.100     rillig   7271: </pre>
1.75      rillig   7272: </div>
1.299     rillig   7273: <div class="sect2">
                   7274: <div class="titlepage"><div><div><h3 class="title">
1.353     dholland 7275: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.299     rillig   7276: <p>The automatic copying of config files can be toggled by setting the
                   7277: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7278: installation.</p>
1.88      wiz      7279: </div>
1.75      rillig   7280: </div>
1.148     asau     7281: <div class="sect1">
1.75      rillig   7282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7283: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7284: <p>System startup scripts are special files because they must be
                   7285: installed in a place known by the underlying OS, usually outside the
                   7286: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
                   7287: can be used.  However, pkginstall provides a special mechanism to handle
                   7288: these files.</p>
                   7289: <p>In order to provide system startup scripts, the package has
                   7290: to:</p>
                   7291: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7292: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7293:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.338     nia      7294:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups-base/index.html" target="_top"><code class="filename">print/cups-base</code></a> package as an example, it
                   7295:     has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299     rillig   7296: <li class="listitem">
                   7297: <p>Tell pkginstall to handle it, appending the name of the script,
                   7298:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7299:     Continuing the previous example:</p>
                   7300: <pre class="programlisting">
                   7301: RCD_SCRIPTS+=   cupsd
                   7302: </pre>
                   7303: </li>
                   7304: </ol></div>
                   7305: <p>Once this is done, pkginstall will do the following steps for each
                   7306: script in an automated fashion:</p>
                   7307: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7308: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7309:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7310:     variable.</p></li>
                   7311: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7312:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.353     dholland 7313:     that this reference file must be explicitly registered in the
1.299     rillig   7314:     <code class="filename">PLIST</code>.</p></li>
                   7315: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7316:     from the examples hierarchy into the system-wide startup scripts
                   7317:     directory.</p></li>
                   7318: </ol></div>
                   7319: <div class="sect2">
                   7320: <div class="titlepage"><div><div><h3 class="title">
                   7321: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7322: <p>The automatic copying of config files can be toggled by setting the
                   7323: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7324: installation.  Note that the scripts will be always copied inside the
                   7325: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7326: matter what the value of this variable is.</p>
1.75      rillig   7327: </div>
                   7328: </div>
1.299     rillig   7329: <div class="sect1">
                   7330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7331: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7332: <p>If a package needs to create special users and/or groups during
                   7333: installation, it can do so by using the pkginstall framework.</p>
                   7334: <p>Users can be created by adding entries to the
                   7335: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7336: syntax:</p>
                   7337: <pre class="programlisting">
                   7338: user:group
                   7339: </pre>
                   7340: <p>Further specification of user details may be done by setting
                   7341: per-user variables.
                   7342: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7343: numeric UID for the user.
                   7344: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7345: user's description or comment.
                   7346: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7347: user's home directory, and defaults to
                   7348: <code class="filename">/nonexistent</code> if not specified.
                   7349: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7350: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7351: not specified.</p>
                   7352: <p>Similarly, groups can be created by adding entries to the
                   7353: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7354: <pre class="programlisting">
                   7355: group
                   7356: </pre>
                   7357: <p>The numeric GID of the group may be set by defining
                   7358: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7359: <p>If a package needs to create the users and groups at an earlier
                   7360: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7361: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7362: <code class="literal">pre-install</code> to indicate the phase before which the
                   7363: users and groups are created. In this case, the numeric UIDs and GIDs
                   7364: of the created users and groups are automatically hardcoded into the
                   7365: final installation scripts.</p>
1.75      rillig   7366: </div>
1.148     asau     7367: <div class="sect1">
1.75      rillig   7368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7369: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7370: <p>Packages that install system shells should register them in the shell
                   7371: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7372: administrator.  This must be done from the installation scripts to keep
                   7373: binary packages working on any system.  pkginstall provides an easy way to
                   7374: accomplish this task.</p>
                   7375: <p>When a package provides a shell interpreter, it has to set the
                   7376: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7377: add some hooks to the installation scripts to handle it.  Consider the
1.322     leot     7378: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.299     rillig   7379: <pre class="programlisting">
                   7380: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7381: </pre>
                   7382: <div class="sect2">
                   7383: <div class="titlepage"><div><div><h3 class="title">
                   7384: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7385: <p>The automatic registration of shell interpreters can be disabled by
                   7386: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7387: environment variable to <code class="literal">NO</code>.</p>
                   7388: </div>
1.75      rillig   7389: </div>
1.148     asau     7390: <div class="sect1">
1.75      rillig   7391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7392: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7393: <p>Packages that install X11 fonts should update the database files
                   7394: that index the fonts within each fonts directory.  This can easily be
                   7395: accomplished within the pkginstall framework.</p>
                   7396: <p>When a package installs X11 fonts, it must list the directories in
                   7397: which fonts are installed in the
                   7398: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7399: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7400: <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
                   7401: installation scripts to run the appropriate commands to update the fonts
                   7402: database files within each of those directories.  For convenience, if the
                   7403: directory path is relative, it is taken to be relative to the package's
1.322     leot     7404: installation prefix.  Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   7405: <pre class="programlisting">
1.299     rillig   7406: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7407: </pre>
1.299     rillig   7408: <div class="sect2">
                   7409: <div class="titlepage"><div><div><h3 class="title">
                   7410: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7411: <p>The automatic update of fonts databases can be disabled by
                   7412: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7413: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7414: </div>
                   7415: </div>
                   7416: </div>
1.148     asau     7417: <div class="chapter">
1.75      rillig   7418: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7419: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7420: <div class="toc">
                   7421: <p><b>Table of Contents</b></p>
1.210     leot     7422: <dl class="toc">
1.267     rillig   7423: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7424: <dd><dl>
1.267     rillig   7425: <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>
                   7426: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7427: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7428: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7429: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7430: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7431: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7432: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7433: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7434: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7435: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7436: </dl></dd>
                   7437: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7438: <dd><dl>
                   7439: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7440: <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>
                   7441: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7442: </dl></dd>
                   7443: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7444: <dd><dl>
                   7445: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7446: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7447: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      7448: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      7449: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   7450: </dl></dd>
                   7451: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7452: <dd><dl>
                   7453: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7454: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      7455: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      7456: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   7457: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   7458: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   7459: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   7460: </dl></dd>
                   7461: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7462: <dd><dl>
                   7463: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7464: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7465: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7466: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   7467: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7468: </dl></dd>
                   7469: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7470: <dd><dl>
                   7471: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7472: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7473: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7474: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7475: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      7476: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      7477: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   7478: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   7479: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   7480: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   7481: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   7482: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   7483: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   7484: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   7485: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   7486: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      7487:     emulation</a></span></dt>
1.369     wiz      7488: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   7489: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.75      rillig   7490: </dl></dd>
1.267     rillig   7491: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7492: </dl>
                   7493: </div>
1.148     asau     7494: <div class="sect1">
1.75      rillig   7495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7496: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7497: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7498:   different platforms. As a result, it is important to ensure,
                   7499:   where possible, that packages in pkgsrc are portable. This
                   7500:   chapter mentions some particular details you should pay
                   7501:   attention to while working on pkgsrc.</p>
1.148     asau     7502: <div class="sect2">
1.78      rillig   7503: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7504: <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   7505: </h3></div></div></div>
1.78      rillig   7506: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7507:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7508:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7509:     want to use those variables in the preprocessor directives of
1.378     leot     7510:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7511:     <code class="literal">.for</code>), you need to include the file
                   7512:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7513:     loads the user preferences.</p>
1.78      rillig   7514: <p>But note that some variables may not be completely defined
1.219     rillig   7515:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7516:     included, as they may contain references to variables that are
                   7517:     not yet defined. In shell commands (the lines in
                   7518:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7519:     is no problem, since variables are only expanded when they are
                   7520:     used. But in the preprocessor directives mentioned above and in
                   7521:     dependency lines (of the form <code class="literal">target:
                   7522:     dependencies</code>) the variables are expanded at load
                   7523:     time.</p>
1.148     asau     7524: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7525: <h3 class="title">Note</h3>
1.218     rillig   7526: <p>To check whether a variable can be used at load time,
                   7527:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7528: </div>
                   7529: </div>
1.148     asau     7530: <div class="sect2">
1.78      rillig   7531: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7532: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7533: <p>Occasionally, packages require interaction from the user,
                   7534:     and this can be in a number of ways:</p>
1.148     asau     7535: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7536: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7537:        interaction such as entering username/password or accepting a
                   7538:        license on a web page.</p></li>
1.128     wiz      7539: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7540:        passwords.</p></li>
1.128     wiz      7541: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7542: <li class="listitem"><p>help during the build process</p></li>
                   7543: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7544: </ul></div>
1.218     rillig   7545: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7546:     variable to define which stages need interaction. This should be
                   7547:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7548: <pre class="programlisting">
1.100     rillig   7549: INTERACTIVE_STAGE=      configure install
1.222     sevan    7550: </pre>
1.88      wiz      7551: <p>The user can then decide to skip this package by setting the
1.218     rillig   7552:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7553:     are also excluded from bulk builds.</p>
1.75      rillig   7554: </div>
1.148     asau     7555: <div class="sect2">
1.75      rillig   7556: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7557: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7558: <p>Authors of software can choose the licence under which software
                   7559:     can be copied.  The Free Software Foundation has declared some
                   7560:     licenses "Free", and the Open Source Initiative has a definition of
                   7561:     "Open Source".</p>
                   7562: <p>By default, pkgsrc allows packages with Free or Open Source
                   7563:     licenses to be built.  To allow packages with other licenses to be
                   7564:     built as well, the pkgsrc user needs to add these licenses to the
                   7565:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7566:     that this variable only affects which packages may be
                   7567:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7568:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7569: <p>One might want to only install packages with a BSD license,
1.218     rillig   7570:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7571:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7572:     user can override the default by setting the
                   7573:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7574:     of "+=".  The licenses accepted by default are defined in the
                   7575:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7576:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7577: <p>The license tag mechanism is intended to address
1.87      wiz      7578:     copyright-related issues surrounding building, installing and
                   7579:     using a package, and not to address redistribution issues (see
                   7580:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7581:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7582:     Packages with redistribution restrictions should set these
                   7583:     tags.</p>
1.98      wiz      7584: <p>Denoting that a package may be copied according to a
                   7585:     particular license is done by placing the license in
1.87      wiz      7586:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7587:     <code class="varname">LICENSE</code> variable to a string identifying the
1.322     leot     7588:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7589: <pre class="programlisting">
1.100     rillig   7590: LICENSE=        xv-license
1.222     sevan    7591: </pre>
1.87      wiz      7592: <p>When trying to build, the user will get a notice that the
1.98      wiz      7593:     package is covered by a license which has not been placed in the
                   7594:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7595: <pre class="programlisting">
1.100     rillig   7596: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7597: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7598: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7599: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7600: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7601: *** Error code 1
1.222     sevan    7602: </pre>
1.379     wiz      7603: <p>In case a package requires multiple licenses, you can add all of
                   7604:     them to the LICENSE variable, connected with the upper-case keyword
                   7605:     <code class="varname">AND</code>. If the user has a choice between multiple
                   7606:     licenses, you can add them connected with the upper-case keyword
                   7607:     <code class="varname">OR</code>, for example:</p>
                   7608: <pre class="programlisting">
                   7609: LICENSE=        isc AND apache-2.0
                   7610: LICENSE=        2-clause-bsd OR ruby-license
                   7611: </pre>
1.110     hubertf  7612: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7613:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7614:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7615:     convey to pkgsrc that it should not in the future fail because of
                   7616:     that license:</p>
1.78      rillig   7617: <pre class="programlisting">
1.100     rillig   7618: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7619: </pre>
                   7620: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7621:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7622:     is deprecated because it does not crisply refer to a particular
                   7623:     license text.  Another problem with such usage is that it does not
                   7624:     enable a user to tell pkgsrc to proceed for a single package
                   7625:     without also telling pkgsrc to proceed for all packages with that
                   7626:     tag.</p>
                   7627: <div class="sect3">
                   7628: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7629: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7630: <p>When adding a package with a new license, the following steps
                   7631:     are required:</p>
                   7632: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7633: <li class="listitem">
1.284     rillig   7634: <p>Check whether the license qualifies as Free or Open Source by
                   7635:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7636:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7637:     Open Source Initiative</a>.  If this is the case, the filename in
                   7638:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7639:     <code class="filename">-license</code> suffix, and the license name should be
                   7640:     added to:</p>
1.154     rodent   7641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7642: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7643:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7644: <li class="listitem"><p>default_acceptable_licenses in
                   7645:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7646: </ul></div>
                   7647: </li>
1.284     rillig   7648: <li class="listitem"><p>The license text should be added to
                   7649:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7650:     licenses can be seen in this directory.</p></li>
1.154     rodent   7651: </ol></div>
1.222     sevan    7652: </div>
                   7653: <div class="sect3">
                   7654: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7655: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7656: <p>When the license changes (in a way other than formatting),
1.222     sevan    7657:     make sure that the new license has a different name (e.g.,
1.98      wiz      7658:     append the version number if it exists, or the date).  Just
                   7659:     because a user told pkgsrc to build programs under a previous
                   7660:     version of a license does not mean that pkgsrc should build
1.99      rillig   7661:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7662:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7663:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7664:     approved by either of two bodies (FSF or OSI).</p>
                   7665: </div>
1.75      rillig   7666: </div>
1.148     asau     7667: <div class="sect2">
1.75      rillig   7668: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7669: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7670: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7671:     By declaring the restrictions, package tools can
1.98      wiz      7672:     automatically refrain from e.g. placing binary packages on FTP
                   7673:     sites.</p>
1.222     sevan    7674: <p>There are four possible restrictions, which are
1.98      wiz      7675:     the cross product of sources (distfiles) and binaries not being
                   7676:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7677:     language in any license, and because non-Free licenses tend to be
                   7678:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7679:     CD-ROM.
                   7680: 
                   7681:     "FTP" means making the source or binary file available over the
                   7682:     Internet at no charge.
                   7683: 
                   7684:     "CD-ROM" means making the source or binary available on some kind of
                   7685:     media, together with other source and binary packages, which is sold
                   7686:     for a distribution charge.
1.98      wiz      7687:     </p>
                   7688: <p>In order to encode these restrictions, the package system
1.87      wiz      7689:     defines five make variables that can be set to note these
                   7690:     restrictions:</p>
1.148     asau     7691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7692: <li class="listitem">
1.75      rillig   7693: <p><code class="varname">RESTRICTED</code></p>
                   7694: <p>This variable should be set whenever a restriction
1.87      wiz      7695:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7696:        string containing the reason for the restriction.  It should
                   7697:        be understood that those wanting to understand the restriction
                   7698:        will have to read the license, and perhaps seek advice of
                   7699:        counsel.</p>
1.75      rillig   7700: </li>
1.128     wiz      7701: <li class="listitem">
1.75      rillig   7702: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7703: <p>Binaries may not be placed on CD-ROM containing other
                   7704:        binary packages, for which a distribution charge may be made.
                   7705:        In this case, set this variable to
                   7706:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7707: </li>
1.128     wiz      7708: <li class="listitem">
1.75      rillig   7709: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7710: <p>Binaries may not made available on the Internet without
                   7711:        charge.  In this case, set this variable to
                   7712:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7713:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7714: </li>
1.128     wiz      7715: <li class="listitem">
1.75      rillig   7716: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7717: <p>Distfiles may not be placed on CD-ROM, together with
                   7718:        other distfiles, for which a fee may be charged.  In this
                   7719:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7720:        </p>
1.75      rillig   7721: </li>
1.128     wiz      7722: <li class="listitem">
1.75      rillig   7723: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7724: <p>Distfiles may not made available via FTP at no charge.
                   7725:        In this case, set this variable to
                   7726:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7727:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7728: </li>
                   7729: </ul></div>
1.222     sevan    7730: <p>Please note that packages will be removed from pkgsrc when the
                   7731:     distfiles are not distributable and cannot be obtained for a period
                   7732:     of one full quarter branch. Packages with manual/interactive fetch
                   7733:     must have a maintainer and it is his/her responsibility to ensure
                   7734:     this.</p>
1.75      rillig   7735: </div>
1.148     asau     7736: <div class="sect2">
1.75      rillig   7737: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7738: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7739: <p>Your package may depend on some other package being present,
                   7740:     and there are various ways of expressing this dependency.
                   7741:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7742:     <code class="varname">BUILD_DEPENDS</code>,
                   7743:     <code class="varname">TOOL_DEPENDS</code>, and
                   7744:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7745:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7746:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7747:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7748:     See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.290     gutterid 7749: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7750:     definition registers that pre-requisite in the binary package so it
                   7751:     will be pulled in when the binary package is later installed, whilst
                   7752:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7753:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7754:     dependency that is only needed for building or testing the resulting
1.299     rillig   7755:     package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.75      rillig   7756: <p>This means that if you only need a package present whilst
1.290     gutterid 7757:     you are building or testing, it should be noted as a
                   7758:     <code class="varname">TOOL_DEPENDS</code>,
                   7759:     <code class="varname">BUILD_DEPENDS</code>, or
                   7760:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7761:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7762:     packages, i.e. packages for the architecture where the package
                   7763:     is built;
                   7764:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7765:     packages, i.e., packages for the architecture for which the package
1.269     leot     7766:     is built.</p>
1.290     gutterid 7767: <p>The format for a <code class="varname">DEPENDS</code>,
                   7768:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7769:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7770: <pre class="programlisting">
1.100     rillig   7771: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7772: </pre>
1.128     wiz      7773: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7774:     may include any of the wildcard version numbers recognized by
1.378     leot     7775:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7776: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7777: <li class="listitem">
1.75      rillig   7778: <p>If your package needs another package's binaries or
1.160     wiz      7779:        libraries to build and run, and if that package has a
1.87      wiz      7780:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7781: <pre class="programlisting">
1.100     rillig   7782: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7783: </pre>
1.75      rillig   7784: </li>
1.128     wiz      7785: <li class="listitem">
1.160     wiz      7786: <p>If your package needs another package's binaries or
                   7787:        libraries only for building, and if that package has a
                   7788:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7789: <pre class="programlisting">
                   7790: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7791: </pre>
1.160     wiz      7792: <p>but set
                   7793:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7794:        to make it a build dependency only. This case is rather
                   7795:        rare.</p>
                   7796: </li>
                   7797: <li class="listitem">
1.132     spz      7798: <p>If your package needs binaries from another package to build,
1.269     leot     7799:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7800: <pre class="programlisting">
1.269     leot     7801: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7802: </pre>
1.75      rillig   7803: </li>
1.269     leot     7804: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7805:        files to include, etc. from another package to build,
                   7806:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7807: <li class="listitem"><p>If your package needs a library with which to link and
                   7808:        there is no <code class="filename">buildlink3.mk</code> file
                   7809:        available, create one. Using
                   7810:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7811:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7812: <li class="listitem">
1.132     spz      7813: <p>If your package needs some executable to be able to run
                   7814:        correctly and if there's no
                   7815:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7816:        using the <code class="varname">DEPENDS</code> variable. The
1.322     leot     7817:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7818:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7819:        when it runs, and that is specified:</p>
1.75      rillig   7820: <pre class="programlisting">
1.242     wiz      7821: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7822: </pre>
1.132     spz      7823: </li>
1.290     gutterid 7824: <li class="listitem"><p>If your package includes a test suite that has extra
                   7825:         dependencies only required for this purpose (frequently this
                   7826:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7827:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7828: <li class="listitem">
                   7829: <p>You can use wildcards in package dependencies. Note that
                   7830:        such wildcard dependencies are retained when creating binary
                   7831:        packages. The dependency is checked when installing the binary
                   7832:        package and any package which matches the pattern will be
                   7833:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7834: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7835:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7836:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7837:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7838: <p>Wildcards can also be used to specify that a package
1.87      wiz      7839:        will only build against a certain minimum version of a
                   7840:        pre-requisite:</p>
1.75      rillig   7841: <pre class="programlisting">
1.132     spz      7842: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7843: </pre>
1.132     spz      7844: <p>This means that the package will build using version 6.0
                   7845:        of ImageMagick or newer. Such a dependency may be warranted
                   7846:        if, for example, the command line options of an executable
                   7847:        have changed.</p>
                   7848: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7849:        set
                   7850:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7851:        to the appropriate pattern before including its
                   7852:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7853: <pre class="programlisting">
                   7854: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7855: .include "../../graphics/jpeg/buildlink3.mk"
                   7856: </pre>
1.75      rillig   7857: <p>For security fixes, please update the package
1.267     rillig   7858:        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      7859:        information.</p>
1.75      rillig   7860: </li>
                   7861: </ol></div>
                   7862: <p>If your package needs files from another package to build,
1.87      wiz      7863:     add the relevant distribution files to
                   7864:     <code class="varname">DISTFILES</code>, so they will be extracted
1.322     leot     7865:     automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7866:     (It relies on the jpeg sources being present in source form
                   7867:     during the build.)</p>
1.75      rillig   7868: </div>
1.148     asau     7869: <div class="sect2">
1.75      rillig   7870: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7871: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341     gutterid 7872: <p>Your package may conflict with other packages users might
                   7873:     already have installed on their system, e.g., if your package
1.88      wiz      7874:     installs the same set of files as another package in the pkgsrc
1.342     wiz      7875:     tree.</p>
1.322     leot     7876: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/index.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
                   7877:     and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.255     leot     7878:     install the same shared library, thus you set in
                   7879:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7880: <pre class="programlisting">
                   7881: CONFLICTS=      Xaw-Xpm-[0-9]*
1.352     wiz      7882: </pre>
1.255     leot     7883: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7884: <pre class="programlisting">
                   7885: CONFLICTS=      libXaw3d-[0-9]*
1.352     wiz      7886: </pre>
1.378     leot     7887: <p><a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7888:     that conflict with existing packages and abort. However, in many
                   7889:     situations this is too late in the process. Binary package managers
                   7890:     will not know about the conflict until they attempt to install the
                   7891:     package after already downloading it and all its dependencies.
                   7892:     Users may also waste time building a package and its dependencies
                   7893:     only to find out at the end that it conflicts with another package
                   7894:     they have installed.</p>
                   7895: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7896:     should be added in all cases where it is known that packages conflict
                   7897:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.378     leot     7898:     exported in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7899:     managers to inform users that packages cannot be installed onto
                   7900:     the target system.</p>
1.75      rillig   7901: </div>
1.148     asau     7902: <div class="sect2">
1.75      rillig   7903: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7904: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7905: <p>There are several reasons why a package might be
1.88      wiz      7906:     instructed to not build under certain circumstances.  If the
1.87      wiz      7907:     package builds and runs on most platforms, the exceptions
1.193     dholland 7908:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7909:     the package builds and runs on a small handful of platforms,
                   7910:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7911:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7912:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7913:     (OS-version-platform) that can use glob-style
                   7914:     wildcards.</p>
                   7915: <p>If a package is not appropriate for some platforms (as
1.225     maya     7916:     opposed to merely broken), a different set of variables should be
1.193     dholland 7917:     used as this affects failure reporting and statistics.
                   7918:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7919:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7920:     the package is appropriate for only a small handful of platforms
                   7921:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7922:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7923:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7924:     (OS-version-platform) that can use glob-style
                   7925:     wildcards.</p>
1.88      wiz      7926: <p>Some packages are tightly bound to a specific version of an
1.322     leot     7927:     operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7928:     backwards compatible with other versions of the OS, and should be
                   7929:     uploaded to a version specific directory on the FTP server.  Mark
                   7930:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7931:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7932:     the package system internals, but may be used in the
                   7933:     future.</p>
1.75      rillig   7934: <p>If the package should be skipped (for example, because it
1.87      wiz      7935:     provides functionality already provided by the system), set
1.88      wiz      7936:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7937:     the package should fail because some preconditions are not met,
                   7938:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7939:     message.</p>
1.75      rillig   7940: </div>
1.148     asau     7941: <div class="sect2">
1.75      rillig   7942: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7943: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7944: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7945:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7946:     be set in the package Makefile. This will be carried into any
                   7947:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7948:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.378     leot     7949:     not be deleted using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7950:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7951: </div>
1.148     asau     7952: <div class="sect2">
1.75      rillig   7953: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7954: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7955: <p>When a vulnerability is found, this should be noted in
1.361     wiz      7956:     <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.320     wiz      7957:     Entries in that file consist of three parts:</p>
                   7958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7959: <li class="listitem"><p>package version pattern</p></li>
                   7960: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   7961: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   7962: </ul></div>
                   7963: <p>For the package version pattern please always use `&lt;' to
                   7964:     mark an upper bound (not `&lt;='!). This will avoid possible
                   7965:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   7966:     related to security fixes. Lower bounds can be added too, using
                   7967:     '&gt;' or '&gt;='. For example,
1.321     wiz      7968:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.2</code></span>&#8221;</span> would mark
1.320     wiz      7969:     versions 1.0 (included) to 1.2 (excluded) of
                   7970:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo</code></span>&#8221;</span> as affected by the security
                   7971:     issue.</p>
                   7972: <p>Entries should always be added at the bottom of the file.</p>
                   7973: <p>When fixing packages, please modify the upper bound of the
                   7974:     corresponding entry. To continue the previous example, if a fix
                   7975:     was backported to version 1.1nb2, change the previous pattern to
1.321     wiz      7976:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>&#8221;</span>.</p>
1.320     wiz      7977: <p>To locally test a package version pattern against a
                   7978:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   7979:     pmatch</strong></span> command.</p>
                   7980: <p>The URL should be as permanent as possible and provide as
                   7981:     much information about the issue as possible.  CVE entries are
                   7982:     preferred.</p>
                   7983: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138     wiz      7984:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7985: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7986:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7987:     course not necessary if the problem is fixed by using a newer
                   7988:     release of the software), and the pattern in the
                   7989:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7990: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7991:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7992: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7993:     semi-automatically by a weekly cron job.</p>
1.320     wiz      7994: <p>In case a security issue is disputed, please contact
                   7995:     pkgsrc-security@NetBSD.org.</p>
1.75      rillig   7996: </div>
1.148     asau     7997: <div class="sect2">
1.75      rillig   7998: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7999: <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   8000: <p>When making fixes to an existing package it can be useful
1.87      wiz      8001:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8002:     avoid conflicting with future versions by the original author, a
1.128     wiz      8003:     <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      8004:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      8005:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8006:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      8007: <pre class="programlisting">
1.100     rillig   8008: DISTNAME=       foo-17.42
                   8009: PKGREVISION=    9
1.222     sevan    8010: </pre>
1.75      rillig   8011: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      8012:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8013:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      8014:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8015:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8016: <p>When a new release of the package is released, the
1.87      wiz      8017:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8018:     minor release of the above package, things should be like:</p>
1.75      rillig   8019: <pre class="programlisting">
1.100     rillig   8020: DISTNAME=       foo-17.43
1.222     sevan    8021: </pre>
1.87      wiz      8022: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8023:     non-trivial change in the resulting binary package.  Without a
                   8024:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8025:     version installed has no way of knowing that their package is out
                   8026:     of date.  Thus, changes without increasing
                   8027:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8028:     trivial that no reasonable person would want to upgrade", and this
                   8029:     is the rough test for when increasing
                   8030:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8031:     changes that do not merit increasing
                   8032:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     8033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8034: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   8035:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   8036:       comments in Makefile.</p></li>
                   8037: <li class="listitem"><p>Changing build variables if the resulting binary
                   8038:       package is the same.</p></li>
                   8039: <li class="listitem"><p>Changing
                   8040:       <code class="filename">DESCR</code>.</p></li>
                   8041: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   8042:       default options don't change.</p></li>
1.100     rillig   8043: </ul></div>
1.87      wiz      8044: <p>Examples of changes that do merit an increase to
                   8045:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     8046: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   8047: <li class="listitem"><p>Security fixes</p></li>
                   8048: <li class="listitem"><p>Changes or additions to a patch
                   8049:       file</p></li>
                   8050: <li class="listitem"><p>Changes to the
                   8051:       <code class="filename">PLIST</code></p></li>
                   8052: <li class="listitem"><p>A dependency is changed or
                   8053:       renamed.</p></li>
1.100     rillig   8054: </ul></div>
1.78      rillig   8055: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8056:     changes.</p>
1.75      rillig   8057: </div>
1.148     asau     8058: <div class="sect2">
1.79      rillig   8059: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8060: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.295     rillig   8061: <p>When you want to replace the same text in multiple files, or
                   8062: multiple times in the same file, it is cumbersome to maintain a patch
                   8063: file for this. This is where the SUBST framework steps in. It provides an
                   8064: easy-to-use interface for replacing text in files. It just needs the
                   8065: following information:</p>
                   8066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8067: <li class="listitem"><p>In which phase of the package build cycle should the
                   8068: replacement happen?</p></li>
                   8069: <li class="listitem"><p>In which files should the replacement
1.287     rillig   8070: happen?</p></li>
1.295     rillig   8071: <li class="listitem"><p>Which text should be replaced with
                   8072: what?</p></li>
1.287     rillig   8073: </ul></div>
                   8074: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   8075: variables. A minimal example is:</p>
                   8076: <pre class="programlisting">
                   8077: SUBST_CLASSES+=         paths
                   8078: SUBST_STAGE.paths=      pre-configure
                   8079: SUBST_FILES.paths=      src/*.c
                   8080: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   8081: </pre>
                   8082: <p>Translated into English, it means: In the pre-configure stage (that
                   8083: is, after applying the patches from the patches/ directory and before
                   8084: running the configure script and the portability check), replace the text
                   8085: <code class="literal">/usr/local</code> with the content of the variable
                   8086: <code class="varname">PREFIX</code>.</p>
                   8087: <p>Each SUBST block starts by appending an identifier to
                   8088: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   8089: identifier can be chosen freely by the package. If there should ever be
                   8090: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   8091: early, so don't worry about name collisions.</p>
                   8092: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   8093: SUBST block are parameterized using this identifier. In the remainder of
                   8094: this section, these parameterized variables are written as
                   8095: <code class="varname">SUBST_STAGE.*</code>.</p>
                   8096: <pre class="programlisting">
                   8097: SUBST_CLASSES+=         paths
                   8098: SUBST_STAGE.paths=      pre-configure
                   8099: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   8100: SUBST_FILES.paths=      src/*.c
                   8101: SUBST_FILES.paths+=     scripts/*.sh
                   8102: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   8103: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   8104: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   8105: </pre>
                   8106: <p>To get a complete picture about the SUBST substitutions, run
                   8107: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   8108: expected, run pkglint on the package, which detects several typical
                   8109: mistakes surrounding the SUBST blocks. For any questions that might
                   8110: remain after this, have a look at
                   8111: <code class="filename">mk/subst.mk</code>.</p>
                   8112: <div class="sect3">
                   8113: <div class="titlepage"><div><div><h4 class="title">
                   8114: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   8115: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   8116: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   8117: <code class="literal">pre-configure</code> is used most often, by far. The most
                   8118: popular stages are, in chronological order:</p>
                   8119: <div class="variablelist"><dl class="variablelist">
                   8120: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   8121: <dd>
                   8122: <p>The substitutions are applied immediately after the
                   8123: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   8124: package will leave no traces of the original files.</p>
                   8125: <p>When the substitution applies to files for which there is also a
                   8126: patch in the <code class="filename">patches/</code> directory, this means that the
                   8127: patches will be computed based on the result of the substitution. When
                   8128: these patches are sent to the upstream maintainer later, to be fixed in
                   8129: the upstream package, these patches may no longer match what the upstream
                   8130: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   8131: often a better choice.</p>
                   8132: </dd>
                   8133: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   8134: <dd>
                   8135: <p>The substitutions are applied after the patches from the
                   8136: <code class="filename">patches/</code> directory. This makes it possible to run
                   8137: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322     leot     8138: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.295     rillig   8139: <p>When updating the patches, it is helpful to explicitly separate the
                   8140: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   8141: configure</strong></span>, and to only edit the patches between these commands.
                   8142: Otherwise the substitutions from the SUBST block will end up in the patch
                   8143: file. When this happens in really obvious ways, pkglint will complain
                   8144: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   8145: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   8146: can only detect these really obvious
                   8147: cases.</p>
                   8148: </dd>
                   8149: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   8150: <dd><p>This stage should only be used if the package defines a
                   8151: <code class="literal">pre-configure</code> action itself, and the substitution must
                   8152: happen after that. Typical examples are packages that use the
                   8153: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   8154: script from
                   8155: <code class="filename">configure.ac</code>.</p></dd>
                   8156: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   8157: <dd><p>This stage is used to fix up any mistakes by the
                   8158: configure stage.</p></dd>
                   8159: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   8160: <dd><p>This stage should only be used for substitutions that are
                   8161: clearly related to building the package, not for fixing the
                   8162: configuration. Substitutions for pathnames (such as replacing
                   8163: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   8164: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   8165: actual username) belong in pre-configure or post-configure
                   8166: instead.</p></dd>
                   8167: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   8168: <dd>
                   8169: <p>Just as with pre-build, this stage should only be used
                   8170: for substitutions that are clearly related to building the package, not
                   8171: for fixing the configuration. Substitutions for pathnames (such as
                   8172: replacing <code class="filename">/usr/local</code> with
                   8173: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   8174: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   8175: pre-configure or post-configure instead.</p>
                   8176: <p>A typical use is to update pkg-config files to include the rpath
                   8177: compiler options.</p>
                   8178: </dd>
                   8179: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8180: <dd><p>In general, the install phase should be as simple as
                   8181: possible. As with the pre-build and post-build stages, it should not be
                   8182: used to fix pathnames or user names, these belong in pre-configure
                   8183: instead. There are only few legitimate use cases for applying
                   8184: substitutions in this stage.</p></dd>
                   8185: </dl></div>
                   8186: </div>
                   8187: <div class="sect3">
                   8188: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   8189: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   8190: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8191: filename patterns. These patterns are relative to
                   8192: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8193: A typical example is:</p>
                   8194: <pre class="programlisting">
                   8195: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8196: </pre>
                   8197: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8198: implementation checks that each filename pattern that is mentioned here
                   8199: has an effect. For example, if none of the
                   8200: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8201: and substituted, that filename pattern is redundant and should be left
1.296     rillig   8202: out. By default, the SUBST framework will complain with an error message.
                   8203: If the text to be substituted occurs in some of the files from a single
                   8204: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   8205: framework will only print an INFO message for those files.</p>
                   8206: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   8207: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   8208: <p>Another popular way of choosing the files for the substitutions is
                   8209: via a shell command, like this:</p>
                   8210: <pre class="programlisting">
1.296     rillig   8211: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8212: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8213: </pre>
                   8214: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8215: freely chosen and independent of the SUBST framework.</p>
                   8216: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8217: lists each file individually. Thereby chances are higher that there are
                   8218: filename patterns in which no substitution happens. Since the SUBST
                   8219: framework cannot know whether the filename patterns in
                   8220: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8221: Makefile (where any redundant filename pattern would be suspicious) or
                   8222: been generated by a shell command (in which redundant filename patterns
                   8223: are more likely and to be expected), it will complain about these
                   8224: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8225: command to generate the list of filename patterns often need to set
                   8226: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8227: </div>
                   8228: <div class="sect3">
                   8229: <div class="titlepage"><div><div><h4 class="title">
                   8230: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8231: <p>In most cases, the substitutions are given using one or more
1.378     leot     8232: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8233: <pre class="programlisting">
                   8234: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8235: </pre>
                   8236: <p>Each of the sed commands needs to be preceded by the
                   8237: <code class="literal">-e</code> option and should be specified on a line of its
                   8238: own, to avoid hiding short sed commands at the end of a line.</p>
                   8239: <p>Since the sed commands often contain shell metacharacters as the
                   8240: separator (the <code class="literal">|</code> in the above example), it is common
                   8241: to enclose them in single quotes.</p>
                   8242: <p>A common substitution is to replace placeholders of the form
                   8243: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8244: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8245: <pre class="programlisting">
                   8246: SUBST_VARS.path=        PREFIX
                   8247: </pre>
                   8248: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8249: scripts during the do-configure stage, but in some cases these need to be
                   8250: overridden. The same pattern is also used when a package defines patches
                   8251: that replace previously hard-coded paths like
                   8252: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8253: placeholder first, which then gets substituted by the actual
                   8254: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8255: cases, it works equally well to just use the SUBST framework to directly
                   8256: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8257: thereby omitting the intermediate patch file.</p>
1.295     rillig   8258: <p>If the above is not flexible enough, it is possible to not use sed
                   8259: at all for the substitution but to specify an entirely different command,
                   8260: like this:</p>
1.87      wiz      8261: <pre class="programlisting">
1.295     rillig   8262: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8263: </pre>
                   8264: <p>This is used for the few remaining packages in which the
                   8265: distributed files use Windows-style line endings that need to be
                   8266: converted to UNIX-style line endings.</p>
                   8267: </div>
                   8268: <div class="sect3">
                   8269: <div class="titlepage"><div><div><h4 class="title">
                   8270: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8271: <p>When a SUBST block is applied during a package build, a message is
                   8272: logged. The default message is fine for most purposes but can be
                   8273: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8274: message.</p>
                   8275: </div>
1.79      rillig   8276: </div>
1.75      rillig   8277: </div>
1.148     asau     8278: <div class="sect1">
1.75      rillig   8279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8280: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8281: <div class="sect2">
1.75      rillig   8282: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8283: <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   8284: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8285:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8286:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8287:     with the name of each file to download as an argument, expecting
                   8288:     it to output the URL of the directory from which to download
1.322     leot     8289:     it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8290:     example of this usage.</p>
1.75      rillig   8291: <p>If the download can't be automated, because the user must
1.87      wiz      8292:     submit personal information to apply for a password, or must pay
                   8293:     for the source, or whatever, you can set
                   8294:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8295:     displayed to the user before aborting the build. Example:</p>
                   8296: <pre class="programlisting">
1.100     rillig   8297: FETCH_MESSAGE=  "Please download the files"
                   8298: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8299: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8300: </pre>
1.75      rillig   8301: </div>
1.148     asau     8302: <div class="sect2">
1.75      rillig   8303: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8304: <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   8305: <p>Sometimes authors of a software package make some
1.87      wiz      8306:     modifications after the software was released, and they put up a
                   8307:     new distfile without changing the package's version number. If a
                   8308:     package is already in pkgsrc at that time, the checksum will
                   8309:     no longer match. The contents of the new distfile should be
                   8310:     compared against the old one before changing anything, to make
                   8311:     sure the distfile was really updated on purpose, and that
                   8312:     no trojan horse or so crept in.
1.97      rillig   8313:     Please mention that the distfiles were compared and what was found
1.159     rodent   8314:     in your commit message.</p>
1.220     wiz      8315: <p>Then, the correct way to work around this is to set
                   8316:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8317:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8318:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8319:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8320:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8321:     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      8322:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8323:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8324:     be appended, like
                   8325:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8326: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8327:     name does not contain a version and the distfile is apt to change. In
                   8328:     cases where the likelihood of this is very small,
                   8329:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8330:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8331:     distfile name changes, even if a package is being moved or
                   8332:     renamed.</p>
1.159     rodent   8333: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8334:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8335:     path in the filenames.
1.159     rodent   8336:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8337:     Furthermore, a mail to the package's authors seems appropriate
                   8338:     telling them that changing distfiles after releases without
                   8339:     changing the file names is not good practice.</p>
1.75      rillig   8340: </div>
1.199     tnn      8341: <div class="sect2">
                   8342: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8343: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8344: <p>Helper methods exist for packages hosted on github.com which
                   8345:     will often have distfile names that clash with other packages, for
                   8346:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8347:     from below:</p>
1.199     tnn      8348: <div class="sect3">
                   8349: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8350: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8351: <p>If your distfile URL looks similar to
1.303     bacon    8352:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8353:       then you are packaging a tagged release.</p>
1.199     tnn      8354: <pre class="programlisting">
1.303     bacon    8355: DISTNAME=       example-1.0
1.200     tnn      8356: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8357: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8358: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8359: EXTRACT_SUFX=   .zip
                   8360: </pre>
1.345     gutterid 8361: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
                   8362:     file fetching infrastructure to save the resulting file locally as
                   8363:     <code class="literal">example-1.0.zip</code>.</p>
1.199     tnn      8364: </div>
                   8365: <div class="sect3">
                   8366: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8367: <a name="build.fetch.github.commit.prerelease"></a>21.2.3.2. Fetch based on a specific commit before the first release</h4></div></div></div>
                   8368: <p>If your distfile looks similar to
                   8369:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8370:       release, then set the package version to 0.0.0.N, where N is the number
                   8371:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8372:       This will (almost) ensure that the first tagged release will have a
                   8373:       version greater than this one so that package upgrades will function
                   8374:       properly.</p>
                   8375: <pre class="programlisting">
                   8376: DISTNAME=       example-0.0.0.347
                   8377: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8378: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8379: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8380: </pre>
                   8381: </div>
                   8382: <div class="sect3">
                   8383: <div class="titlepage"><div><div><h4 class="title">
                   8384: <a name="build.fetch.github.commit.postrelease"></a>21.2.3.3. Fetch based on a specific commit after a release</h4></div></div></div>
                   8385: <p>If your distfile looks similar to
                   8386:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8387:       then include the last release version and the commit count since that
                   8388:       release in the package version and set GITHUB_TAG to the commit hash.
                   8389:       The latest release and commit count are shown in the output of
                   8390:       "git describe --tags":
                   8391:       </p>
                   8392: <pre class="screen">
                   8393: # git clone https://github.com/username/example
                   8394: # cd example
                   8395: # git describe --tags
                   8396: 1.2.3-5-g988881a
                   8397: </pre>
1.199     tnn      8398: <pre class="programlisting">
1.303     bacon    8399: DISTNAME=       example-1.2.3.5
                   8400: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8401: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8402: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8403: </pre>
1.199     tnn      8404: </div>
                   8405: <div class="sect3">
                   8406: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8407: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8408: <p>If your distfile URL looks similar to
1.303     bacon    8409:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8410:       then you are packaging a release.</p>
1.199     tnn      8411: <pre class="programlisting">
                   8412: DISTNAME=       offensive-1.6
1.200     tnn      8413: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8414: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8415: GITHUB_PROJECT= example
1.200     tnn      8416: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8417: EXTRACT_SUFX=   .zip
1.222     sevan    8418: </pre>
1.199     tnn      8419: </div>
                   8420: </div>
1.75      rillig   8421: </div>
1.148     asau     8422: <div class="sect1">
1.75      rillig   8423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8424: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8425: <div class="sect2">
1.75      rillig   8426: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8427: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8428: <p>pkgsrc supports many different machines, with different
1.87      wiz      8429:     object formats like a.out and ELF, and varying abilities to do
                   8430:     shared library and dynamic loading at all. To accompany this,
                   8431:     varying commands and options have to be passed to the
                   8432:     compiler, linker, etc. to get the Right Thing, which can be
                   8433:     pretty annoying especially if you don't have all the machines
                   8434:     at your hand to test things.  The
1.322     leot     8435:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      8436:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8437:     both static and dynamic libraries from a set of source files,
                   8438:     thus being platform-independent.</p>
                   8439: <p>Here's how to use libtool in a package in seven simple
                   8440:     steps:</p>
1.128     wiz      8441: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8442: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8443:        Makefile.</p></li>
1.128     wiz      8444: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8445:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8446:        add it to the definition of <code class="varname">CC</code>, if only
                   8447:        libraries are being built in a given Makefile. This one command
                   8448:        will build both PIC and non-PIC library objects, so you need not
                   8449:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8450: <li class="listitem">
1.75      rillig   8451: <p>For the linking of the library, remove any
1.128     wiz      8452:        <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
                   8453:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8454: <pre class="programlisting">
1.100     rillig   8455: ${LIBTOOL} --mode=link \
                   8456:     ${CC} -o ${.TARGET:.a=.la} \
                   8457:         ${OBJS:.o=.lo} \
                   8458:         -rpath ${PREFIX}/lib \
                   8459:         -version-info major:minor
1.222     sevan    8460: </pre>
1.75      rillig   8461: <p>Note that the library is changed to have a
1.87      wiz      8462:        <code class="filename">.la</code> extension, and the objects are
                   8463:        changed to have a <code class="filename">.lo</code>
                   8464:        extension. Change <code class="varname">OBJS</code> as
                   8465:        necessary. This automatically creates all of the
                   8466:        <code class="filename">.a</code>,
                   8467:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8468:        necessary) in the build directory. Be sure to include
1.128     wiz      8469:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8470:        minor are zero, as libtool will otherwise strip off the
                   8471:        shared library version.</p>
1.75      rillig   8472: <p>From the libtool manual:</p>
                   8473: <pre class="programlisting">
1.100     rillig   8474: So, libtool library versions are described by three integers:
1.69      rillig   8475: 
1.100     rillig   8476: CURRENT
                   8477: The most recent interface number that this library implements.
1.69      rillig   8478: 
1.100     rillig   8479: REVISION
                   8480: The implementation number of the CURRENT interface.
1.69      rillig   8481: 
1.100     rillig   8482: AGE
                   8483: The difference between the newest and oldest interfaces that
                   8484: this library implements.  In other words, the library implements
                   8485: all the interface numbers in the range from number `CURRENT -
                   8486: AGE' to `CURRENT'.
1.1       grant    8487: 
1.100     rillig   8488: If two libraries have identical CURRENT and AGE numbers, then the
                   8489: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8490: </pre>
1.128     wiz      8491: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8492:        different results for a.out and ELF (excluding symlinks)
                   8493:        in only one case. An ELF library of the form
1.128     wiz      8494:        <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      8495:        will have a symlink of
1.128     wiz      8496:        <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      8497:        on an a.out platform. This is handled
                   8498:        automatically.</p>
1.128     wiz      8499: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8500:        directory of the library being built.</p>
1.76      rillig   8501: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8502:        <code class="filename">.la</code> file, the other files will be
                   8503:        added automatically.</p>
1.75      rillig   8504: </li>
1.128     wiz      8505: <li class="listitem">
1.76      rillig   8506: <p>When linking shared object (<code class="filename">.so</code>)
1.378     leot     8507:        files, i.e. files that are loaded via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8508:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8509:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8510:        tacked on.</p>
1.76      rillig   8511: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8512:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8513: </li>
1.128     wiz      8514: <li class="listitem">
1.75      rillig   8515: <p>When linking programs that depend on these libraries
1.87      wiz      8516:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.378     leot     8517:        the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ld.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      8518:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8519:        libraries (static or shared), but please be aware that
                   8520:        libtool will not allow you to specify a relative path in
1.128     wiz      8521:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8522:        expects you to change that argument to be the
                   8523:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8524: <pre class="programlisting">
1.100     rillig   8525: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8526: </pre>
1.75      rillig   8527: <p>should be changed to:</p>
                   8528: <pre class="programlisting">
1.100     rillig   8529: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8530: </pre>
1.75      rillig   8531: <p>and it will do the right thing with the libraries.</p>
                   8532: </li>
1.128     wiz      8533: <li class="listitem">
1.378     leot     8534: <p>When installing libraries, preface the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8535:        or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cp.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      8536:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8537:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8538: <pre class="programlisting">
1.126     jakllsch 8539: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8540: </pre>
1.76      rillig   8541: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8542:        shared library, any needed symlinks, and run
1.378     leot     8543:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8544: </li>
1.128     wiz      8545: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8546:        the <code class="filename">.la</code>
                   8547:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8548: </ol></div>
                   8549: </div>
1.148     asau     8550: <div class="sect2">
1.75      rillig   8551: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8552: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8553: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8554:     package Makefile. This will override the package's own libtool
                   8555:     in most cases.  For older libtool using packages,  libtool is
                   8556:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8557:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8558:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8559: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8560:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8561:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8562:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8563:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8564: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8565:     libraries built and installed, then use
                   8566:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8567: <p>If your package makes use of the platform-independent library
1.87      wiz      8568:     for loading dynamic shared objects, that comes with libtool
                   8569:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8570: <p>Some packages use libtool incorrectly so that the package
                   8571:     may not work or build in some circumstances. Some of the more
                   8572:     common errors are:</p>
1.148     asau     8573: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8574: <li class="listitem">
1.75      rillig   8575: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8576:        executable or library. This in itself isn't a problem if one of two things
                   8577:        has been done:</p>
1.128     wiz      8578: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8579: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8580:            <code class="filename">libfoo.la</code>, not
                   8581:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8582: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8583: </ol></div>
                   8584: </li>
1.128     wiz      8585: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8586:        The function lt_dlinit() should be called and the macro
                   8587:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8588:        executables.</p></li>
1.75      rillig   8589: </ul></div>
                   8590: </div>
1.148     asau     8591: <div class="sect2">
1.75      rillig   8592: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8593: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8594: <p>If a package needs GNU autoconf or automake to be executed
1.338     nia      8595:     to regenerate the
                   8596:     <code class="filename">configure</code>
                   8597:     script and <code class="filename">Makefile.in</code> makefile
                   8598:     templates from <code class="filename">configure.ac</code> and
                   8599:     <code class="filename">Makefile.am</code>,
                   8600:     then they should be executed in a pre-configure target:</p>
1.75      rillig   8601: <pre class="programlisting">
1.338     nia      8602: USE_TOOLS+=    autoconf automake autoreconf
                   8603: GNU_CONFIGURE= yes
1.100     rillig   8604: ...
1.1       grant    8605: 
1.100     rillig   8606: pre-configure:
1.338     nia      8607:         set -e; cd ${WRKSRC} &amp;&amp; autoreconf -fi
1.100     rillig   8608: ...
1.222     sevan    8609: </pre>
1.338     nia      8610: <p>Packages which use GNU Automake will sometimes
                   8611:     require GNU Make (<code class="literal">gmake</code> in
                   8612:     <code class="varname">USE_TOOLS</code>),
                   8613:     but not always.  Note that autoreconf
                   8614:     only needs to be executed if <code class="filename">configure.ac</code>
                   8615:     or Makefiles are modified, or <code class="filename">configure</code>
                   8616:     is not present.</p>
1.75      rillig   8617: <p>There are times when the configure process makes
1.87      wiz      8618:     additional changes to the generated files, which then causes
                   8619:     the build process to try to re-execute the automake sequence.
                   8620:     This is prevented by touching various files in the configure
                   8621:     stage. If this causes problems with your package you can set
                   8622:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8623:     Makefile.</p>
1.75      rillig   8624: </div>
1.338     nia      8625: <div class="sect2">
                   8626: <div class="titlepage"><div><div><h3 class="title">
                   8627: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
                   8628: <p>Packages using Meson to configure need to include:
                   8629: 
                   8630: </p>
                   8631: <pre class="programlisting">
                   8632: .include "../../devel/meson/build.mk"
                   8633: </pre>
                   8634: <p>In nearly all cases (any program with dependencies),
                   8635:     pkg-config needs to be added to
                   8636:     <code class="varname">USE_TOOLS</code>.  If the package installs
                   8637:     translation files for non-English languages, also
                   8638:     add msgfmt and xgettext:
                   8639: 
                   8640: </p>
                   8641: <pre class="programlisting">
                   8642: USE_TOOLS+=    pkg-config msgfmt xgettext
                   8643: </pre>
                   8644: <p>If any options need to be passed to Meson, use
                   8645:     <code class="varname">MESON_ARGS</code> instead of
                   8646:     <code class="varname">CONFIGURE_ARGS</code>:
                   8647: 
                   8648: </p>
                   8649: <pre class="programlisting">
                   8650: MESON_ARGS+=   -Dx11=false
                   8651: </pre>
                   8652: </div>
1.379     wiz      8653: <div class="sect2">
                   8654: <div class="titlepage"><div><div><h3 class="title">
                   8655: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
                   8656: <p>To determine the endianness of the target platform,
                   8657:     have a look at <code class="filename">mk/endian.mk</code>.</p>
                   8658: </div>
1.75      rillig   8659: </div>
1.148     asau     8660: <div class="sect1">
1.75      rillig   8661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8662: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8663: <div class="sect2">
1.87      wiz      8664: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8665: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.358     gutterid 8666: <p>Compilers for the C and C++ languages come with
1.87      wiz      8667:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8668:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8669:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.357     gutterid 8670: <p>To declare which languages should be made available through
                   8671:     pkgsrc's compiler wrappers, use 
1.87      wiz      8672:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327     wiz      8673:     currently are:
1.352     wiz      8674: </p>
1.327     wiz      8675: <pre class="programlisting">
1.358     gutterid 8676: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.352     wiz      8677: </pre>
1.327     wiz      8678: <p>
                   8679:     (and any combination).  The default is
1.128     wiz      8680:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8681:     written in C++, usually need a C compiler for the configure
1.358     gutterid 8682:     phase.</p>
1.364     jnemeth  8683: <p>To declare which features a package requires from the
1.357     gutterid 8684:     compiler, set either <code class="varname">USE_CC_FEATURES</code>
                   8685:     or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
                   8686:     <code class="varname">USE_CC_FEATURES</code> are currently:
                   8687: </p>
                   8688: <pre class="programlisting">
                   8689: c11, c99, has_include
                   8690: </pre>
                   8691: <p>
                   8692:     Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
                   8693:     currently:
                   8694: </p>
                   8695: <pre class="programlisting">
                   8696: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
                   8697: charconv, parallelism_ts, unique_ptr, put_time,
                   8698: is_trivially_copy_constructible
                   8699: </pre>
                   8700: <p>
1.365     gutterid 8701:     Note at present these variables only affect use of GCC, not other
                   8702:     compilers.
1.357     gutterid 8703:     </p>
1.358     gutterid 8704: <p>Language variants like <code class="literal">gnu99</code> and
                   8705:     <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
                   8706:     and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
                   8707:     <code class="literal">-std=...</code> when compiling (i.e. the package
                   8708:     assumes the compiler defaults to C++11 or some other standard).
                   8709:     This is a common bug in upstream build systems.</p>
                   8710: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
                   8711:     currently:
                   8712: </p>
                   8713: <pre class="programlisting">
                   8714: c90, c99, c11, gnu90, gnu99, gnu11
                   8715: </pre>
                   8716: <p>
                   8717:     </p>
                   8718: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
                   8719:     currently:
                   8720: </p>
                   8721: <pre class="programlisting">
                   8722: c++03, c++11, c++14, c++17, c++20,
                   8723: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
                   8724: </pre>
                   8725: <p>
1.365     gutterid 8726:     Note at present these variables only affect use of GCC and Clang.
1.358     gutterid 8727:     </p>
1.87      wiz      8728: </div>
1.148     asau     8729: <div class="sect2">
1.87      wiz      8730: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8731: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8732: <p>If a program is written in Java, use the Java framework in
                   8733:     pkgsrc.  The package must include
                   8734:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8735:     provides the following variables:</p>
1.148     asau     8736: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8737: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8738:       dependency on the JDK is added.  If
1.128     wiz      8739:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8740:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8741:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8742:       JDK.</p></li>
1.128     wiz      8743: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8744:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8745:       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
                   8746:       <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
                   8747:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8748:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8749:       above. This variable is not set by default.</p></li>
1.130     wiz      8750: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8751:       automatically set to the runtime location of the used Java
                   8752:       implementation dependency. It may be used to set
                   8753:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8754:       needs this variable to be defined.
                   8755:       </p></li>
1.87      wiz      8756: </ul></div>
                   8757: </div>
1.148     asau     8758: <div class="sect2">
1.87      wiz      8759: <div class="titlepage"><div><div><h3 class="title">
1.320     wiz      8760: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
                   8761: <p>If a program is written in Go and has any dependencies on
                   8762:     other Go modules, have the package include
                   8763:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8764: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8765: <li class="listitem"><p>Generate a list of those dependencies with
                   8766:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8767:       go-modules.mk</strong></span>.</p></li>
1.338     nia      8768: <li class="listitem"><p>Prepend
                   8769:       <code class="literal">.include "go-modules.mk"</code> to any other
                   8770:       <code class="literal">.include</code>s.</p></li>
                   8771: <li class="listitem"><p>Incorporate these modules in
                   8772:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8773:       makesum</strong></span>.</p></li>
                   8774: </ol></div>
                   8775: </div>
                   8776: <div class="sect2">
                   8777: <div class="titlepage"><div><div><h3 class="title">
                   8778: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
                   8779: <p>If a program is written in Rust and uses Cargo to build,
                   8780:     have the package include
                   8781:     <code class="filename">../../lang/rust/cargo.mk</code>.</p>
                   8782: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8783: <li class="listitem"><p>Generate a list of those dependencies with
                   8784:       <span class="command"><strong>make CARGO_ARGS="build --release" build &amp;&amp;
                   8785:       make print-cargo-depends &gt; cargo-depends.mk</strong></span>.</p></li>
                   8786: <li class="listitem"><p>Prepend
                   8787:       <code class="literal">.include "cargo-depends.mk"</code> to any other
                   8788:       <code class="literal">.include</code>s.</p></li>
1.320     wiz      8789: <li class="listitem"><p>Incorporate these modules in
                   8790:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8791:       makesum</strong></span>.</p></li>
                   8792: </ol></div>
                   8793: </div>
                   8794: <div class="sect2">
                   8795: <div class="titlepage"><div><div><h3 class="title">
1.338     nia      8796: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318     nia      8797: <p>If your package contains interpreted Perl scripts, add
1.128     wiz      8798:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8799:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8800:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8801:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8802:     that you want adjusted. Every occurrence of
                   8803:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325     gutterid 8804:     replaced with the full path to the Perl executable.</p>
                   8805: <p>If a particular version of Perl is needed, set the
1.87      wiz      8806:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8807:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.318     nia      8808: <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.325     gutterid 8809:     about handling Perl modules.</p>
                   8810: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8811:     for the language now known as Raku.</p>
1.87      wiz      8812: </div>
1.148     asau     8813: <div class="sect2">
1.87      wiz      8814: <div class="titlepage"><div><div><h3 class="title">
1.338     nia      8815: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8816: <p><code class="varname">REPLACE_SH</code>,
                   8817:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8818:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340     gutterid 8819:     she-bangs in files. Please use the appropriate one, preferring
                   8820:     <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183     wiz      8821:     Each should contain a list of scripts, relative to
                   8822:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8823:     occurrence of the matching shell in a she-bang line will be
                   8824:     replaced with the full path to the shell executable.
1.147     wiz      8825:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8826:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8827: </div>
1.148     asau     8828: <div class="sect2">
1.147     wiz      8829: <div class="titlepage"><div><div><h3 class="title">
1.338     nia      8830: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325     gutterid 8831: <p>There are further similar REPLACE variables available, e.g.,
                   8832:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8833:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326     gutterid 8834:     noted above, have their actions defined centrally in
1.325     gutterid 8835:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326     gutterid 8836:     languages define the actions of these variables within their own
                   8837:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.359     gutterid 8838:     actioned in <code class="filename">lang/php/replace.mk</code>, and
1.326     gutterid 8839:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325     gutterid 8840:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8841:     consult the mk files found within their specific directories (the
1.331     gutterid 8842:     naming convention varies), or check the list found in
                   8843:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325     gutterid 8844: <p>Currently, special handling for other languages varies
1.87      wiz      8845:     in pkgsrc.  If a compiler package provides a
                   8846:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8847:     just add a (build) dependency on the appropriate compiler
                   8848:     package.</p>
                   8849: </div>
                   8850: </div>
1.148     asau     8851: <div class="sect1">
1.87      wiz      8852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8853: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8854: <p>The most common failures when building a package are that
                   8855:        some platforms do not provide certain header files, functions or
                   8856:        libraries, or they provide the functions in a library that the
                   8857:        original package author didn't know. To work around this, you
                   8858:        can rewrite the source code in most cases so that it does not
                   8859:        use the missing functions or provides a replacement function.</p>
1.148     asau     8860: <div class="sect2">
1.77      rillig   8861: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8862: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8863: <p>If a package already comes with a GNU configure script, the
                   8864:        preferred way to fix the build failure is to change the
                   8865:        configure script, not the code. In the other cases, you can
                   8866:        utilize the C preprocessor, which defines certain macros
                   8867:        depending on the operating system and hardware architecture it
                   8868:        compiles for. These macros can be queried using for example
                   8869:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8870:        system, hardware architecture and compiler has its own macro.
                   8871:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8872:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8873:        are all defined, you know that you are using NetBSD on an i386
                   8874:        compatible CPU, and your compiler is GCC.</p>
                   8875: <p>The list of the following macros for hardware and
                   8876:        operating system depends on the compiler that is used. For
                   8877:        example, if you want to conditionally compile code on Solaris,
                   8878:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8879:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8880: <div class="sect3">
1.75      rillig   8881: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8882: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.338     nia      8883: <p>To distinguish between specific NetBSD versions,
                   8884:         you should use the following code.</p>
                   8885: <pre class="programlisting">
                   8886: #ifdef __NetBSD__
                   8887: #include &lt;sys/param.h&gt;
                   8888: #if __NetBSD_Prereq__(9,99,17)
                   8889: /* use a newer feature */
                   8890: #else
                   8891: /* older code */
                   8892: #endif
                   8893: #endif
                   8894: 
                   8895: #ifndef _WIN32
                   8896: /* Unix-like specific code */
                   8897: #endif
                   8898: </pre>
1.75      rillig   8899: <p>To distinguish between 4.4 BSD-derived systems and the
                   8900:         rest of the world, you should use the following code.</p>
                   8901: <pre class="programlisting">
1.100     rillig   8902: #include &lt;sys/param.h&gt;
                   8903: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8904: /* BSD-specific code goes here */
                   8905: #else
                   8906: /* non-BSD-specific code goes here */
                   8907: #endif
1.75      rillig   8908: </pre>
1.338     nia      8909: <p>You can also test for the following macros:</p>
1.75      rillig   8910: <pre class="programlisting">
1.151     obache   8911: Cygwin      __CYGWIN__
                   8912: DragonFly   __DragonFly__
1.100     rillig   8913: FreeBSD     __FreeBSD__
1.151     obache   8914: Haiku       __HAIKU__
1.100     rillig   8915: IRIX        __sgi (TODO: get a definite source for this)
1.338     nia      8916: Linux       __linux
1.193     dholland 8917: Mac OS X    __APPLE__
1.151     obache   8918: Minix3      __minix
1.100     rillig   8919: NetBSD      __NetBSD__
                   8920: OpenBSD     __OpenBSD__
                   8921: Solaris     sun, __sun
1.75      rillig   8922: </pre>
                   8923: </div>
1.148     asau     8924: <div class="sect3">
1.75      rillig   8925: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8926: <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   8927: <pre class="programlisting">
1.100     rillig   8928: i386        i386, __i386, __i386__
1.338     nia      8929: x86-64      __amd64__, __x86_64__
                   8930: ARM         __arm__
1.100     rillig   8931: MIPS        __mips
                   8932: SPARC       sparc, __sparc
1.338     nia      8933: PowerPC     __powerpc
1.75      rillig   8934: </pre>
                   8935: </div>
1.148     asau     8936: <div class="sect3">
1.75      rillig   8937: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8938: <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   8939: <pre class="programlisting">
1.100     rillig   8940: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8941: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8942: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8943: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8944: </pre>
                   8945: </div>
                   8946: </div>
1.148     asau     8947: <div class="sect2">
1.78      rillig   8948: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8949: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8950: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8951:         combinations of compiler version and architecture and almost
                   8952:         always relation to optimisation being enabled.  Common symptoms
                   8953:         are gcc internal errors or never finishing compiling a
1.78      rillig   8954:        file.</p>
                   8955: <p>Typically, a workaround involves testing the
                   8956:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8957:         optimisation for that combination of file,
1.198     tnn      8958:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8959: <p>This used to be a big problem in the past, but is rarely
                   8960:        needed now as compiler technology has matured. If you still need
                   8961:        to add a compiler specific workaround, please do so in the file
                   8962:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8963:        compiler version as detailed as possible.</p>
1.78      rillig   8964: </div>
1.148     asau     8965: <div class="sect2">
1.78      rillig   8966: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8967: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8968: <p>Compilation sometimes fails with an error message like this:</p>
                   8969: <pre class="programlisting">
                   8970: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8971:     fatal error: pango/pango.h: No such file or directory
                   8972: </pre>
                   8973: <p>The proper way to fix this problem depends on the type of the
                   8974: header, which is described in the following sections.</p>
                   8975: <div class="sect3">
                   8976: <div class="titlepage"><div><div><h4 class="title">
                   8977: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8978: <p>If the header name looks like it comes from a different package,
                   8979: that other package should be included via the buildlink3
                   8980: framework.</p>
                   8981: <p>First, look whether the header is somewhere in the buildlink3
                   8982: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8983: the missing Pango header:</p>
                   8984: <pre class="programlisting">
                   8985: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8986: </pre>
                   8987: <p>In the case of Pango, the output is:</p>
                   8988: <pre class="programlisting">
                   8989: work/.buildlink/include/pango-1.0/pango/pango.h
                   8990: </pre>
                   8991: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8992: in the <code class="filename">.buildlink</code> directory, it would have been
                   8993: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8994: path component though, which means that the compiler command line must
                   8995: contain an option of the form
                   8996: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8997: most cases this option is generated by the configure script, which can be examined using:</p>
                   8998: <pre class="programlisting">
                   8999: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   9000: -I/usr/pkg/include/pango-1.0
                   9001: -I/usr/pkg/include/pango-1.0
                   9002: -I/usr/pkg/include/pango-1.0
                   9003: -I/usr/pkg/include/pango-1.0
                   9004: -I/usr/pkg/include/pango-1.0
                   9005: </pre>
                   9006: <p>This looks good. These options are transformed by the buildlink
                   9007: wrapper to refer to the correct path inside
                   9008: <code class="filename">work/.buildlink</code>.</p>
                   9009: <p>Since the compilation fails though, examine the compiler command
                   9010: lines in <code class="filename">work/.work.log</code> to see whether the
                   9011: <code class="literal">-I</code> option is included in the particular command
                   9012: line.</p>
                   9013: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   9014: build-env</strong></span>, which sets up an interactive, realistic environment
                   9015: including all the pkgsrc wrapper commands and environment variables. From
                   9016: there, try to compile some simple example programs that use the
                   9017: header.</p>
                   9018: </div>
                   9019: <div class="sect3">
                   9020: <div class="titlepage"><div><div><h4 class="title">
                   9021: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   9022: <p>If the name of the header seems to come from the package itself,
                   9023: and if the build is run with parallel jobs, the package may have some
                   9024: undeclared dependencies between the <code class="filename">.c</code> and the
                   9025: <code class="filename">.h</code> files, and a C file is compiled before its
                   9026: required header is generated.</p>
                   9027: <p>To see whether the build runs with parallel jobs, run
                   9028: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   9029: like this:</p>
                   9030: <pre class="programlisting">
                   9031:   usr   MAKE_JOBS=              7
                   9032:   pkg   MAKE_JOBS_SAFE          # undefined
                   9033:   def   _MAKE_JOBS_N=           7
                   9034: </pre>
                   9035: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   9036: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   9037: package could have disabled parallel builds by setting
                   9038: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   9039: in this case it hasn't.</p>
                   9040: <p>To see whether the build failure is caused by parallel builds,
                   9041: first save the exact error message and a bit of context, maybe you need
                   9042: it later for reporting a bug. Next, run:</p>
                   9043: <pre class="programlisting">
                   9044: MAKE_JOBS_SAFE=no bmake clean build
                   9045: </pre>
                   9046: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   9047: report</a> against the pkgsrc package, including the exact error
                   9048: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   9049: </div>
1.288     rillig   9050: <div class="sect3">
                   9051: <div class="titlepage"><div><div><h4 class="title">
                   9052: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   9053: <p>Pkgsrc does not work reliably if any of
                   9054: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   9055: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   9056: bootstrap program prevents installing pkgsrc in symlink-based
                   9057: directories. Existing pkgsrc installations are not checked for symlinks
                   9058: though.</p>
                   9059: <p>The "No such file or directory" error messages are a typical
                   9060: symptom of symlinks, and it's quite difficult to find out that this is
                   9061: the actual cause.</p>
                   9062: </div>
                   9063: <div class="sect3">
                   9064: <div class="titlepage"><div><div><h4 class="title">
                   9065: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   9066: <p>When building a hierarchy of packages, it may happen that one
                   9067: package is built and then pkgsrc is updated. This situation can provoke
                   9068: various hard to diagnose build errors. To clean up the situation:</p>
                   9069: <pre class="programlisting">
1.338     nia      9070: <code class="prompt">$</code> (cd ../../ &amp;&amp; cat mk/bsd.pkg.mk &gt;/dev/null &amp;&amp; rm -rf */*/work)
1.288     rillig   9071: </pre>
1.338     nia      9072: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
                   9073: prevent running this command in the wrong directory.)</p>
1.288     rillig   9074: <p>If you have set <code class="varname">WRKOBJDIR</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, remove
                   9075: that directory as well.</p>
                   9076: </div>
                   9077: <div class="sect3">
                   9078: <div class="titlepage"><div><div><h4 class="title">
                   9079: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   9080: <p>On platforms other than BSD, third-party packages are installed in
                   9081: <code class="filename">/usr/include</code>, together with the base system. This
                   9082: means that pkgsrc cannot distinguish between headers provided by the base
                   9083: system (which it needs) and headers from third-party packages (which are
                   9084: often included in pkgsrc as well). This can lead to subtle version
                   9085: mismatches.</p>
                   9086: <p>In pkgsrc installations that have been active for several years, it
                   9087: may happen that some files are manually deleted. To exclude this unlikely
                   9088: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   9089: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   9090: check/fix dependencies.</p>
                   9091: <p>If all of the above doesn't help, see <a class="xref" href="#help-user" title="Chapter 2. Getting help">Chapter 2, <i>Getting help</i></a>
                   9092: for contact information. Be prepared to describe what you have tried so
                   9093: far and what any error messages were.</p>
                   9094: </div>
1.287     rillig   9095: </div>
                   9096: <div class="sect2">
                   9097: <div class="titlepage"><div><div><h3 class="title">
                   9098: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      9099: </h3></div></div></div>
1.92      rillig   9100: <p>This error message often means that a package did not
1.78      rillig   9101:        link to a shared library it needs. The following functions are
                   9102:        known to cause this error message over and over.</p>
                   9103: <div class="informaltable">
1.216     tnn      9104: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   9105: <colgroup>
                   9106: <col>
                   9107: <col>
                   9108: <col>
                   9109: </colgroup>
                   9110: <thead><tr>
                   9111: <th>Function</th>
                   9112: <th>Library</th>
                   9113: <th>Affected platforms</th>
                   9114: </tr></thead>
                   9115: <tbody>
                   9116: <tr>
                   9117: <td>accept, bind, connect</td>
                   9118: <td>-lsocket</td>
                   9119: <td>Solaris</td>
                   9120: </tr>
                   9121: <tr>
                   9122: <td>crypt</td>
                   9123: <td>-lcrypt</td>
                   9124: <td>DragonFly, NetBSD</td>
                   9125: </tr>
                   9126: <tr>
                   9127: <td>dlopen, dlsym</td>
                   9128: <td>-ldl</td>
                   9129: <td>Linux</td>
                   9130: </tr>
                   9131: <tr>
                   9132: <td>gethost*</td>
                   9133: <td>-lnsl</td>
                   9134: <td>Solaris</td>
                   9135: </tr>
                   9136: <tr>
                   9137: <td>inet_aton</td>
                   9138: <td>-lresolv</td>
                   9139: <td>Solaris</td>
                   9140: </tr>
                   9141: <tr>
                   9142: <td>nanosleep, sem_*, timer_*</td>
                   9143: <td>-lrt</td>
                   9144: <td>Solaris</td>
                   9145: </tr>
                   9146: <tr>
                   9147: <td>openpty</td>
                   9148: <td>-lutil</td>
                   9149: <td>Linux</td>
                   9150: </tr>
                   9151: </tbody>
                   9152: </table>
                   9153: </div>
1.338     nia      9154: <p>To fix these linker errors, it is often sufficient to add
1.87      wiz      9155:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   9156:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338     nia      9157:     <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87      wiz      9158:     bmake</strong></span>.</p>
1.148     asau     9159: <div class="sect3">
1.92      rillig   9160: <div class="titlepage"><div><div><h4 class="title">
1.338     nia      9161: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92      rillig   9162: <p>When you are using the SunPro compiler, there is another
                   9163: possibility. That compiler cannot handle the following code:</p>
                   9164: <pre class="programlisting">
1.100     rillig   9165: extern int extern_func(int);
1.93      rillig   9166: 
1.100     rillig   9167: static inline int
                   9168: inline_func(int x)
                   9169: {
1.92      rillig   9170:         return extern_func(x);
1.100     rillig   9171: }
1.93      rillig   9172: 
1.100     rillig   9173: int main(void)
                   9174: {
1.92      rillig   9175:         return 0;
1.100     rillig   9176: }
1.92      rillig   9177: </pre>
                   9178: <p>It generates the code for <code class="function">inline_func</code> even if
                   9179: that function is never used. This code then refers to
                   9180: <code class="function">extern_func</code>, which can usually not be resolved. To
                   9181: solve this problem you can try to tell the package to disable inlining
                   9182: of functions.</p>
                   9183: </div>
1.343     gutterid 9184: <div class="sect3">
                   9185: <div class="titlepage"><div><div><h4 class="title">
                   9186: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
                   9187: <p>When building for older machine architectures (e.g., i386, PowerPC),
                   9188:   builds may fail because the package expects modern 64-bit atomic functions
                   9189:   which the underlying hardware either doesn't support, or will only support
                   9190:   with specific compiler flags. This is generally handled via inclusion of
                   9191:   mk/atomic64.mk.</p>
                   9192: </div>
1.87      wiz      9193: </div>
1.148     asau     9194: <div class="sect2">
1.87      wiz      9195: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   9196: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      9197: <p>Sometimes packages fail to build because the compiler runs
                   9198:     into an operating system specific soft limit.  With the
                   9199:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338     nia      9200:     to unlimit the resources.  The allowed values are any combination of
                   9201:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>,
                   9202:     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   9203:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>,
                   9204:     <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> and
                   9205:     <span class="quote">&#8220;<span class="quote">virtualsize</span>&#8221;</span>.
1.87      wiz      9206:     Setting this variable is similar to running the shell builtin
1.110     hubertf  9207:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      9208:     segment size or maximum stack size of a process, respectively, to
                   9209:     their hard limits.</p>
1.78      rillig   9210: </div>
1.75      rillig   9211: </div>
1.148     asau     9212: <div class="sect1">
1.75      rillig   9213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9214: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     9215: <div class="sect2">
1.75      rillig   9216: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9217: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  9218: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      9219:     with some operating systems cannot create more than one
                   9220:     directory at a time. As such, you should call
                   9221:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9222: <pre class="programlisting">
1.100     rillig   9223: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9224: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    9225: </pre>
1.338     nia      9226: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
                   9227:     directly, you can also append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   9228:     dir2</code></span>&#8221;</span> to the <code class="varname">INSTALLATION_DIRS</code>
                   9229:     variable, which will automatically do the right thing.</p>
1.75      rillig   9230: </div>
1.148     asau     9231: <div class="sect2">
1.75      rillig   9232: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9233: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      9234: <p>In general, documentation should be installed into
1.87      wiz      9235:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338     nia      9236:     <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87      wiz      9237:     includes the version number of the package).</p>
1.84      wiz      9238: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      9239:     directory where HTML documentation is installed with the
1.338     nia      9240:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag is
                   9241:     needed because otherwise the documentation ends up in
                   9242:     <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
                   9243:     pkgsrc, the HTML documentation should go into the package-specific
                   9244:     directory, just like any other documentation.</p>
1.87      wiz      9245: <p>An exception to the above is that library API documentation
1.322     leot     9246:     generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      9247:     browsers (devhelp) should be left at their default location, which
                   9248:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9249:     documentation can be recognized from files ending in
                   9250:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9251:     (It is also acceptable to install such files in
                   9252:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9253:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9254:     <code class="filename">.devhelp*</code> file must be directly in that
                   9255:     directory then, no additional subdirectory level is allowed in
                   9256:     this case. This is usually achieved by using
1.128     wiz      9257:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      9258:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9259:     though.)</p>
1.75      rillig   9260: </div>
1.148     asau     9261: <div class="sect2">
1.75      rillig   9262: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9263: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   9264: <p>Certain packages, most of them in the games category, install
1.87      wiz      9265:     a score file that allows all users on the system to record their
                   9266:     highscores.  In order for this to work, the binaries need to be
                   9267:     installed setgid and the score files owned by the appropriate
1.142     wiz      9268:     group and/or owner (traditionally the "games" user/group).  Set
                   9269:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      9270:     following variables, documented in more detail in
                   9271:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      9272:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9273:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     9274:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   9275:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   9276:     <code class="varname">GAMEDATA_PERMS</code> and
                   9277:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   9278: <p>An example that illustrates some of the variables described above is
                   9279:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   9280:     used to properly set directory permissions of the directory where the
                   9281:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   9282:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   9283:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   9284:     binary:</p>
                   9285: <pre class="programlisting">
1.223     rillig   9286: USE_GAMESGROUP=         yes
1.210     leot     9287: 
1.223     rillig   9288: BUILD_DEFS+=            VARBASE
1.210     leot     9289: 
1.223     rillig   9290: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   9291: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9292: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    9293: </pre>
1.210     leot     9294: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9295:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9296:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9297:     needed to be accessed by setgid games and
                   9298:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 9299: <p>A package should therefore never hard code file ownership or
1.210     leot     9300:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9301:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9302:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9303:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   9304: </div>
1.148     asau     9305: <div class="sect2">
1.75      rillig   9306: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9307: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9308: <p><code class="varname">DESTDIR</code> support means that a package
                   9309:     installs into a staging directory, not the final location of the
                   9310:     files. Then a binary package is created which can be used for
                   9311:     installation as usual. There are two ways: Either the package must
1.128     wiz      9312:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   9313:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     9314: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9315: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     9316:       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>.
                   9317:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      9318:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   9319:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9320:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9321:       the inclusion.</p></li>
1.128     wiz      9322: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9323:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9324: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9325:       automatically. Many manual rules and pre/post-install often are
                   9326:       incorrect; fix them.</p></li>
1.128     wiz      9327: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9328:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9329: <li class="listitem"><p>In general, packages should support
1.103     wiz      9330:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9331:       DESTDIR.</p></li>
                   9332: </ul></div>
                   9333: </div>
1.148     asau     9334: <div class="sect2">
1.103     wiz      9335: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9336: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9337: <p>Your package may also contain scripts with hardcoded paths to
1.318     nia      9338:       other interpreters besides (or as well as) Perl.  To correct the
1.87      wiz      9339:       full pathname to the script interpreter, you need to set the
                   9340:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9341:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9342: <pre class="programlisting">
1.100     rillig   9343: REPLACE_INTERPRETER+=   tcl
                   9344: REPLACE.tcl.old=        .*/bin/tclsh
                   9345: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9346: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9347: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    9348: </pre>
1.75      rillig   9349: </div>
1.148     asau     9350: <div class="sect2">
1.75      rillig   9351: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9352: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75      rillig   9353: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9354:     the Makefile fragment
                   9355:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9356:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9357:     configuration for such modules as well as various hooks to tune
                   9358:     this configuration.  See comments in this file for
                   9359:     details.</p>
1.75      rillig   9360: <p>Perl5 modules will install into different places depending
1.87      wiz      9361:     on the version of perl used during the build process.  To
                   9362:     address this, pkgsrc will append lines to the
                   9363:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9364:     the installed <code class="filename">.packlist</code> file generated by
                   9365:     most perl5 modules.  This is invoked by defining
                   9366:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9367:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9368:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9369:     e.g.:</p>
1.75      rillig   9370: <pre class="programlisting">
1.153     wiz      9371: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9372: </pre>
1.153     wiz      9373: <p>The perl5 config variables
                   9374:     <code class="varname">installarchlib</code>,
                   9375:     <code class="varname">installscript</code>,
                   9376:     <code class="varname">installvendorbin</code>,
                   9377:     <code class="varname">installvendorscript</code>,
                   9378:     <code class="varname">installvendorarch</code>,
                   9379:     <code class="varname">installvendorlib</code>,
                   9380:     <code class="varname">installvendorman1dir</code>, and
                   9381:     <code class="varname">installvendorman3dir</code> represent those
                   9382:     locations in which components of perl5 modules may be installed,
                   9383:     provided as variable with uppercase and prefixed with
                   9384:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9385:     and may be used by perl5 packages that don't have a packlist.
                   9386:     These variables are also substituted for in the
                   9387:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9388:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9389: </div>
1.148     asau     9390: <div class="sect2">
1.75      rillig   9391: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9392: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
                   9393: <p>Some packages, usually those providing libraries, install
                   9394:     pkg-config files so that their headers and libraries can easily be
                   9395:     found.  The file names end with <code class="filename">.pc</code>.</p>
                   9396: <p>Most of the time, these files only provide the linker flags
                   9397:     for the library, but do not include the flags for setting the
                   9398:     rpath so the libraries can also be found at runtime. Since this is
                   9399:     so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
                   9400:     for this. Many packages generate the <code class="filename">.pc</code> from
                   9401:     <code class="filename">.pc.in</code>, in that case add those files to the
                   9402:     <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
                   9403: <pre class="programlisting">
                   9404: PKGCONFIG_OVERRIDE+=   foo.pc.in
                   9405:     </pre>
                   9406: <p>For packages using meson, the files are generated during
                   9407:     build and you also need to change the phase in which the
                   9408:     replacement is done. For example:</p>
                   9409: <pre class="programlisting">
                   9410: PKGCONFIG_OVERRIDE+=            output/meson-private/foo.pc
                   9411: PKGCONFIG_OVERRIDE_STAGE=       post-build
                   9412:     </pre>
                   9413: </div>
                   9414: <div class="sect2">
                   9415: <div class="titlepage"><div><div><h3 class="title">
                   9416: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.75      rillig   9417: <p>Some packages install info files or use the
1.128     wiz      9418:     <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      9419:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9420:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9421:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9422:     handle registration of the info files in the Info directory
1.128     wiz      9423:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9424:     files registration is either provided by the system, or by a
                   9425:     special purpose package automatically added as dependency if
                   9426:     needed.</p>
1.75      rillig   9427: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9428:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9429:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9430:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9431: <p>The info files for the package should be listed in the
1.87      wiz      9432:     package <code class="filename">PLIST</code>; however any split info files
                   9433:     need not be listed.</p>
1.128     wiz      9434: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9435:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9436:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9437:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9438:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9439:     variable in the package <code class="filename">Makefile</code>. By
                   9440:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9441:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9442:     does not match the required minimum, a build dependency on the
1.322     leot     9443:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      9444:     be added automatically.</p>
1.75      rillig   9445: <p>The build and installation process of the software provided
1.87      wiz      9446:     by the package should not use the
1.110     hubertf  9447:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9448:     info files is the task of the package
                   9449:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9450:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9451: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9452:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9453:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9454:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9455: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9456:     no effect except the logging of a message. The script overriding
1.110     hubertf  9457:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9458:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9459:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9460: </div>
1.148     asau     9461: <div class="sect2">
1.75      rillig   9462: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9463: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.81      rillig   9464: <p>All packages that install manual pages should install them
1.87      wiz      9465:     into the same directory, so that there is one common place to look
                   9466:     for them. In pkgsrc, this place is
                   9467:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9468:     should be used in packages. The default for
                   9469:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9470:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9471:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9472: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9473: <h3 class="title">Note</h3>
1.87      wiz      9474: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9475:     is far from complete.</p>
1.75      rillig   9476: </div>
1.81      rillig   9477: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9478:     <code class="filename">man/</code> as the top level directory for the man
                   9479:     page file entries, and the pkgsrc framework will convert as
                   9480:     needed. In all other places, the correct
                   9481:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9482: <p>Packages that are
                   9483:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9484:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9485:     <code class="filename">./configure</code>
                   9486:     --mandir switch to set where the man pages should be installed.
                   9487:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9488:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9489: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9490:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9491:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9492:     Or if the <code class="filename">./configure</code> script uses
                   9493:     a non-standard use of --mandir, you can set
                   9494:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9495: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      9496:     information on installation of compressed manual pages.</p>
1.75      rillig   9497: </div>
1.148     asau     9498: <div class="sect2">
1.75      rillig   9499: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9500: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9501: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9502:     the fonts database in the directory where they get installed at
                   9503:     installation and deinstallation time.  This can be automatically
                   9504:     done by using the pkginstall framework.</p>
1.75      rillig   9505: <p>You can list the directories where fonts are installed in the
1.87      wiz      9506:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9507:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9508:     <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      9509:     Also make sure that the database file
                   9510:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9511: <p>Note that you should not create new directories for fonts;
1.87      wiz      9512:     instead use the standard ones to avoid that the user needs to
                   9513:     manually configure his X server to find them.</p>
1.75      rillig   9514: </div>
1.148     asau     9515: <div class="sect2">
1.75      rillig   9516: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9517: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9518: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9519:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9520:     etc.), you need to take some extra steps:</p>
1.128     wiz      9521: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9522: <li class="listitem"><p>Include
1.87      wiz      9523:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9524:        your <code class="filename">Makefile</code>, which takes care of
                   9525:        registering those files in system-wide catalogs at
                   9526:        installation and deinstallation time.</p></li>
1.128     wiz      9527: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9528:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9529: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9530:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9531: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9532:        to be added to the SGML catalog.  These come in groups of
                   9533:        three strings; see xmlcatmgr(1) for more information
                   9534:        (specifically, arguments recognized by the 'add' action).
                   9535:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9536: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9537:        to be added to the XML catalog.  These come in groups of three
                   9538:        strings; see xmlcatmgr(1) for more information (specifically,
                   9539:        arguments recognized by the 'add' action).  Note that you will
                   9540:        normally not use this variable.</p></li>
1.75      rillig   9541: </ol></div>
                   9542: </div>
1.148     asau     9543: <div class="sect2">
1.75      rillig   9544: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9545: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9546: <p>If a package provides extensions to the MIME database by
1.87      wiz      9547:     installing <code class="filename">.xml</code> files inside
                   9548:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9549:     need to take some extra steps to ensure that the database is kept
                   9550:     consistent with respect to these new files:</p>
1.128     wiz      9551: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9552: <li class="listitem"><p>Include
1.87      wiz      9553:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9554:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9555:        this same directory, which is reserved for inclusion from
                   9556:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9557:        care of rebuilding the MIME database at installation and
                   9558:        deinstallation time, and disallows any access to it directly
                   9559:        from the package.</p></li>
1.128     wiz      9560: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9561:        <code class="filename">share/mime</code> directory,
                   9562:        <span class="emphasis"><em>except</em></span> for files saved under
                   9563:        <code class="filename">share/mime/packages</code>.  The former are
                   9564:        handled automatically by
                   9565:        the update-mime-database program, but the latter are
                   9566:        package-dependent and must be removed by the package that
                   9567:        installed them in the first place.</p></li>
1.128     wiz      9568: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9569:        from the PLIST.  They will be handled by the shared-mime-info
                   9570:        package.</p></li>
1.75      rillig   9571: </ol></div>
                   9572: </div>
1.148     asau     9573: <div class="sect2">
1.75      rillig   9574: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9575: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.93      rillig   9576: <p>If a package uses intltool during its build, add
                   9577:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9578:     which forces it to use the intltool package provided by pkgsrc,
                   9579:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9580: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9581:     latest available version; this way, the package benefits of any
                   9582:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9583: </div>
1.148     asau     9584: <div class="sect2">
1.75      rillig   9585: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9586: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.374     wiz      9587: <p>If a package contains an rc.d script, it won't be copied into
                   9588:     the startup directory (<code class="filename">/etc/rc.d</code>) by default,
                   9589:     but you can enable copying by setting the option
                   9590:     <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9591:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  With <code class="varname">PKG_RCD_SCRIPTS=YES</code>, rc.d scripts
                   9592:     will be copied into <code class="filename">/etc/rc.d</code> when a package
                   9593:     is installed, but only if the target does not already exist.
                   9594:     Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
                   9595:     only if they have not been modified.
                   9596:     </p>
                   9597: <p>Note that this alone does not enable the service: It must still be
                   9598:     added to <code class="filename">/etc/rc.conf</code>.</p>
1.75      rillig   9599: </div>
1.148     asau     9600: <div class="sect2">
1.75      rillig   9601: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9602: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9603: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9604:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9605:     updated.</p>
1.148     asau     9606: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9607: <h3 class="title">Note</h3>
1.125     wiz      9608: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9609:     packages should install files
1.125     wiz      9610:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9611:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9612: </div>
1.128     wiz      9613: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9614: <li class="listitem"><p>Include
1.125     wiz      9615:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9616:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9617:       database at installation and deinstallation time.</p></li>
1.128     wiz      9618: <li class="listitem">
1.75      rillig   9619: <p>If your package installs files into a texmf
1.87      wiz      9620:       tree other than the one
1.125     wiz      9621:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9622:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9623:       trees that need database update.</p>
1.75      rillig   9624: <p>If your package also installs font map files that need
1.110     hubertf  9625:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9626:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9627:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9628:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9629:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9630:       be run automatically at installation/deinstallation to
                   9631:       enable/disable font map files for TeX output
                   9632:       drivers.</p>
1.75      rillig   9633: </li>
1.128     wiz      9634: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9635:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9636:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9637: </ol></div>
                   9638: </div>
1.148     asau     9639: <div class="sect2">
1.85      jmmv     9640: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9641: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.87      wiz      9642:     emulation</h3></div></div></div>
                   9643: <p>There are some packages that provide libraries and
                   9644:     executables for running binaries from a one operating system
                   9645:     on a different one (if the latter supports it).  One example
                   9646:     is running Linux binaries on NetBSD.</p>
1.322     leot     9647: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9648:     helps in extracting and packaging Linux rpm packages.</p>
                   9649: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9650:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9651:     if all libraries for each installed executable can be found by
                   9652:     the dynamic linker.  Since the standard dynamic linker is run,
                   9653:     this fails for emulation packages, because the libraries used
                   9654:     by the emulation are not in the standard directories.</p>
                   9655: </div>
1.299     rillig   9656: <div class="sect2">
                   9657: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9658: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.299     rillig   9659: <p>If a package installs images under the
                   9660:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9661:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9662:     database, you need to take some extra steps to make sure that the
                   9663:     shared theme directory is handled appropriately and that the cache
                   9664:     database is rebuilt:</p>
                   9665: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9666: <li class="listitem"><p>Include
                   9667:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9668: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9669:        entry that refers to the theme cache.</p></li>
                   9670: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9671:          directories from the <code class="filename">share/icons/hicolor</code>
                   9672:          hierarchy because they will be handled automatically.</p></li>
                   9673: </ol></div>
                   9674: <p>The best way to verify that the PLIST is correct with
                   9675:       respect to the last two points is to regenerate it using
                   9676:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9677: </div>
                   9678: <div class="sect2">
                   9679: <div class="titlepage"><div><div><h3 class="title">
1.369     wiz      9680: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.299     rillig   9681: <p>If a package installs <code class="filename">.desktop</code> files
                   9682:       under <code class="filename">share/applications</code> and these include
                   9683:       MIME information (MimeType key), you need to take extra steps to
                   9684:       ensure that they are registered into the MIME database:</p>
                   9685: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9686: <li class="listitem"><p>Include
                   9687:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9688: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9689:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9690:          It will be handled automatically.</p></li>
                   9691: </ol></div>
                   9692: <p>The best way to verify that the PLIST is correct with
                   9693:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9694:       print-PLIST</strong></span>.</p>
                   9695: </div>
                   9696: </div>
                   9697: <div class="sect1">
                   9698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9699: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9700: <p>In some cases one does not have the time to solve a problem
                   9701:   immediately. In this case, one can plainly mark a package as broken.  For
                   9702:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9703:   reason why the package is broken (similar to the
                   9704:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9705:   the package will immediately be shown this message, and the build
                   9706:   will not be even tried.</p>
                   9707: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9708:   intervals.</p>
                   9709: </div>
                   9710: </div>
                   9711: <div class="chapter">
                   9712: <div class="titlepage"><div><div><h2 class="title">
                   9713: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9714: <div class="toc">
                   9715: <p><b>Table of Contents</b></p>
                   9716: <dl class="toc">
                   9717: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9718: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9719: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9720: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9721: </dl>
                   9722: </div>
                   9723: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9724: site</a>:</p>
                   9725: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9726:   environment, an intuitive and attractive desktop for users, and the
                   9727:   GNOME development platform, an extensive framework for building
                   9728:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9729: <p>pkgsrc provides a seamless way to automatically build and install
                   9730: a complete GNOME environment <span class="emphasis"><em>under many different
                   9731: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9732: the most advanced build and packaging systems for GNOME due to its
                   9733: included technologies buildlink3, the wrappers and tools framework and
                   9734: automatic configuration file management.  Lots of efforts are put into
                   9735: achieving a completely clean deinstallation of installed software
                   9736: components.</p>
                   9737: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9738: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9739: under this operating system.</p>
1.299     rillig   9740: <p>This chapter is aimed at pkgsrc developers and other people
                   9741: interested in helping our GNOME porting and packaging efforts.  It
                   9742: provides instructions on how to manage the existing packages and some
                   9743: important information regarding their internals.</p>
                   9744: <div class="sect1">
                   9745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9746: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9747: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     9749: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.299     rillig   9750:     the core GNOME desktop environment.  It only includes the necessary
                   9751:     bits to get it to boot correctly, although it may lack important
                   9752:     functionality for daily operation.  The idea behind this package is
                   9753:     to let end users build their own configurations on top of this one,
                   9754:     first installing this meta package to achieve a functional setup and
                   9755:     then adding individual applications.</p></li>
1.322     leot     9756: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.299     rillig   9757:     complete installation of the GNOME platform and desktop as defined
                   9758:     by the GNOME project; this is based on the components distributed in
                   9759:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9760:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9761:     official FTP server.  Developer-only tools found in those
                   9762:     directories are not installed unless required by some other
                   9763:     component to work properly.  Similarly, packages from the bindings
                   9764:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9765:     in unless required as a dependency for an end-user component.  This
1.322     leot     9766:     package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
                   9767: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.299     rillig   9768:     Installs all the tools required to build a GNOME component when
                   9769:     fetched from the CVS repository.  These are required to let the
                   9770:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9771: </ul></div>
                   9772: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9773: sorted in a way that eases updates: a package may depend on other
                   9774: packages listed before it but not on any listed after it.  It is very
                   9775: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9776: change it to alphabetical sorting!</em></span></p>
                   9777: </div>
                   9778: <div class="sect1">
                   9779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9780: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9781: <p>Almost all GNOME applications are written in C and use a common
                   9782: set of tools as their build system.  Things get different with the new
                   9783: bindings to other languages (such as Python), but the following will
                   9784: give you a general idea on the minimum required tools:</p>
                   9785: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9786: <li class="listitem">
                   9787: <p>Almost all GNOME applications use the GNU Autotools as their
                   9788:     build system.  As a general rule you will need to tell this to your
                   9789:     package:</p>
                   9790: <pre class="programlisting">
1.338     nia      9791: GNU_CONFIGURE=  yes
                   9792: USE_LIBTOOL=    yes
                   9793: USE_TOOLS+=     gmake
1.299     rillig   9794: </pre>
                   9795: </li>
                   9796: <li class="listitem">
                   9797: <p>If the package uses pkg-config to detect dependencies, add this
                   9798:     tool to the list of required utilities:</p>
                   9799: <pre class="programlisting">
1.338     nia      9800: USE_TOOLS+=     pkg-config
1.299     rillig   9801: </pre>
1.322     leot     9802: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.299     rillig   9803:     the end of the build process to ensure that you did not miss to
                   9804:     specify any dependency in your package and that the version
                   9805:     requirements are all correct.</p>
                   9806: </li>
                   9807: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9808:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9809:     to handle dependencies and to force the package to use the latest
                   9810:     available version.</p></li>
                   9811: <li class="listitem">
                   9812: <p>If the package uses gtk-doc (a documentation generation
                   9813:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9814:     tool is rather big and the distfile should come with pregenerated
                   9815:     documentation anyway; if it does not, it is a bug that you ought to
                   9816:     report.  For such packages you should disable gtk-doc (unless it is
                   9817:     the default):</p>
                   9818: <pre class="programlisting">
1.338     nia      9819: CONFIGURE_ARGS+=        --disable-gtk-doc
1.299     rillig   9820: </pre>
                   9821: <p>The default location of installed HTML files
                   9822:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9823:     and should not be changed unless the package insists on installing
                   9824:     them somewhere else.  Otherwise programs as
                   9825:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9826:     do that with an entry similar to:</p>
                   9827: <pre class="programlisting">
1.338     nia      9828: CONFIGURE_ARGS+=        --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299     rillig   9829: </pre>
                   9830: </li>
                   9831: </ul></div>
                   9832: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9833: files under the installation prefix to maintain databases.  In this
                   9834: context, shared means that those exact same directories and files are
                   9835: used among several different packages, leading to conflicts in the
                   9836: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9837: handle the most common cases, so you have to forget about using
                   9838: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9839: omitting shared files from them.  If you find yourself doing those,
                   9840: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9841: <p>The following table lists the common situations that result in
                   9842: using shared directories or files.  For each of them, the appropriate
                   9843: solution is given.  After applying the solution be sure to
                   9844: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9845: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9846: <div class="table">
                   9847: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9848: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9849: <colgroup>
                   9850: <col>
                   9851: <col>
                   9852: </colgroup>
                   9853: <thead><tr>
                   9854: <th>If the package...</th>
                   9855: <th>Then...</th>
                   9856: </tr></thead>
                   9857: <tbody>
                   9858: <tr>
                   9859: <td>Installs icons under the
                   9860:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9861:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.369     wiz      9862: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, &#8220;Packages installing hicolor icons&#8221;</a>.</td>
1.299     rillig   9863: </tr>
                   9864: <tr>
                   9865: <td>Installs files under
                   9866:         <code class="filename">share/mime/packages</code>.</td>
1.369     wiz      9867: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.299     rillig   9868: </tr>
                   9869: <tr>
                   9870: <td>Installs <code class="filename">.desktop</code> files under
                   9871:         <code class="filename">share/applications</code> and these include MIME
                   9872:         information.</td>
1.369     wiz      9873: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.299     rillig   9874: </tr>
                   9875: </tbody>
                   9876: </table></div>
1.75      rillig   9877: </div>
1.299     rillig   9878: <br class="table-break">
1.75      rillig   9879: </div>
1.148     asau     9880: <div class="sect1">
1.87      wiz      9881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9882: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9883: <p>When seeing GNOME as a whole, there are two kinds of
                   9884: updates:</p>
                   9885: <div class="variablelist"><dl class="variablelist">
                   9886: <dt><span class="term">Major update</span></dt>
                   9887: <dd>
                   9888: <p>Given that there is still a very long way for GNOME 3 (if it
                   9889:       ever appears), we consider a major update one that goes from a
                   9890:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9891:       where <code class="literal">Y</code> is even and greater than
                   9892:       <code class="literal">X</code>.  These are hard to achieve because they
                   9893:       introduce lots of changes in the components' code and almost all
                   9894:       GNOME distfiles are updated to newer versions.  Some of them can
                   9895:       even break API and ABI compatibility with the previous major
                   9896:       version series.  As a result, the update needs to be done all at
                   9897:       once to minimize breakage.</p>
                   9898: <p>A major update typically consists of around 80 package
                   9899:       updates and the addition of some new ones.</p>
                   9900: </dd>
                   9901: <dt><span class="term">Minor update</span></dt>
                   9902: <dd>
                   9903: <p>We consider a minor update one that goes from a
                   9904:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9905:       one where <code class="literal">Y</code> is greater than
                   9906:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9907:       not update all GNOME components, can be done in an incremental way
                   9908:       and do not break API nor ABI compatibility.</p>
                   9909: <p>A minor update typically consists of around 50 package
                   9910:       updates, although the numbers here may vary a lot.</p>
                   9911: </dd>
                   9912: </dl></div>
                   9913: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9914: release (either major or minor), the following steps should be
                   9915: followed:</p>
                   9916: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9917: <li class="listitem">
1.299     rillig   9918: <p>Get a list of all the tarballs that form the new release by
                   9919:     using the following commands.  These will leave the full list of the
                   9920:     components' distfiles into the <code class="filename">list.txt</code>
                   9921:     file:</p>
                   9922: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9923:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9924:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9925: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9926:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9927:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9928: </li>
1.299     rillig   9929: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9930:     bump their version to the release you are updating them to.  The
                   9931:     three meta packages should be always consistent with versioning.
                   9932:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9933:     in them.</p></li>
1.128     wiz      9934: <li class="listitem">
1.299     rillig   9935: <p>For each meta package, update all its
                   9936:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9937:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9938:     newer version (even if found in the FTP) because the meta packages
                   9939:     are supposed to list the exact versions that form a specific GNOME
                   9940:     release.  Exceptions are permitted here if a newer version solves a
                   9941:     serious issue in the overall desktop experience; these typically
                   9942:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9943:     from the developers.</p>
                   9944: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9945:     should be updated to the latest version available (if found in
                   9946:     pkgsrc).  This is the case, for example, of the dependencies on the
1.322     leot     9947:     GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.75      rillig   9948: </li>
1.128     wiz      9949: <li class="listitem">
1.299     rillig   9950: <p>Generate a patch from the modified meta packages and extract the
                   9951:     list of "new" lines.  This will provide you an outline on what
                   9952:     packages need to be updated in pkgsrc and in what order:</p>
                   9953: <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.75      rillig   9954: </li>
1.299     rillig   9955: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9956:     installed packages and start over from scratch at this point.</p></li>
                   9957: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9958:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9959:     it in order.  For major desktop updates none of these should be
                   9960:     committed until the entire set is completed because there are chances
                   9961:     of breaking not-yet-updated packages.</p></li>
                   9962: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9963:     the tree one by one with appropriate log messages.  At the end,
                   9964:     commit the three meta package updates and all the corresponding
                   9965:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9966:     <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>
                   9967: </ol></div>
                   9968: </div>
                   9969: <div class="sect1">
                   9970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9971: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9972: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9973: packages.  Please, it is very important that you always, always,
                   9974: <span class="strong"><strong>always</strong></span> feed back any portability
                   9975: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="12.3.5. Feedback to the author">Section 12.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
                   9976: their attention on portability issues and to ensure that future versions
                   9977: can be built out-of-the box on NetBSD.  The less custom patches in
                   9978: pkgsrc, the easier further updates are.  Those developers in charge of
                   9979: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 9980: <p>The most common places to report bugs are the <a class="ulink" href="https://gitlab.gnome.org/GNOME" target="_top">GNOME's GitLab</a> and the <a class="ulink" href="https://gitlab.freedesktop.org/explore/groups" target="_top">freedesktop.org's
                   9981: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   9982: of them do.  Do not be short on your reports: always provide detailed
                   9983: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 9984: maximum portability and, if at all possible, provide a patch against the
                   9985: main Git branch.  The more verbose you are, the higher chances of your
                   9986: patch being accepted.</p>
1.299     rillig   9987: <p>Also, please avoid using preprocessor magic to fix portability
                   9988: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9989: GNOME to their operating system, the official GNOME sources are now
                   9990: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9991: and similar macros.  This hurts portability.  Please see our patching
                   9992: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, &#8220;Patching guidelines&#8221;</a>) for more
                   9993: details.</p>
                   9994: </div>
1.75      rillig   9995: </div>
1.148     asau     9996: <div class="chapter">
1.75      rillig   9997: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9998: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9999: <div class="toc">
                   10000: <p><b>Table of Contents</b></p>
1.210     leot     10001: <dl class="toc">
1.267     rillig   10002: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   10003: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   10004: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   10005: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   10006: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   10007: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   10008: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   10009: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   10010: </dl>
                   10011: </div>
1.148     asau     10012: <div class="sect1">
1.75      rillig   10013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10014: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   10015: <p>Our policy is that we accept binaries only from pkgsrc
                   10016:        developers to guarantee that the packages don't contain any
                   10017:        trojan horses etc. This is not to annoy anyone but rather to
                   10018:        protect our users! You're still free to put up your home-made
                   10019:        binary packages and tell the world where to get them. NetBSD
                   10020:        developers doing bulk builds and wanting to upload them please
1.267     rillig   10021:        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     10022: builds)</i></a>.</p>
1.75      rillig   10023: </div>
1.148     asau     10024: <div class="sect1">
1.75      rillig   10025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10026: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333     nia      10027: <p>Firstly, you can import new packages into
                   10028:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
                   10029:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   10030:        for details.</p>
                   10031: <p>Next, check that your package is complete, compiles and
1.299     rillig   10032:        runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.333     nia      10033:        document. Run the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10034:        tool and fix any errors that appear.</p>
                   10035: <p>Finally, send a report to the pkgsrc bug tracking system,
1.378     leot     10036:        either with the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      10037:        that, go to the web page
1.289     leot     10038:        <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      10039:        which contains some instructions and a link to a form where you
                   10040:        can submit packages.  The
1.322     leot     10041:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      10042:        also available as a substitute for either of the above two tools.
                   10043:        </p>
1.87      wiz      10044: <p>In the form of the problem report, the category should be
1.128     wiz      10045:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      10046:        and version number, and the description field should contain a
                   10047:        short description of your package (contents of the COMMENT
1.333     nia      10048:        variable or DESCR file are OK).</p>
1.75      rillig   10049: </div>
1.148     asau     10050: <div class="sect1">
1.75      rillig   10051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10052: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   10053: <p>Please note all package additions, updates, moves, and
1.93      rillig   10054:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   10055:        important to keep this file up to date and conforming to the
                   10056:        existing format, because it will be used by scripts to
1.289     leot     10057:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   10058:        sites. Additionally, check the
1.76      rillig   10059:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   10060:        for the package you updated or removed, in case it was mentioned
                   10061:        there.</p>
                   10062: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   10063:        bumped, the change should appear in
1.93      rillig   10064:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   10065:        related or otherwise relevant. Mass bumps that result from a
                   10066:        dependency being updated should not be mentioned. In all other
                   10067:        cases it's the developer's decision.</p>
                   10068: <p>There is a make target that helps in creating proper
1.110     hubertf  10069:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   10070:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   10071:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   10072:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   10073:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  10074:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   10075:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   10076:   For new packages, or package moves or removals, set the
                   10077:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   10078:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  10079:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      10080:   not the same as your NetBSD login name. The target also automatically
                   10081:   removes possibly existing entries for the package in the
                   10082:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     10083:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 10084:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      10085:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   10086:   makes the cvs commands use the main repository.
                   10087:   </p>
1.75      rillig   10088: </div>
1.148     asau     10089: <div class="sect1">
1.75      rillig   10090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10091: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      10092: <p>For several years, there have been mirrors of pkgsrc in
1.375     jkoshy   10093:   fossil, git, and hg. Standard practice when using these tools is to
1.243     wiz      10094:   make the first line of a commit message function as a summary that
                   10095:   can be read without the rest, such as is commonly done with "git log
                   10096:   --oneline". For this reason, we have the following guidelines for
                   10097:   pkgsrc commit messages:</p>
                   10098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10099: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      10100:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      10101:     package, include the name of the package. For updates, include the
                   10102:     version to which it is updated.</p></li>
                   10103: <li class="listitem"><p>Leave the next line empty.</p></li>
                   10104: <li class="listitem"><p>Then come the details for the commit (changes in that
                   10105:     package, reason for a change) and any relevant PRs. Wrap this
                   10106:     section.</p></li>
                   10107: </ul></div>
                   10108: <p>Here is an example:
1.352     wiz      10109: </p>
1.243     wiz      10110: <pre class="programlisting">
1.352     wiz      10111: libxslt: update to 1.0.30
1.243     wiz      10112: 
1.352     wiz      10113: Changes since 1.0.29:
                   10114: ...
                   10115: </pre>
1.243     wiz      10116: <p>
                   10117:   </p>
                   10118: <p>Here is another example:
1.352     wiz      10119: </p>
1.243     wiz      10120: <pre class="programlisting">
1.352     wiz      10121: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.243     wiz      10122: 
1.352     wiz      10123: (rationale)
                   10124: </pre>
1.243     wiz      10125: <p>
                   10126:   </p>
                   10127: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   10128:   allowed on the pkgsrc repository to change commit messages.</p>
                   10129: </div>
                   10130: <div class="sect1">
                   10131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10132: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      10133: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      10134:   access to the pkgsrc repository.</p>
                   10135: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   10136: Start by adding the directory and then files in the directory. Don't
                   10137: forget to add the new package to the category's
                   10138: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   10139: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   10140: <pre class="programlisting">
                   10141: <code class="prompt">$</code> cd .../pkgsrc/category
                   10142: <code class="prompt">$</code> cvs add pkgname
                   10143: <code class="prompt">$</code> cd pkgname
                   10144: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   10145: <code class="prompt">$</code> cvs add patches/p*
                   10146: <code class="prompt">$</code> cvs status | less
1.141     wiz      10147: <code class="prompt">$</code> cvs commit
1.140     wiz      10148: <code class="prompt">$</code> cd ..
1.350     gutterid 10149: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.141     wiz      10150: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     10151: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  10152: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      10153: </pre>
1.87      wiz      10154: <p>The commit message of the initial import should include part of the
1.76      rillig   10155:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      10156:   what the package is/does.</p>
1.140     wiz      10157: <p>Also mention the new package in
                   10158: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   10159: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   10160: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   10161: </div>
1.148     asau     10162: <div class="sect1">
1.75      rillig   10163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10164: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      10165: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   10166:   changes between old and new versions into the commit log when updating
1.87      wiz      10167:   a package. There are various reasons for this:</p>
1.148     asau     10168: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10169: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      10170:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      10171: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      10172:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      10173: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   10174:   repository is very useful for people who read the pkgsrc-changes mailing
                   10175:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      10176:   the package.</p></li>
1.75      rillig   10177: </ul></div>
1.87      wiz      10178: <p>Please also recognize that, just because a new version of a package
1.75      rillig   10179:   has been released, it should not automatically be upgraded in the CVS
                   10180:   repository.  We prefer to be conservative in the packages that are
                   10181:   included in pkgsrc - development or beta packages are not really the
                   10182:   best thing for most places in which pkgsrc is used. Please use your
                   10183:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      10184:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   10185: </div>
1.148     asau     10186: <div class="sect1">
1.75      rillig   10187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10188: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     10189: <p>Renaming packages is not recommended.</p>
1.290     gutterid 10190: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     10191:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     10192: <p>
1.290     gutterid 10193:   Also, when renaming a package, please add
1.282     leot     10194:   the package name and version pattern(s) of the previous package
                   10195:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     10196:   This may be repeated for multiple renames.
                   10197:   The new package would be an exact replacement.
1.282     leot     10198:   Example:
1.122     reed     10199: </p>
1.282     leot     10200: <pre class="programlisting">
                   10201: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   10202: SUPERSEDES+=    optcomp-[0-9]*
                   10203: </pre>
1.128     wiz      10204: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     10205:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   10206:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   10207:   not be an exact replacement but is a suggestion for the replaced
                   10208:   functionality.</p>
                   10209: </div>
1.148     asau     10210: <div class="sect1">
1.122     reed     10211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10212: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     10213: <p>It is preferred that packages are not renamed or moved, but if needed
                   10214:   please follow these steps.
                   10215: </p>
1.128     wiz      10216: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10217: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   10218: <li class="listitem">
1.75      rillig   10219: <p>Remove all CVS dirs.</p>
1.87      wiz      10220: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   10221: <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      10222: <p>and use that for further work.</p>
1.75      rillig   10223: </li>
1.128     wiz      10224: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   10225: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   10226: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   10227: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     10228: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   10229: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   10230: for doing an update using pkgsrc building; for example, it can
1.378     leot     10231: search the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     10232: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   10233: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   10234: it may have multiple matches, so the tool should also check on the
                   10235: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   10236: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   10237: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.351     gutterid 10238: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.75      rillig   10239: place.</p></li>
1.128     wiz      10240: <li class="listitem">
1.75      rillig   10241: <p>Check if any package depends on it:
                   10242: </p>
                   10243: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   10244: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   10245: </li>
1.128     wiz      10246: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   10247: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   10248: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   10249: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   10250: <li class="listitem">
1.75      rillig   10251: <p>Commit the changed and removed files:</p>
                   10252: <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      10253: <p>(and any packages from step 5, of course).</p>
1.75      rillig   10254: </li>
                   10255: </ol></div>
                   10256: </div>
                   10257: </div>
1.148     asau     10258: <div class="chapter">
1.75      rillig   10259: <div class="titlepage"><div><div><h2 class="title">
1.382     wiz      10260: <a name="policies"></a>Chapter 24. pkgsrc Policies</h2></div></div></div>
                   10261: <div class="toc">
                   10262: <p><b>Table of Contents</b></p>
                   10263: <dl class="toc">
                   10264: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   10265: <dd><dl>
                   10266: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   10267: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   10268: </dl></dd>
                   10269: </dl>
                   10270: </div>
                   10271: <div class="sect1">
                   10272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10273: <a name="stability"></a>24.1. Packages for which updating is restricted</h2></div></div></div>
                   10274: <p>In the past, some packages have caused more package failures than others, and we'd like to reduce this in the future.</p>
                   10275: <p>For this reason, pkgsrc-pmc marks some packages with <code class="varname">POLICY_UPDATE_LIMITED</code>. The possible values currently are:
                   10276: </p>
                   10277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10278: <li class="listitem"><p><code class="literal">abi</code> for packages where ABI/API changes often broke the packages depending on them</p></li>
                   10279: <li class="listitem"><p><code class="literal">bootstrap</code> for packages that are used during the pkgsrc bootstrap</p></li>
                   10280: </ul></div>
                   10281: <p>
                   10282: <code class="filename">pkglint</code> will warn when committing updates to these packages.</p>
                   10283: <div class="sect2">
                   10284: <div class="titlepage"><div><div><h3 class="title">
                   10285: <a name="stability.abi"></a>24.1.1. Limited Updates - ABI</h3></div></div></div>
                   10286: <p>Before committing non-micro version updates to packages marked
                   10287:   with <code class="varname">POLICY_UPDATE_LIMITED=abi</code>, a limited bulk
                   10288:   build of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/bulk-test-${PACKAGE}/index.html" target="_top"><code class="filename">meta-pkgs/bulk-test-${PACKAGE}</code></a> needs to be run
                   10289:   and the result posted to the tech-pkg mailing list, highlighting
                   10290:   what packages would stop building (if any).</p>
                   10291: <p>Depending on the result, pkgsrc-pmc then decides:
                   10292:   </p>
                   10293: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10294: <li class="listitem"><p>go ahead with the update</p></li>
                   10295: <li class="listitem"><p>wait for packages X, Y, Z to be fixed (upstream or
                   10296:     locally) with the updated version, which is put in wip in the
                   10297:     meantime</p></li>
                   10298: <li class="listitem"><p>In the second case, all pkgsrc developers are
                   10299:     encouraged to work on fixing this - it is not only the updater's
                   10300:     task to fix them.</p></li>
                   10301: </ul></div>
                   10302: <p>
                   10303:   </p>
                   10304: <p>The decision to wait for packages can be revisited.</p>
                   10305: </div>
                   10306: <div class="sect2">
                   10307: <div class="titlepage"><div><div><h3 class="title">
                   10308: <a name="stability.bootstrap"></a>24.1.2. Limited Updates - Bootstrap</h3></div></div></div>
                   10309: <p>When updating packages used in the bootstrap, i.e. marked with
                   10310:   <code class="varname">POLICY_UPDATE_LIMITED=bootstrap</code>, test the
                   10311:   bootstrap process and preferably some basic packages and send the
                   10312:   patch to the tech-pkg mailing list so it can be tested on other
                   10313:   platforms as well. Give at least two weeks for feedback and testing
                   10314:   by others.</p>
                   10315: </div>
                   10316: </div>
                   10317: </div>
                   10318: <div class="chapter">
                   10319: <div class="titlepage"><div><div><h2 class="title">
                   10320: <a name="devfaq"></a>Chapter 25. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   10321: <p>This section contains the answers to questions that may
                   10322:        arise when you are writing a package. If you don't find your
                   10323:        question answered here, first have a look in the other chapters,
                   10324:        and if you still don't have the answer, ask on the
                   10325:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     10326: <div class="qandaset">
1.289     leot     10327: <a name="devfaq.qandaset"></a><dl>
1.382     wiz      10328: <dt>25.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   10329:        MAKEFLAGS, .MAKEFLAGS and
                   10330:        MAKE_FLAGS?</a>
                   10331: </dt>
1.382     wiz      10332: <dt>25.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   10333:        MAKE, GMAKE and
                   10334:        MAKE_PROGRAM?</a>
                   10335: </dt>
1.382     wiz      10336: <dt>25.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   10337:        CC, PKG_CC and
                   10338:        PKGSRC_COMPILER?</a>
                   10339: </dt>
1.382     wiz      10340: <dt>25.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   10341:        VARNAME=BUILDLINK_PREFIX.foo
                   10342:        say it's empty?</a>
                   10343: </dt>
1.382     wiz      10344: <dt>25.5. <a href="#devfaq.master_sites">What does
1.78      rillig   10345:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   10346:        don't understand the := inside
                   10347:        it.</a>
                   10348: </dt>
1.382     wiz      10349: <dt>25.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   10350:        developers?</a>
                   10351: </dt>
1.382     wiz      10352: <dt>25.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   10353:        documentation?</a>
                   10354: </dt>
1.382     wiz      10355: <dt>25.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289     leot     10356: What shall I do?</a>
1.92      rillig   10357: </dt>
1.75      rillig   10358: </dl>
1.148     asau     10359: <table border="0" style="width: 100%;">
                   10360: <colgroup>
1.75      rillig   10361: <col align="left" width="1%">
1.128     wiz      10362: <col>
1.148     asau     10363: </colgroup>
1.75      rillig   10364: <tbody>
1.148     asau     10365: <tr class="question">
1.75      rillig   10366: <td align="left" valign="top">
1.382     wiz      10367: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>25.1.</b></p>
1.75      rillig   10368: </td>
                   10369: <td align="left" valign="top"><p>What is the difference between
                   10370:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10371:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10372: </tr>
                   10373: <tr class="answer">
1.91      rillig   10374: <td align="left" valign="top"></td>
1.338     nia      10375: <td align="left" valign="top">
                   10376: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.378     leot     10377:        to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.338     nia      10378: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
                   10379:        passed to the <code class="varname">MAKE_PROGRAM</code> when building the
                   10380:        package.</p>
                   10381: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
                   10382:        <span class="command"><strong>bmake</strong></span> and should not be used by
                   10383:        packages.</p>
                   10384: </td>
1.75      rillig   10385: </tr>
1.148     asau     10386: <tr class="question">
1.75      rillig   10387: <td align="left" valign="top">
1.382     wiz      10388: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>25.2.</b></p>
1.75      rillig   10389: </td>
                   10390: <td align="left" valign="top"><p>What is the difference between
                   10391:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10392:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10393: </tr>
                   10394: <tr class="answer">
1.91      rillig   10395: <td align="left" valign="top"></td>
1.338     nia      10396: <td align="left" valign="top">
                   10397: <p><code class="varname">MAKE</code> is the path to the
1.378     leot     10398:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.338     nia      10399:        infrastructure.</p>
                   10400: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
                   10401:        need to say <code class="varname">USE_TOOLS+=gmake</code> to use
                   10402:        that.</p>
                   10403: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
                   10404:        program that is used for building the package.</p>
                   10405: </td>
1.75      rillig   10406: </tr>
1.148     asau     10407: <tr class="question">
1.75      rillig   10408: <td align="left" valign="top">
1.382     wiz      10409: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>25.3.</b></p>
1.75      rillig   10410: </td>
                   10411: <td align="left" valign="top"><p>What is the difference between
                   10412:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10413:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10414: </tr>
                   10415: <tr class="answer">
1.91      rillig   10416: <td align="left" valign="top"></td>
1.75      rillig   10417: <td align="left" valign="top">
1.338     nia      10418: <p><code class="varname">CC</code> is the path to the real C
                   10419:        compiler, which can be configured by the pkgsrc user.</p>
                   10420: <p><code class="varname">PKG_CC</code> is the path to the compiler
                   10421:        wrapper.</p>
                   10422: <p><code class="varname">PKGSRC_COMPILER</code> is
                   10423:        <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
                   10424:        compiler that should be used. See
                   10425:        <code class="filename">mk/compiler.mk</code> for more information about
                   10426:        the latter variable.</p>
1.75      rillig   10427: </td>
                   10428: </tr>
1.148     asau     10429: <tr class="question">
1.75      rillig   10430: <td align="left" valign="top">
1.382     wiz      10431: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>25.4.</b></p>
1.75      rillig   10432: </td>
1.110     hubertf  10433: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10434:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10435:        say it's empty?</p></td>
                   10436: </tr>
                   10437: <tr class="answer">
1.91      rillig   10438: <td align="left" valign="top"></td>
1.75      rillig   10439: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10440:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10441:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10442:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10443:        command.</p></td>
                   10444: </tr>
1.148     asau     10445: <tr class="question">
1.78      rillig   10446: <td align="left" valign="top">
1.382     wiz      10447: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>25.5.</b></p>
1.78      rillig   10448: </td>
                   10449: <td align="left" valign="top"><p>What does
1.220     wiz      10450:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10451:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10452:        it.</p></td>
                   10453: </tr>
                   10454: <tr class="answer">
1.91      rillig   10455: <td align="left" valign="top"></td>
1.338     nia      10456: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
                   10457:        assignment operator, even though it may look like one.
1.78      rillig   10458:        Instead, it is a degenerate form of
1.220     wiz      10459:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.378     leot     10460:        which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10461:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10462:        case of <code class="varname">MASTER_SITE_*</code>,
                   10463:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10464:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10465:        <code class="code">package/</code>. That's where the
                   10466:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10467:        together.</p></td>
                   10468: </tr>
1.148     asau     10469: <tr class="question">
1.78      rillig   10470: <td align="left" valign="top">
1.382     wiz      10471: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>25.6.</b></p>
1.78      rillig   10472: </td>
                   10473: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10474:        developers?</p></td>
                   10475: </tr>
                   10476: <tr class="answer">
1.91      rillig   10477: <td align="left" valign="top"></td>
1.148     asau     10478: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10479: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   10480: <dd><p>This is a list for technical discussions related
                   10481:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10482:        pkgsrc infrastructure, proposed new features, questions related
                   10483:        to porting pkgsrc to a new platform, advice for maintaining a
                   10484:        package, patches that affect many packages, help requests moved
                   10485:        from pkgsrc-users when an infrastructure bug is found,
                   10486:        etc.</p></dd>
1.289     leot     10487: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   10488: <dd><p>All bug reports in category "pkg" sent with
1.378     leot     10489:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.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   10490:        directly; use one of the other mailing
                   10491:        lists.</p></dd>
                   10492: </dl></div></td>
                   10493: </tr>
1.148     asau     10494: <tr class="question">
1.80      rillig   10495: <td align="left" valign="top">
1.382     wiz      10496: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>25.7.</b></p>
1.80      rillig   10497: </td>
                   10498: <td align="left" valign="top"><p>Where is the pkgsrc
                   10499:        documentation?</p></td>
                   10500: </tr>
                   10501: <tr class="answer">
1.91      rillig   10502: <td align="left" valign="top"></td>
1.80      rillig   10503: <td align="left" valign="top">
                   10504: <p>There are many places where you can find
                   10505:        documentation about pkgsrc:</p>
1.148     asau     10506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10507: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10508:        of chapters that explain large parts of pkgsrc, but some
                   10509:        chapters tend to be outdated. Which ones they are is hard to
                   10510:        say.</p></li>
1.289     leot     10511: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   10512:        about certain features, announcements of new parts of the pkgsrc
                   10513:        infrastructure and sometimes even announcements that a certain
                   10514:        feature has been marked as obsolete. The benefit here is that
                   10515:        each message has a date appended to it.</p></li>
1.128     wiz      10516: <li class="listitem"><p>Many of the files in the
1.80      rillig   10517:        <code class="filename">mk/</code> directory start with a comment that
                   10518:        describes the purpose of the file and how it can be used by the
1.92      rillig   10519:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10520:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10521:        help</strong></span>.</p></li>
1.128     wiz      10522: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10523:        information, but they tend to be highly abbreviated, especially
                   10524:        for actions that occur often. Some contain a detailed
                   10525:        description of what has changed, but they are geared towards the
                   10526:        other pkgsrc developers, not towards an average pkgsrc user.
                   10527:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10528:        don't know what has been before, these messages may not be worth
                   10529:        too much to you.</p></li>
1.128     wiz      10530: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10531:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10532:        mind of the developer who wrote the code. To get this
1.110     hubertf  10533:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10534:        to see who has written it and ask on the
                   10535:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10536:        find your questions later (see above). To be sure that the
                   10537:        developer in charge reads the mail, you may CC him or
                   10538:        her.</p></li>
                   10539: </ul></div>
1.299     rillig   10540: </td>
                   10541: </tr>
                   10542: <tr class="question">
                   10543: <td align="left" valign="top">
1.382     wiz      10544: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>25.8.</b></p>
1.299     rillig   10545: </td>
1.338     nia      10546: <td align="left" valign="top"><p>I have a little time to kill.
1.299     rillig   10547: What shall I do?</p></td>
                   10548: </tr>
                   10549: <tr class="answer">
                   10550: <td align="left" valign="top"></td>
                   10551: <td align="left" valign="top">
                   10552: <p>This is not really an FAQ yet, but here's the answer
                   10553: anyway.</p>
1.148     asau     10554: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10555: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322     leot     10556:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.299     rillig   10557:     will tell you about newer versions of installed packages that are
                   10558:     available, but not yet updated in pkgsrc.</p></li>
                   10559: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10560:     &mdash; it contains a list of suggested new packages and a list of
                   10561:     cleanups and enhancements for pkgsrc that would be nice to
                   10562:     have.</p></li>
                   10563: <li class="listitem"><p>Review packages for which review was requested on
                   10564:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10565:     mailing list.</p></li>
1.85      jmmv     10566: </ul></div>
1.299     rillig   10567: </td>
1.85      jmmv     10568: </tr>
                   10569: </tbody>
1.299     rillig   10570: </table>
1.85      jmmv     10571: </div>
                   10572: </div>
1.75      rillig   10573: </div>
1.148     asau     10574: <div class="part">
1.75      rillig   10575: <div class="titlepage"><div><div><h1 class="title">
                   10576: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10577: <div class="partintro">
1.75      rillig   10578: <div></div>
                   10579: <p>This part of the guide deals with everything
                   10580:        from the infrastructure that is behind the interfaces described
                   10581:        in the developer's guide. A casual package maintainer should not
                   10582:        need anything from this part.</p>
                   10583: <div class="toc">
                   10584: <p><b>Table of Contents</b></p>
1.210     leot     10585: <dl class="toc">
1.382     wiz      10586: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10587: <dd><dl>
1.382     wiz      10588: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10589: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10590: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75      rillig   10591: <dd><dl>
1.382     wiz      10592: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10593: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75      rillig   10594: </dl></dd>
1.382     wiz      10595: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10596: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10597: <dd><dl>
1.382     wiz      10598: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10599: <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   10600: </dl></dd>
1.382     wiz      10601: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10602: <dd><dl>
1.382     wiz      10603: <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>
                   10604: <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   10605: </dl></dd>
                   10606: </dl></dd>
1.382     wiz      10607: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig   10608: <dd><dl>
1.382     wiz      10609: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10610: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10611: <dd><dl>
1.382     wiz      10612: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10613: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10614: </dl></dd>
                   10615: </dl></dd>
1.382     wiz      10616: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   10617: <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   10618: </dl>
                   10619: </div>
                   10620: </div>
1.148     asau     10621: <div class="chapter">
1.75      rillig   10622: <div class="titlepage"><div><div><h2 class="title">
1.382     wiz      10623: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10624: <div class="toc">
                   10625: <p><b>Table of Contents</b></p>
1.210     leot     10626: <dl class="toc">
1.382     wiz      10627: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10628: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10629: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig   10630: <dd><dl>
1.382     wiz      10631: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10632: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig   10633: </dl></dd>
1.382     wiz      10634: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10635: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10636: <dd><dl>
1.382     wiz      10637: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10638: <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   10639: </dl></dd>
1.382     wiz      10640: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10641: <dd><dl>
1.382     wiz      10642: <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>
                   10643: <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   10644: </dl></dd>
                   10645: </dl>
                   10646: </div>
                   10647: <p>The pkgsrc infrastructure consists of many small Makefile
                   10648:        fragments. Each such fragment needs a properly specified
                   10649:        interface. This chapter explains how such an interface looks
                   10650:        like.</p>
1.148     asau     10651: <div class="sect1">
1.75      rillig   10652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10653: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10654: <p>Whenever a variable is defined in the pkgsrc
                   10655:        infrastructure, the location and the way of definition provide
                   10656:        much information about the intended use of that variable.
                   10657:        Additionally, more documentation may be found in a header
                   10658:        comment or in this pkgsrc guide.</p>
                   10659: <p>A special file is
                   10660:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10661:        variables that are intended to be user-defined. They are either
                   10662:        defined using the <code class="literal">?=</code> operator or they are
                   10663:        left undefined because defining them to anything would
1.128     wiz      10664:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10665:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10666:        file.</p>
                   10667: <p>Outside this file, the following conventions apply:
                   10668:        Variables that are defined using the <code class="literal">?=</code>
                   10669:        operator may be overridden by a package.</p>
                   10670: <p>Variables that are defined using the <code class="literal">=</code>
                   10671:        operator may be used read-only at run-time.</p>
                   10672: <p>Variables whose name starts with an underscore must not be
                   10673:        accessed outside the pkgsrc infrastructure at all. They may
                   10674:        change without further notice.</p>
1.148     asau     10675: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10676: <h3 class="title">Note</h3>
                   10677: <p>These conventions are currently not applied
                   10678:        consistently to the complete pkgsrc
                   10679:        infrastructure.</p>
                   10680: </div>
                   10681: </div>
1.148     asau     10682: <div class="sect1">
1.81      rillig   10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10684: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10685: <p>All variables that contain lists of things should default
                   10686:        to being empty. Two examples that do not follow this rule are
                   10687:        <code class="varname">USE_LANGUAGES</code> and
                   10688:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10689:        modified using the <code class="literal">+=</code> operator in package
                   10690:        <code class="filename">Makefile</code>s (or other files included by
                   10691:        them), since there is no guarantee whether the variable is
                   10692:        already set or not, and what its value is. In the case of
1.128     wiz      10693:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10694:        the default value and just define it as in the following
                   10695:        example.</p>
                   10696: <pre class="programlisting">
1.100     rillig   10697: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10698: </pre>
                   10699: <p>Because of the selection of this default value, the same
                   10700:        value appears in many package Makefiles. Similarly for
                   10701:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10702:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10703:        doesn't stand out. Nevertheless it is mentioned in many
                   10704:        files.</p>
                   10705: </div>
1.148     asau     10706: <div class="sect1">
1.81      rillig   10707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10708: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148     asau     10709: <div class="sect2">
1.75      rillig   10710: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10711: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75      rillig   10712: <p>Variable evaluation takes place either at load time or at
                   10713:        runtime, depending on the context in which they occur. The
                   10714:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10715: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10716: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10717:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10718: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10719:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10720: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10721: </ul></div>
                   10722: <p>A special exception are references to the iteration
                   10723:        variables of <code class="literal">.for</code> loops, which are expanded
                   10724:        inline, no matter in which context they appear.</p>
                   10725: <p>As the values of variables may change during load time,
                   10726:        care must be taken not to evaluate them by accident. Typical
                   10727:        examples for variables that should not be evaluated at load time
                   10728:        are <code class="varname">DEPENDS</code> and
                   10729:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10730:        clear, here is an example:</p>
                   10731: <pre class="programlisting">
1.100     rillig   10732: CONFIGURE_ARGS=         # none
                   10733: CFLAGS=                 -O
                   10734: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10735: 
1.100     rillig   10736: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10737: 
1.100     rillig   10738: CFLAGS+=                -Wall
1.222     sevan    10739: </pre>
1.75      rillig   10740: <p>This code shows how the use of the <code class="literal">:=</code>
                   10741:        operator can quickly lead to unexpected results. The first
                   10742:        paragraph is fairly common code. The second paragraph evaluates
                   10743:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10744:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10745:        <code class="literal">-Wall</code> is appended to the
                   10746:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10747:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10748:        paragraphs from above typically occur in completely unrelated
                   10749:        files.</p>
                   10750: </div>
1.148     asau     10751: <div class="sect2">
1.75      rillig   10752: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10753: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75      rillig   10754: <p>After all the files have been loaded, the values of the
                   10755:        variables cannot be changed anymore. Variables that are used in
                   10756:        the shell commands are expanded at this point.</p>
                   10757: </div>
                   10758: </div>
1.148     asau     10759: <div class="sect1">
1.75      rillig   10760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10761: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10762: <p>There are many ways in which the definition and use of a
1.218     rillig   10763:        variable can be restricted in order to detect bugs and violations
                   10764:        of the (mostly unwritten) policies. A package can be checked with
                   10765:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10766:        rules.</p>
1.78      rillig   10767: </div>
1.148     asau     10768: <div class="sect1">
1.78      rillig   10769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10770: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10771: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10772:        of the following classes. Cases where a file falls into more
                   10773:        than one class should be avoided as it often leads to subtle
                   10774:        bugs.</p>
1.148     asau     10775: <div class="sect2">
1.75      rillig   10776: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10777: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10778: <p>In a traditional imperative programming language some of
1.76      rillig   10779:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10780:        procedures. They take some input parameters and&mdash;after
                   10781:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10782:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10783:        care must be taken not to use parameter names that have already
                   10784:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10785:        bad choice for a parameter name.</p>
                   10786: <p>Procedures are completely evaluated at preprocessing time.
                   10787:        That is, when calling a procedure all input parameters must be
                   10788:        completely resolvable. For example,
                   10789:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10790:        parameter since it is very likely that further text will be
                   10791:        added after calling the procedure, which would effectively apply
                   10792:        the procedure to only a part of the variable. Also, references
1.218     rillig   10793:        to other variables will be modified after calling the
1.75      rillig   10794:        procedure.</p>
                   10795: <p>A procedure can declare its output parameters either as
                   10796:        suitable for use in preprocessing directives or as only
                   10797:        available at runtime. The latter alternative is for variables
                   10798:        that contain references to other runtime variables.</p>
                   10799: <p>Procedures shall be written such that it is possible to
                   10800:        call the procedure more than once. That is, the file must not
                   10801:        contain multiple-inclusion guards.</p>
                   10802: <p>Examples for procedures are
1.76      rillig   10803:        <code class="filename">mk/bsd.options.mk</code> and
                   10804:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10805:        that the parameters are evaluated at load time, they should be
                   10806:        assigned using the <code class="literal">:=</code> operator, which should
                   10807:        be used only for this purpose.</p>
                   10808: </div>
1.148     asau     10809: <div class="sect2">
1.75      rillig   10810: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10811: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10812: <p>Action files take some input parameters and may define
                   10813:        runtime variables. They shall not define loadtime variables.
                   10814:        There are action files that are included implicitly by the
                   10815:        pkgsrc infrastructure, while other must be included
                   10816:        explicitly.</p>
                   10817: <p>An example for action files is
1.76      rillig   10818:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10819: </div>
                   10820: </div>
1.148     asau     10821: <div class="sect1">
1.81      rillig   10822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10823: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10824: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10825:        a set of variable definitions, and include the file
                   10826:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10827:        Before that, they may also include various other
                   10828:        <code class="filename">*.mk</code> files if they need to query the
                   10829:        availability of certain features like the type of compiler or
                   10830:        the X11 implementation. Due to the heavy use of preprocessor
                   10831:        directives like <code class="literal">.if</code> and
                   10832:        <code class="literal">.for</code>, the order in which the files are loaded
                   10833:        matters.</p>
                   10834: <p>This section describes at which point the various files
                   10835:        are loaded and gives reasons for that order.</p>
1.148     asau     10836: <div class="sect2">
1.81      rillig   10837: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10838: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10839: </h3></div></div></div>
                   10840: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10841:        is to define some essential variables like
                   10842:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10843:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10844: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10845:        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   10846:        After that, those variables
1.81      rillig   10847:        that have not been overridden by the user are loaded from
                   10848:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10849: <p>After the user settings, the system settings and platform
                   10850:        settings are loaded, which may override the user
                   10851:        settings.</p>
                   10852: <p>Then, the tool definitions are loaded. The tool wrappers
                   10853:        are not yet in effect. This only happens when building a
                   10854:        package, so the proper variables must be used instead of the
                   10855:        direct tool names.</p>
                   10856: <p>As the last steps, some essential variables from the
                   10857:        wrapper and the package system flavor are loaded, as well as the
                   10858:        variables that have been cached in earlier phases of a package
                   10859:        build.</p>
                   10860: </div>
1.148     asau     10861: <div class="sect2">
1.81      rillig   10862: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10863: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10864: </h3></div></div></div>
1.81      rillig   10865: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10866: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10867:        loaded, which fill default values for those variables that have
1.93      rillig   10868:        not been defined by the package. These variables may later
1.81      rillig   10869:        be used even in unrelated files.</p>
                   10870: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10871:        provides the target <code class="literal">error-check</code> that is added
                   10872:        as a special dependency to all other targets that use
                   10873:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10874:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10875: <p>Then, the package-specific hacks from
                   10876:        <code class="filename">hacks.mk</code> are included.</p>
                   10877: <p>Then, various other files follow. Most of them don't have
                   10878:        any dependencies on what they need to have included before or
                   10879:        after them, though some do.</p>
                   10880: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10881:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10882:        restricts the use of these variables to all the files that have
                   10883:        been included before. Appearances in later files will be
                   10884:        silently ignored.</p>
                   10885: <p>Then, the files for the main targets are included, in the
                   10886:        order of later execution, though the actual order should not
                   10887:        matter.</p>
                   10888: <p>At last, some more files are included that don't set any
                   10889:        interesting variables but rather just define make targets to be
                   10890:        executed.</p>
                   10891: </div>
                   10892: </div>
1.75      rillig   10893: </div>
1.148     asau     10894: <div class="chapter">
1.75      rillig   10895: <div class="titlepage"><div><div><h2 class="title">
1.382     wiz      10896: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75      rillig   10897: <div class="toc">
                   10898: <p><b>Table of Contents</b></p>
1.210     leot     10899: <dl class="toc">
1.382     wiz      10900: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10901: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10902: <dd><dl>
1.382     wiz      10903: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10904: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10905: </dl></dd>
                   10906: </dl>
                   10907: </div>
                   10908: <p>The pkgsrc infrastructure consists of a large codebase,
                   10909:        and there are many corners where every little bit of a file is
                   10910:        well thought out, making pkgsrc likely to fail as soon as
                   10911:        anything is changed near those parts. To prevent most changes
                   10912:        from breaking anything, a suite of regression tests should go
                   10913:        along with every important part of the pkgsrc infrastructure.
                   10914:        This chapter describes how regression tests work in pkgsrc and
                   10915:        how you can add new tests.</p>
1.148     asau     10916: <div class="sect1">
1.75      rillig   10917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10918: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.322     leot     10919: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10920:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10921:        can simply run that command, which will run all tests in the
1.283     rillig   10922:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10923: </div>
1.148     asau     10924: <div class="sect1">
1.75      rillig   10925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      10926: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10927: <p>Every directory in the <code class="filename">regress/</code>
                   10928:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10929:        is considered a regression test. This file is a shell program
1.110     hubertf  10930:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10931:        The following functions can be overridden to suit your
                   10932:        needs.</p>
1.148     asau     10933: <div class="sect2">
1.75      rillig   10934: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10935: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10936: <p>These functions do not take any parameters. Although they
                   10937:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.289     leot     10938:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10939:        question</a> for details.</p>
1.148     asau     10940: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10941: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10942: <dd><p>This function prepares the environment for the
                   10943:        test. By default it does nothing.</p></dd>
1.218     rillig   10944: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10945: <dd>
                   10946: <p>This function runs the actual test. By default,
1.75      rillig   10947:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10948:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10949:        error messages into the file
1.218     rillig   10950:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10951: <p>When defining this function, make sure that all output that
                   10952:        needs to be checked is written to the correct output file.
                   10953:        Example:</p>
                   10954: <pre class="programlisting">
                   10955: do_test() {
1.223     rillig   10956:         echo "Example output"
1.218     rillig   10957: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10958: </pre>
                   10959: </dd>
                   10960: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10961: <dd>
                   10962: <p>This function is run after the test and is
1.75      rillig   10963:        typically used to compare the actual output from the one that is
                   10964:        expected. It can make use of the various helper functions from
1.218     rillig   10965:        the next section. Example:</p>
                   10966: <pre class="programlisting">
                   10967: check_result() {
1.223     rillig   10968:         exit_status 0
                   10969:         output_require "Example"
                   10970:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10971:         output_prohibit "no such file or directory"
1.283     rillig   10972:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10973: }
                   10974: </pre>
                   10975: </dd>
                   10976: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10977: <dd><p>This function cleans everything up after the
                   10978:        test has been run. By default it does nothing.</p></dd>
                   10979: </dl></div>
                   10980: </div>
1.148     asau     10981: <div class="sect2">
1.75      rillig   10982: <div class="titlepage"><div><div><h3 class="title">
1.382     wiz      10983: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148     asau     10984: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10985: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10986: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10987: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10988: <dd><p>This function compares the exitcode of the
1.218     rillig   10989:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10990:        If they differ, the test will fail.</p></dd>
1.218     rillig   10991: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10992: <dd>
                   10993: <p>This function checks for each of its parameters
                   10994:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10995:        extended regular expression. If it does not, the test will
1.218     rillig   10996:        fail. Example:</p>
                   10997: <pre class="programlisting">
1.219     rillig   10998: output_require "looks fine"
                   10999: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   11000: </pre>
                   11001: </dd>
1.292     leot     11002: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   11003: <dd><p>This function checks for each of its parameters
1.110     hubertf  11004:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   11005:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   11006:        If any of the regular expressions matches, the test will
                   11007:        fail.</p></dd>
                   11008: </dl></div>
                   11009: </div>
                   11010: </div>
                   11011: </div>
1.148     asau     11012: <div class="chapter">
1.75      rillig   11013: <div class="titlepage"><div><div><h2 class="title">
1.382     wiz      11014: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75      rillig   11015: <div class="toc">
                   11016: <p><b>Table of Contents</b></p>
1.382     wiz      11017: <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   11018: </div>
                   11019: <p>The pkgsrc system has already been ported to many
                   11020:        operating systems, hardware architectures and compilers. This
                   11021:        chapter explains the necessary steps to make pkgsrc even more
                   11022:        portable.</p>
1.148     asau     11023: <div class="sect1">
1.75      rillig   11024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.382     wiz      11025: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   11026: <p>To port pkgsrc to a new operating system (called
                   11027:        <code class="literal">MyOS</code> in this example), you need to touch the
                   11028:        following files:</p>
1.148     asau     11029: <div class="variablelist"><dl class="variablelist">
1.93      rillig   11030: <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   11031: <dd><p>This file contains some basic definitions, for
                   11032:        example the name of the C
                   11033:        compiler.</p></dd>
1.76      rillig   11034: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   11035: <dd><p>Insert code that defines the variables
                   11036:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327     wiz      11037:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75      rillig   11038:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   11039:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   11040:        appear in this file.</p></dd>
1.93      rillig   11041: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11042: <dd><p>This file contains the platform-specific
                   11043:        definitions that are used by pkgsrc. Start by copying one of the
                   11044:        other files and edit it to your
                   11045:        needs.</p></dd>
1.93      rillig   11046: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11047: <dd><p>This file defines the paths to all the tools
                   11048:        that are needed by one or the other package in pkgsrc, as well
                   11049:        as by pkgsrc itself. Find out where these tools are on your
                   11050:        platform and add them.</p></dd>
                   11051: </dl></div>
                   11052: <p>Now, you should be able to build some basic packages, like
1.322     leot     11053:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   11054: </div>
                   11055: </div>
                   11056: </div>
1.148     asau     11057: <div class="appendix">
                   11058: <div class="titlepage"><div><div><h1 class="title">
                   11059: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   11060: <div class="toc">
                   11061: <p><b>Table of Contents</b></p>
1.210     leot     11062: <dl class="toc">
1.75      rillig   11063: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   11064: <dd><dl>
                   11065: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   11066: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   11067: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   11068: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   11069: </dl></dd>
                   11070: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   11071: </dl>
                   11072: </div>
                   11073: <p>We checked to find a piece of software that wasn't in the packages
                   11074:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  11075:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   11076:     present in the tree is beyond us, but it's useful for the purposes of
                   11077:     this exercise.</p>
1.148     asau     11078: <div class="sect1">
1.75      rillig   11079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11080: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     11081: <div class="sect2">
1.75      rillig   11082: <div class="titlepage"><div><div><h3 class="title">
                   11083: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   11084: <pre class="programlisting">
1.100     rillig   11085: # $NetBSD$
                   11086: #
1.1       grant    11087: 
1.100     rillig   11088: DISTNAME=       bison-1.25
                   11089: CATEGORIES=     devel
1.286     rillig   11090: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    11091: 
1.136     dholland 11092: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     11093: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   11094: COMMENT=        GNU yacc clone
1.1       grant    11095: 
1.100     rillig   11096: GNU_CONFIGURE=  yes
1.152     wiz      11097: INFO_FILES=     yes
1.1       grant    11098: 
1.100     rillig   11099: .include "../../mk/bsd.pkg.mk"
1.1       grant    11100: </pre>
1.75      rillig   11101: </div>
1.148     asau     11102: <div class="sect2">
1.75      rillig   11103: <div class="titlepage"><div><div><h3 class="title">
                   11104: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   11105: <pre class="programlisting">
1.100     rillig   11106: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.378     leot     11107: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   11108: of the NetBSD source tree is beyond me.
1.1       grant    11109: </pre>
1.75      rillig   11110: </div>
1.148     asau     11111: <div class="sect2">
1.75      rillig   11112: <div class="titlepage"><div><div><h3 class="title">
                   11113: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   11114: <pre class="programlisting">
1.100     rillig   11115: @comment $NetBSD$
                   11116: bin/bison
                   11117: man/man1/bison.1.gz
                   11118: share/bison.simple
                   11119: share/bison.hairy
1.1       grant    11120: </pre>
1.75      rillig   11121: </div>
1.148     asau     11122: <div class="sect2">
1.75      rillig   11123: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   11124: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   11125: <p>The NetBSD package system comes with
1.322     leot     11126:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   11127:        which helps to check the contents of these
                   11128:        files. After installation it is quite easy to use, just change to the
1.286     rillig   11129:        directory of the package you wish to examine and run
1.110     hubertf  11130:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   11131: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   11132: ERROR: Makefile: Each package must define its LICENSE.
                   11133: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   11134: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   11135: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   11136: 1 error, 2 warnings and 1 note found.
                   11137: (Run "pkglint -e" to show explanations.)
                   11138: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   11139: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   11140: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   11141:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   11142:        -Wall</strong></span> for a very thorough check.</p>
                   11143: </div>
                   11144: </div>
1.148     asau     11145: <div class="sect1">
1.75      rillig   11146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11147: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   11148: <p>Create the directory where the package lives,
                   11149:       plus any auxiliary directories:</p>
                   11150: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   11151: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   11152: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   11153: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   11154: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   11155:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   11156:       then continue with fetching the distfile:</p>
                   11157: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    11158: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   11159: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   11160: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11161: ftp: Error retrieving file: 500 Internal error
                   11162: 
                   11163: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   11164: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11165: ftp: Error retrieving file: 500 Internal error
                   11166: 
                   11167: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   11168: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   11169: Successfully retrieved file.</pre>
                   11170: <p>Generate the checksum of the distfile into
1.76      rillig   11171:       <code class="filename">distinfo</code>:</p>
1.88      wiz      11172: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   11173: <p>Now compile:</p>
                   11174: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    11175: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11176: ===&gt;  Extracting for bison-1.25
                   11177: ===&gt;  Patching for bison-1.25
                   11178: ===&gt;   Ignoring empty patch directory
                   11179: ===&gt;  Configuring for bison-1.25
                   11180: creating cache ./config.cache
                   11181: checking for gcc... cc
                   11182: checking whether we are using GNU C... yes
                   11183: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   11184: checking how to run the C preprocessor... cc -E
                   11185: checking for minix/config.h... no
                   11186: checking for POSIXized ISC... no
                   11187: checking whether cross-compiling... no
                   11188: checking for ANSI C header files... yes
                   11189: checking for string.h... yes
                   11190: checking for stdlib.h... yes
                   11191: checking for memory.h... yes
                   11192: checking for working const... yes
                   11193: checking for working alloca.h... no
                   11194: checking for alloca... yes
                   11195: checking for strerror... yes
                   11196: updating cache ./config.cache
                   11197: creating ./config.status
                   11198: creating Makefile
                   11199: ===&gt;  Building for bison-1.25
                   11200: 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
                   11201: 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
                   11202: 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
                   11203: 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
                   11204: 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   11205: 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    11206: 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
                   11207: 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
                   11208: 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
                   11209: 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
                   11210: 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
                   11211: 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
                   11212: 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
                   11213: 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
                   11214: 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
                   11215: 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
                   11216: 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
                   11217: 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
                   11218: 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
                   11219: 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
                   11220: 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
                   11221: 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
                   11222: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   11223: rm -f bison.s1
1.75      rillig   11224: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   11225: <p>Everything seems OK, so install the files:</p>
                   11226: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    11227: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11228: ===&gt;  Installing for bison-1.25
                   11229: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   11230: rm -f /usr/pkg/bin/bison
                   11231: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   11232: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   11233: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   11234: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   11235: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   11236: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   11237: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   11238: ===&gt;  Registering installation for bison-1.25</pre>
                   11239: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  11240:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   11241:       binary package, do this now:</p>
                   11242: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11243: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11244: ===&gt;  Building package for bison-1.25
                   11245: Creating package bison-1.25.tgz
                   11246: Registering depends:.
1.75      rillig   11247: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   11248: <p>Now that you don't need the source and object files
                   11249:       any more, clean up:</p>
                   11250: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   11251: ===&gt;  Cleaning for bison-1.25</pre>
                   11252: </div>
                   11253: </div>
1.148     asau     11254: <div class="appendix">
                   11255: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     11256: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75      rillig   11257: <div class="toc">
                   11258: <p><b>Table of Contents</b></p>
1.210     leot     11259: <dl class="toc">
1.322     leot     11260: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   11261: <dd><dl>
                   11262: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   11263: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   11264: </dl></dd>
                   11265: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   11266: <dd><dl>
                   11267: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   11268: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   11269: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   11270: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   11271: </dl></dd>
                   11272: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   11273: <dd><dl>
                   11274: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   11275: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   11276: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   11277: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   11278: </dl></dd>
1.75      rillig   11279: </dl>
                   11280: </div>
1.322     leot     11281: <p>
                   11282: A number of mechanisms are available in pkgsrc to improve the security of the
                   11283: resulting system. This page describes the mechanisms, and gives hints
                   11284: about detecting and fixing problems.
                   11285: </p>
                   11286: <p>
                   11287: Mechanisms can be enabled individually in
                   11288: <code class="filename">mk.conf</code>, and are
                   11289: individually described below.
                   11290: </p>
                   11291: <p>
                   11292: Typically, a feature will cause some programs to fail to build or work
                   11293: when first enabled. This can be due to latent problems in the
                   11294: program, and can be due to other reasons. After enough testing to
                   11295: have confidence that user problems will be quite rare, individual
                   11296: mechanisms will be enabled by default.
                   11297: </p>
                   11298: <p>
                   11299: For each mechanism, see the Caveats section below for an explanation
                   11300: of what might go wrong at compile time and at run time, and how to
                   11301: notice and address these problems.
                   11302: </p>
1.148     asau     11303: <div class="sect1">
1.75      rillig   11304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11305: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
                   11306: <div class="sect2">
                   11307: <div class="titlepage"><div><div><h3 class="title">
                   11308: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
                   11309: <div class="sect3">
                   11310: <div class="titlepage"><div><div><h4 class="title">
                   11311: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
                   11312: <p>
                   11313: This allows substitute wrappers to be used for some commonly used
                   11314: library functions that do not have built-in bounds checking - but
                   11315: could in some cases.
                   11316: </p>
                   11317: <p>
                   11318: Two mitigation levels are available:
                   11319: </p>
                   11320: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11321: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   11322: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   11323: </ul></div>
                   11324: <p>
                   11325: "strong" has been enabled by default since pkgsrc-2017Q3.
                   11326: </p>
                   11327: </div>
                   11328: <div class="sect3">
                   11329: <div class="titlepage"><div><div><h4 class="title">
                   11330: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
                   11331: <p>
                   11332: This enables a stack-smashing protection mitigation. It is done by adding a
                   11333: guard variable to functions with vulnerable objects. The guards are initialized
                   11334: when a function is entered and then checked when the function exits. The guard
                   11335: check will fail and the program forcibly exited if the variable was modified in
                   11336: the meantime. This can happen in case of buffer overflows or memory corruption,
                   11337: and therefore exposing these bugs.
                   11338: </p>
                   11339: <p>
                   11340: Different mitigation levels are available:
                   11341: </p>
                   11342: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11343: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   11344: by the compiler;</p></li>
                   11345: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   11346: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   11347: two settings above.</p></li>
                   11348: </ul></div>
                   11349: <p>
                   11350: This mitigation is supported by both GCC and clang. It may be supported in
                   11351: additional compilers, possibly under a different name. It is particularly useful
                   11352: for unsafe programming languages, such as C/C++.
                   11353: </p>
                   11354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11355: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   11356: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   11357: </ul></div>
                   11358: <p>More details can be found here:</p>
                   11359: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11360: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11361: </p></li></ul></div>
                   11362: </div>
                   11363: <div class="sect3">
                   11364: <div class="titlepage"><div><div><h4 class="title">
                   11365: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
                   11366: <p>
                   11367: This requests the creation of PIE (Position Independent Executables) for all
                   11368: executables. The PIE mechanism is normally used for shared libraries, so that
                   11369: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11370: useful security properties; however, it is necessary to fully leverage some,
                   11371: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11372: (ASLR), which causes different addresses to be used each time a program is run.
                   11373: This makes it more difficult for an attacker to guess addresses and thus makes
                   11374: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11375: program, instead of the stack and heap only.
                   11376: </p>
                   11377: <p>
                   11378: PIE executables will only be built for toolchains that are known to support PIE.
                   11379: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11380: </p>
                   11381: <p>
                   11382: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11383: </p>
1.75      rillig   11384: </div>
1.325     gutterid 11385: <div class="sect3">
                   11386: <div class="titlepage"><div><div><h4 class="title">
1.334     nia      11387: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322     leot     11388: <p>
                   11389: This also makes the exploitation of some security vulnerabilities more
                   11390: difficult in some cases.
                   11391: </p>
                   11392: <p>Two different mitigation levels are available:</p>
                   11393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11394: <li class="listitem"><p>
1.334     nia      11395: partial (the default): the ELF sections are reordered so that internal data sections
1.322     leot     11396: precede the program's own data sections, and non-PLT GOT is read-only;
                   11397: </p></li>
                   11398: <li class="listitem"><p>
                   11399: full: in addition to partial RELRO, every relocation is performed immediately
1.333     nia      11400: when starting the program, allowing the entire GOT to be read-only.  This
                   11401: can greatly slow down startup of large programs.
1.322     leot     11402: </p></li>
                   11403: </ul></div>
                   11404: <p>
                   11405: This is currently supported by GCC. Many software distributions now enable this
1.335     nia      11406: feature by default, at the "partial" level.
1.322     leot     11407: </p>
                   11408: <p>
                   11409: More details can be found here:
                   11410: </p>
                   11411: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11412: <a class="ulink" href="https://www.redhat.com/en/blog/hardening-elf-binaries-using-relocation-read-only-relro" target="_top">Hardening ELF binaries using Relocation Read-Only (RELRO)</a>
                   11413: </p></li></ul></div>
1.75      rillig   11414: </div>
1.334     nia      11415: </div>
                   11416: <div class="sect2">
                   11417: <div class="titlepage"><div><div><h3 class="title">
                   11418: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
                   11419: <div class="sect3">
                   11420: <div class="titlepage"><div><div><h4 class="title">
                   11421: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
                   11422: <p>
                   11423: With this option, pkgsrc will try to build packages reproducibly. This allows
                   11424: packages built from the same tree and with the same options, to produce
                   11425: identical results bit by bit. This option should be combined with ASLR and
                   11426: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
                   11427: attackers attempting to exploit security vulnerabilities.
                   11428: </p>
                   11429: <p>
                   11430: More details can be found here:
                   11431: </p>
                   11432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11433: <a class="ulink" href="https://reproducible-builds.org/" target="_top">Reproducible Builds - a set of software development practices that create an independently-verifiable path from source to binary code</a>
                   11434: </p></li></ul></div>
                   11435: <p>
                   11436: More work likely needs to be done before pkgsrc is fully reproducible.
                   11437: </p>
                   11438: </div>
1.322     leot     11439: <div class="sect3">
                   11440: <div class="titlepage"><div><div><h4 class="title">
1.334     nia      11441: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322     leot     11442: <p>
                   11443: This uses <code class="literal">-fstack-check</code> with GCC for
                   11444: another stack protection mitigation.
                   11445: </p>
                   11446: <p>
                   11447: It asks the compiler to generate code verifying that it does not corrupt the
                   11448: stack. According to GCC's manual page, this is really only useful for
                   11449: multi-threaded programs.
                   11450: </p>
1.76      rillig   11451: </div>
                   11452: </div>
                   11453: </div>
1.148     asau     11454: <div class="sect1">
1.76      rillig   11455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11456: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
                   11457: <div class="sect2">
                   11458: <div class="titlepage"><div><div><h3 class="title">
                   11459: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
                   11460: <div class="sect3">
                   11461: <div class="titlepage"><div><div><h4 class="title">
                   11462: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
                   11463: <p>
                   11464: A number of packages may fail to build with this option enabled. The
                   11465: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11466: compilation flag when building libraries or executables (or ideally
                   11467: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11468: <code class="varname">CFLAGS</code> already, but requires the package to
                   11469: actually support it.
                   11470: </p>
                   11471: <div class="sect4">
                   11472: <div class="titlepage"><div><div><h5 class="title">
                   11473: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
                   11474: <p>
                   11475: These instructions are meant as a reference only; they likely need to be adapted
                   11476: for many packages individually.
                   11477: </p>
                   11478: <p>
                   11479: For packages using <code class="filename">Makefiles</code>:
                   11480: </p>
                   11481: <pre class="programlisting">
                   11482: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11483: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11484: </pre>
                   11485: <p>
                   11486: For packages using <code class="filename">Imakefiles</code>:
                   11487: </p>
                   11488: <pre class="programlisting">
                   11489: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11490: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11491: </pre>
                   11492: </div>
                   11493: </div>
                   11494: <div class="sect3">
                   11495: <div class="titlepage"><div><div><h4 class="title">
                   11496: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
                   11497: <p>
                   11498: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11499: scenarios are essentially possible. This is nearly always due to a bug in
                   11500: the program being exposed due to ASLR.
                   11501: </p>
                   11502: </div>
                   11503: <div class="sect3">
                   11504: <div class="titlepage"><div><div><h4 class="title">
                   11505: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
                   11506: <p>
                   11507: Ideally, packages should be fixed for compatibility with MKPIE.
                   11508: However, in some cases this is very difficult, due to complex build systems,
                   11509: packages using non-standard toolchains, or programming languages with odd
                   11510: bootstrapping mechanisms.
                   11511: </p>
                   11512: <p>
                   11513: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11514: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11515: <code class="filename">bsd.prefs.mk</code> is included.
                   11516: </p>
                   11517: </div>
                   11518: </div>
                   11519: <div class="sect2">
                   11520: <div class="titlepage"><div><div><h3 class="title">
                   11521: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
                   11522: <div class="sect3">
                   11523: <div class="titlepage"><div><div><h4 class="title">
                   11524: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
                   11525: <p>
                   11526: This feature makes use of pre-processing directives to look for hardened,
                   11527: alternative implementations of essential library calls. Some programs may fail
                   11528: to build as a result; this usually happens for those trying too hard to be
                   11529: portable, or otherwise abusing definitions in the standard library.
                   11530: </p>
                   11531: </div>
                   11532: <div class="sect3">
                   11533: <div class="titlepage"><div><div><h4 class="title">
                   11534: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
                   11535: <p>
                   11536: This feature may cause some programs to crash, usually indicating an
                   11537: actual bug in the program. The fix will typically involve patching the
                   11538: original program's source code.
                   11539: </p>
                   11540: </div>
                   11541: <div class="sect3">
                   11542: <div class="titlepage"><div><div><h4 class="title">
                   11543: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
                   11544: <p>
                   11545: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11546: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11547: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11548: optimization level. This cannot easily be applied globally, as some packages
                   11549: may require specific optimization levels.
                   11550: </p>
                   11551: </div>
                   11552: <div class="sect3">
                   11553: <div class="titlepage"><div><div><h4 class="title">
                   11554: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
                   11555: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11556: <h3 class="title">Note</h3>
                   11557: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11558: the program!  This is a very bad idea and will expose you to security
                   11559: vulnerabilities.
                   11560: </p>
                   11561: </div>
                   11562: <p>
                   11563: To disable FORTIFY on a per-package basis, set the following
                   11564: in the package's <code class="filename">Makefile</code>
                   11565: before <code class="filename">bsd.prefs.mk</code> is included:
                   11566: </p>
                   11567: <pre class="programlisting">
                   11568: FORTIFY_SUPPORTED=     no
                   11569: </pre>
                   11570: </div>
                   11571: </div>
                   11572: <div class="sect2">
                   11573: <div class="titlepage"><div><div><h3 class="title">
                   11574: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
                   11575: <div class="sect3">
                   11576: <div class="titlepage"><div><div><h4 class="title">
                   11577: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
                   11578: <p>
                   11579: For better protection, full RELRO requires every symbol to be resolved when the
                   11580: program starts, rather than simply when required at run-time. This will have
                   11581: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11582: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11583: background are affected only when started. Programs loading plug-ins at
                   11584: run-time are affected when loading the plug-ins.
                   11585: </p>
                   11586: <p>
                   11587: The impact is not expected to be noticeable on modern hardware, except in some
                   11588: cases for big programs.
                   11589: </p>
                   11590: </div>
                   11591: <div class="sect3">
                   11592: <div class="titlepage"><div><div><h4 class="title">
                   11593: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
                   11594: <p>
                   11595: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11596: RELRO: for instance, with an initialization routine listing any other plug-in
                   11597: required. With full RELRO, the missing symbols are resolved before the
                   11598: initialization routine can run, and the dynamic loader will not be able to find
                   11599: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11600: drivers. Partial RELRO can be applied instead in this case.
                   11601: </p>
                   11602: </div>
                   11603: <div class="sect3">
                   11604: <div class="titlepage"><div><div><h4 class="title">
                   11605: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
                   11606: <p>
                   11607: To disable RELRO on a per-package basis, set the following
                   11608: in the package's <code class="filename">Makefile</code>
                   11609: before <code class="filename">bsd.prefs.mk</code> is included:
                   11610: </p>
                   11611: <pre class="programlisting">
                   11612: RELRO_SUPPORTED=       no
                   11613: </pre>
1.324     nia      11614: <p>
                   11615: It is also possible to at most enable partial RELRO, by
                   11616: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11617: </p>
1.322     leot     11618: </div>
                   11619: </div>
                   11620: <div class="sect2">
                   11621: <div class="titlepage"><div><div><h3 class="title">
                   11622: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
                   11623: <div class="sect3">
                   11624: <div class="titlepage"><div><div><h4 class="title">
                   11625: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
                   11626: <p>
                   11627: The stack-smashing protection provided by this option does not work for some
                   11628: programs. The most common situation in which this happens is when the program
                   11629: allocates variables on the stack, with the size determined at run-time.
                   11630: </p>
                   11631: </div>
                   11632: <div class="sect3">
                   11633: <div class="titlepage"><div><div><h4 class="title">
                   11634: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
                   11635: <p>
                   11636: Again, this feature may cause some programs to crash via a
                   11637: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11638: </p>
                   11639: <p>
                   11640: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11641: messages are sent and - by default -
                   11642: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11643: </p>
                   11644: <pre class="programlisting">
                   11645: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11646: </pre>
                   11647: <p>
                   11648: (where <code class="literal">hostname</code> is the hostname(1) and
                   11649: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11650: </p>
                   11651: <p>
                   11652: Patching the original program is then required.
                   11653: </p>
                   11654: <p>
                   11655: Rebuilding the package via:
                   11656: </p>
                   11657: <pre class="programlisting">
                   11658: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11659: </pre>
                   11660: <p>
                   11661: and inspecting the backtrace of the coredump via the debugger
                   11662: should point out the problematic call by inspecting the frame
                   11663: calling the _chk() (SSP) function.
                   11664: </p>
                   11665: </div>
                   11666: <div class="sect3">
                   11667: <div class="titlepage"><div><div><h4 class="title">
                   11668: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
                   11669: <p>
                   11670: The compiler emits extra code when using this feature: a check for buffer
                   11671: overflows is performed when entering and exiting functions, requiring an extra
                   11672: variable on the stack. The level of protection can otherwise be adjusted to
                   11673: affect only those functions considered more sensitive by the compiler (with
                   11674: -fstack-protector instead of -fstack-protector-all).
                   11675: </p>
                   11676: <p>
                   11677: The impact is not expected to be noticeable on modern hardware. However,
                   11678: programs with a hard requirement to run at the fastest possible speed should
                   11679: avoid using this feature, or using libraries built with this feature.
                   11680: </p>
                   11681: </div>
                   11682: <div class="sect3">
                   11683: <div class="titlepage"><div><div><h4 class="title">
                   11684: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
                   11685: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11686: <h3 class="title">Note</h3>
                   11687: <p>SSP should not be disabled to work around runtime crashes in
                   11688: the program!  This is a very bad idea and will expose you to security
                   11689: vulnerabilities.</p>
                   11690: </div>
                   11691: <p>
                   11692: To disable SSP on a per-package basis, set the following
                   11693: in the package's <code class="filename">Makefile</code>
                   11694: before <code class="filename">bsd.prefs.mk</code> is included:
                   11695: </p>
                   11696: <pre class="programlisting">
                   11697: SSP_SUPPORTED= no
                   11698: </pre>
                   11699: </div>
                   11700: </div>
                   11701: </div>
                   11702: <div class="sect1">
                   11703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11704: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
                   11705: <p>
                   11706: The illusion of security is worse than having no security at all. This section
                   11707: lists a number of ways to ensure the security features requested are actually
                   11708: effective.
                   11709: </p>
                   11710: <p>
                   11711: These instructions were obtained and tested on a system derived from NetBSD 7
                   11712: (amd64). YMMV.
                   11713: </p>
                   11714: <div class="sect2">
                   11715: <div class="titlepage"><div><div><h3 class="title">
                   11716: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
                   11717: <p>
                   11718: The ELF executable type in use changes for binaries built as PIE; without:
                   11719: </p>
                   11720: <pre class="programlisting">
                   11721: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11722: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
                   11723: </pre>
                   11724: <p>as opposed to the following binary, built as PIE:</p>
                   11725: <pre class="programlisting">
                   11726: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11727: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
                   11728: </pre>
                   11729: <p>
                   11730: The latter result is then what is expected.
                   11731: </p>
                   11732: </div>
                   11733: <div class="sect2">
                   11734: <div class="titlepage"><div><div><h3 class="title">
                   11735: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
                   11736: <p>
                   11737: The following command should list a section called RELRO:
                   11738: </p>
                   11739: <pre class="programlisting">
                   11740: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11741: 
                   11742: /path/to/bin/ary:     file format elf64-x86-64
                   11743: 
                   11744: Program Header:
                   11745: [...]
                   11746:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11747: </pre>
                   11748: <p>
                   11749: This check is now performed automatically if
                   11750: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11751: </p>
                   11752: </div>
                   11753: <div class="sect2">
                   11754: <div class="titlepage"><div><div><h3 class="title">
                   11755: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
                   11756: <p>
                   11757: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11758: the <code class="varname">BIND_NOW</code> flag:
                   11759: </p>
                   11760: <pre class="programlisting">
                   11761: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11762: 
                   11763: /path/to/bin/ary:     file format elf64-x86-64
                   11764: 
                   11765: Dynamic Section:
                   11766: [...]
                   11767:   BIND_NOW             0x0000000000000000
                   11768: </pre>
                   11769: <p>
                   11770: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11771: </p>
                   11772: <p>
                   11773: This check is now performed automatically (where supported) if
                   11774: <code class="varname">PKG_DEVELOPER</code> is set.
                   11775: </p>
                   11776: </div>
                   11777: <div class="sect2">
                   11778: <div class="titlepage"><div><div><h3 class="title">
                   11779: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323     nia      11780: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11781: <h3 class="title">Note</h3>
                   11782: <p>
                   11783: Checking for SSP using this method only works where the operating system
                   11784: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11785: on recent NetBSD/FreeBSD/Linux versions.
                   11786: </p>
                   11787: </div>
1.322     leot     11788: <p>
                   11789: Building objects, binaries and libraries with SSP will affect the presence of
                   11790: additional symbols in the resulting file:
                   11791: </p>
                   11792: <pre class="programlisting">
                   11793: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11794: [...]
                   11795:                  U __stack_chk_fail
                   11796: 0000000000600ea0 B __stack_chk_guard
                   11797: </pre>
                   11798: <p>
                   11799: This is an indicator that the program was indeed built with support for SSP.
                   11800: </p>
                   11801: <p>
                   11802: This check is now performed automatically (where supported) if
                   11803: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11804: </p>
                   11805: </div>
                   11806: </div>
                   11807: </div>
                   11808: <div class="appendix">
                   11809: <div class="titlepage"><div><div><h1 class="title">
                   11810: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
                   11811: <div class="toc">
                   11812: <p><b>Table of Contents</b></p>
                   11813: <dl class="toc">
                   11814: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11815: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11816: </dl>
                   11817: </div>
                   11818: <div class="sect1">
                   11819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11820: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
                   11821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11822: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11823: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11824: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11825: =&gt; [172219 bytes]
                   11826: Connected to ftp.plig.net.
                   11827: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11828: 331 Guest login ok, send your complete e-mail address as password.
                   11829: 230-You are user #5 of 500 simultaneous users allowed.
                   11830: 230-
                   11831: 230-  ___ _             _ _
                   11832: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11833: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11834: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11835: 230-         |_|   |_|     |___|         |___|
                   11836: 230-
                   11837: 230-** Welcome to ftp.plig.org **
                   11838: 230-
                   11839: 230-Please note that all transfers from this FTP site are logged. If you
                   11840: 230-do not like this, please disconnect now.
                   11841: 230-
                   11842: 230-This archive is available via
                   11843: 230-
                   11844: 230-HTTP:  http://ftp.plig.org/
                   11845: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11846: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11847: 230-
                   11848: 230-Please email comments, bug reports and requests for packages to be
                   11849: 230-mirrored to ftp-admin@plig.org.
                   11850: 230-
                   11851: 230-
                   11852: 230 Logged in anonymously.
                   11853: Remote system type is UNIX.
                   11854: Using binary mode to transfer files.
                   11855: 200 Type okay.
                   11856: 250 "/pub" is new cwd.
                   11857: 250-"/pub/figlet" is new cwd.
                   11858: 250-
                   11859: 250-Welcome to the figlet archive at ftp.figlet.org
                   11860: 250-
                   11861: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11862: 250-
                   11863: 250-The official FIGlet web page is:
                   11864: 250-   http://www.figlet.org/
                   11865: 250-
                   11866: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11867: 250-contribute a font or something else, you can email us.
                   11868: 250
                   11869: 250 "/pub/figlet/program" is new cwd.
                   11870: 250 "/pub/figlet/program/unix" is new cwd.
                   11871: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11872: 502 Unimplemented command.
                   11873: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11874: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11875: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11876: 226 Transfer completed.
                   11877: 172219 bytes received in 00:02 (75.99 KB/s)
                   11878: 221 Goodbye.
                   11879: =&gt; Checksum OK for figlet221.tar.gz.
                   11880: ===&gt; Extracting for figlet-2.2.1nb2
                   11881: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11882: ===&gt; Patching for figlet-2.2.1nb2
                   11883: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11884: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11885: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11886: ===&gt; Configuring for figlet-2.2.1nb2
                   11887: ===&gt; Building for figlet-2.2.1nb2
                   11888: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11889: chmod a+x figlet
                   11890: gcc -O2 -o chkfont chkfont.c
                   11891: =&gt; Unwrapping files-to-be-installed.
                   11892: <code class="prompt">#</code>
                   11893: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11894: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11895: ===&gt; Installing for figlet-2.2.1nb2
                   11896: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11897: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11898: mkdir -p /usr/pkg/share/figlet
                   11899: cp figlet /usr/pkg/bin
                   11900: cp chkfont /usr/pkg/bin
                   11901: chmod 555 figlist showfigfonts
                   11902: cp figlist /usr/pkg/bin
                   11903: cp showfigfonts /usr/pkg/bin
                   11904: cp fonts/*.flf /usr/pkg/share/figlet
                   11905: cp fonts/*.flc /usr/pkg/share/figlet
                   11906: cp figlet.6 /usr/pkg/man/man6
                   11907: ===&gt; Registering installation for figlet-2.2.1nb2
                   11908: <code class="prompt">#</code></pre>
                   11909: </div>
                   11910: <div class="sect1">
                   11911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11912: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
                   11913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11914: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11915: ===&gt; Packaging figlet-2.2.1nb2
                   11916: ===&gt; Building binary package for figlet-2.2.1nb2
                   11917: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11918: Using SrcDir value of /usr/pkg
                   11919: Registering depends:.
                   11920: <code class="prompt">#</code></pre>
                   11921: </div>
                   11922: </div>
                   11923: <div class="appendix">
                   11924: <div class="titlepage"><div><div><h1 class="title">
                   11925: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
                   11926: <div class="toc">
                   11927: <p><b>Table of Contents</b></p>
                   11928: <dl class="toc">
                   11929: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11930: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11931: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11932: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11933: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   11934: <code class="filename">stable</code>,
                   11935: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   11936: source packages</a></span></dt>
                   11937: </dl>
                   11938: </div>
                   11939: <p>As in other big projects, the directory layout of pkgsrc
                   11940:        is quite complex for newbies. This chapter explains where you
                   11941:        find things on the FTP server. The base directory on
                   11942:        <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>.
                   11943:        On other servers it may be different, but inside this directory,
                   11944:        everything should look the same, no matter on which server you
                   11945:        are. This directory contains some subdirectories, which are
                   11946:        explained below.</p>
                   11947: <div class="sect1">
                   11948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11949: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11950: <p>The directory <code class="filename">distfiles</code> contains lots
                   11951:        of archive files from all pkgsrc packages, which are mirrored
                   11952:        here. The subdirectories are called after their package names
                   11953:        and are used when the distributed files have names that don't
                   11954:        explicitly contain a version number or are otherwise too generic
                   11955:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11956: </div>
                   11957: <div class="sect1">
                   11958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11959: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11960: <p>This directory contains things that individual pkgsrc
                   11961:        developers find worth publishing.</p>
                   11962: </div>
                   11963: <div class="sect1">
                   11964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11965: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11966: <p>This directory contains binary packages for the various
                   11967:        platforms that are supported by pkgsrc.
                   11968:        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>
                   11969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11970: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   11971:        operating system for which the packages have been built. The
                   11972:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   11973:        command, so it may differ from the one you are used to
                   11974:        hear.</p></li>
                   11975: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   11976:        architecture of the platform for which the packages have been
                   11977:        built. It also includes the <code class="varname">ABI</code> (Application
                   11978:        Binary Interface) for platforms that have several of
                   11979:        them.</p></li>
                   11980: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.370     gdt      11981:        the operating system.  Typically it is the version defining an
                   11982:        ABI, e.g. 9.0.</p></li>
1.322     leot     11983: <li class="listitem"><p><code class="varname">TAG</code> is either
1.370     gdt      11984:        <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
                   11985:        for a stable branch, or <code class="literal">current</code> for packages
1.322     leot     11986:        built from the HEAD branch. The latter should only be used when
1.370     gdt      11987:        the packages are updated on a regular basis.</p></li>
1.322     leot     11988: </ul></div>
1.370     gdt      11989: <p>The rationale for this scheme is that users can first
                   11990:        search by OPSYS and ARCH, since these are more or less
                   11991:        unchangeable.  After that, there is a management set of
                   11992:        directories with OSVERSION and TAG.</p>
                   11993: <p>See also <code class="filename">README.md</code> in
                   11994:        <code class="filename">packages</code> for more details, including
                   11995:        about symlinks.</p>
1.322     leot     11996: <p>In each of these directories, there is a
                   11997:        whole binary packages collection for a specific platform. It has a directory called
                   11998:        <code class="filename">All</code> which contains all binary packages.
1.370     gdt      11999:        </p>
1.322     leot     12000: </div>
                   12001: <div class="sect1">
                   12002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   12003: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   12004: <p>Here are the reports from bulk builds, for those who want
                   12005:        to fix packages that didn't build on some of the platforms. The
1.322     leot     12006:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   12007: </div>
1.148     asau     12008: <div class="sect1">
1.108     rillig   12009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     12010: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261     leot     12011: <code class="filename">stable</code>,
1.126     jakllsch 12012: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   12013: source packages</h2></div></div></div>
1.128     wiz      12014: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   12015:        that is the files that define how to create binary packages from
                   12016:        source archives.</p>
1.262     leot     12017: <p>Each of the <code class="filename">current</code>,
                   12018:        <code class="filename">stable</code> and
                   12019:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12020:        directories share the same structure.  They each contain a
                   12021:        <code class="filename">pkgsrc</code> directory and
                   12022:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   12023: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   12024:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     12025:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   12026:        as the directory, ready to be downloaded as a whole.</p>
                   12027: <p>The <code class="filename">current</code> directory contains files
                   12028:        related to the HEAD branch of the CVS repository.
                   12029:        In this directory there is an additional file called
                   12030:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   12031:        all pkgsrc <code class="filename">README</code>s with information about
                   12032:        categories and packages.
                   12033:        </p>
                   12034: <p>The <code class="filename">stable</code> directory is a symlink to
                   12035:        the latest 
                   12036:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12037:        </p>
                   12038: <p>The
                   12039:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12040:        directories contain files related to the 
                   12041:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12042:        stable branch of the CVS repository. In these directories there is
                   12043:        an additional file called
                   12044:        <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   12045:        which contains the state of pkgsrc when it was branched.</p>
                   12046: </div>
1.75      rillig   12047: </div>
1.148     asau     12048: <div class="appendix">
                   12049: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     12050: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267     rillig   12051: <p>
                   12052:        The following list contains all help topics that are available
                   12053:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   12054: </p>
1.269     leot     12055: <table border="0" summary="Simple list" class="simplelist">
                   12056: <tr>
                   12057: <td>#!</td>
                   12058: <td>-lintl</td>
                   12059: </tr>
                   12060: <tr>
1.320     wiz      12061: <td>32bit</td>
1.269     leot     12062: <td>64bit</td>
1.320     wiz      12063: </tr>
                   12064: <tr>
1.269     leot     12065: <td>ABI</td>
1.320     wiz      12066: <td>ACCEPTABLE_LICENSES</td>
1.269     leot     12067: </tr>
                   12068: <tr>
                   12069: <td>ACROREAD_FONTPATH</td>
1.384   ! leot     12070: <td>AFAIK</td>
1.269     leot     12071: </tr>
                   12072: <tr>
1.320     wiz      12073: <td>AIX</td>
1.384   ! leot     12074: <td>ALLOW_NETWORK_ACCESS</td>
1.269     leot     12075: </tr>
                   12076: <tr>
1.357     gutterid 12077: <td>ALLOW_NEWER_COMPILER</td>
1.384   ! leot     12078: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.269     leot     12079: </tr>
                   12080: <tr>
1.357     gutterid 12081: <td>ALL_ENV</td>
1.384   ! leot     12082: <td>ALSA_PC</td>
1.369     wiz      12083: </tr>
                   12084: <tr>
1.368     gutterid 12085: <td>ALTERNATIVES_SRC</td>
1.384   ! leot     12086: <td>AMANDA_TMP</td>
1.382     wiz      12087: </tr>
                   12088: <tr>
                   12089: <td>AMANDA_USER</td>
1.384   ! leot     12090: <td>AMANDA_VAR</td>
1.378     leot     12091: </tr>
                   12092: <tr>
1.382     wiz      12093: <td>APACHE_GROUP</td>
1.384   ! leot     12094: <td>APACHE_MODULE_NAME</td>
1.376     wiz      12095: </tr>
                   12096: <tr>
1.382     wiz      12097: <td>APACHE_MODULE_SRC</td>
1.384   ! leot     12098: <td>APACHE_MODULE_SRCDIR</td>
1.367     gdt      12099: </tr>
                   12100: <tr>
1.382     wiz      12101: <td>APACHE_PKG_PREFIX</td>
1.384   ! leot     12102: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.360     leot     12103: </tr>
                   12104: <tr>
1.382     wiz      12105: <td>APACHE_SUEXEC_DOCROOT</td>
1.384   ! leot     12106: <td>APACHE_USER</td>
1.355     rillig   12107: </tr>
                   12108: <tr>
1.382     wiz      12109: <td>ARGMAX_REQ</td>
1.384   ! leot     12110: <td>ARG_MAX</td>
1.352     wiz      12111: </tr>
                   12112: <tr>
1.382     wiz      12113: <td>ARLA_CACHE</td>
1.384   ! leot     12114: <td>AUDIT_PACKAGES_FLAGS</td>
1.348     wiz      12115: </tr>
                   12116: <tr>
1.382     wiz      12117: <td>AUTOCONF_REQD</td>
1.384   ! leot     12118: <td>AUTOMAKE_OVERRIDE</td>
1.342     wiz      12119: </tr>
                   12120: <tr>
1.382     wiz      12121: <td>AUTOMAKE_REQD</td>
1.384   ! leot     12122: <td>AUTO_MKDIRS</td>
1.376     wiz      12123: </tr>
                   12124: <tr>
1.382     wiz      12125: <td>AUX</td>
1.384   ! leot     12126: <td>BDB185_DEFAULT</td>
1.338     nia      12127: </tr>
                   12128: <tr>
1.382     wiz      12129: <td>BDBBASE</td>
1.384   ! leot     12130: <td>BDB_ACCEPTED</td>
1.332     rillig   12131: </tr>
                   12132: <tr>
1.382     wiz      12133: <td>BDB_DEFAULT</td>
1.384   ! leot     12134: <td>BDB_LIBS</td>
1.329     leot     12135: </tr>
                   12136: <tr>
1.382     wiz      12137: <td>BDB_TYPE</td>
1.384   ! leot     12138: <td>BINCIMAP_GROUP</td>
1.327     wiz      12139: </tr>
                   12140: <tr>
1.382     wiz      12141: <td>BINCIMAP_LOG_USER</td>
1.384   ! leot     12142: <td>BINCIMAP_USER</td>
1.311     leot     12143: </tr>
                   12144: <tr>
1.382     wiz      12145: <td>BIND_DIR</td>
1.384   ! leot     12146: <td>BIND_GROUP</td>
1.292     leot     12147: </tr>
                   12148: <tr>
1.382     wiz      12149: <td>BIND_USER</td>
1.384   ! leot     12150: <td>BINOWN</td>
1.274     rillig   12151: </tr>
                   12152: <tr>
1.382     wiz      12153: <td>BINPKG_SITES</td>
1.384   ! leot     12154: <td>BIN_INSTALL_FLAGS</td>
1.269     leot     12155: </tr>
                   12156: <tr>
1.382     wiz      12157: <td>BISON_PKGDATADIR</td>
1.384   ! leot     12158: <td>BLAS</td>
1.369     wiz      12159: </tr>
                   12160: <tr>
1.382     wiz      12161: <td>BLAS_ACCEPTED</td>
1.384   ! leot     12162: <td>BLAS_C_INTERFACE</td>
1.269     leot     12163: </tr>
                   12164: <tr>
1.382     wiz      12165: <td>BLAS_INCLUDES</td>
1.384   ! leot     12166: <td>BLAS_INDEX64</td>
1.269     leot     12167: </tr>
                   12168: <tr>
1.382     wiz      12169: <td>BLAS_LIBS</td>
1.384   ! leot     12170: <td>BLAS_PC</td>
1.269     leot     12171: </tr>
                   12172: <tr>
1.382     wiz      12173: <td>BLAS_TYPE</td>
1.384   ! leot     12174: <td>BOOTSTRAP_DEPENDS</td>
1.269     leot     12175: </tr>
                   12176: <tr>
1.382     wiz      12177: <td>BROKEN</td>
1.384   ! leot     12178: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269     leot     12179: </tr>
                   12180: <tr>
1.382     wiz      12181: <td>BROKEN_ON_PLATFORM</td>
1.384   ! leot     12182: <td>BSDSRCDIR</td>
1.269     leot     12183: </tr>
                   12184: <tr>
1.382     wiz      12185: <td>BSDXSRCDIR</td>
1.384   ! leot     12186: <td>BSD_MAKE_ENV</td>
1.269     leot     12187: </tr>
                   12188: <tr>
1.382     wiz      12189: <td>BUILDLINK_AUTO_DIRS</td>
1.384   ! leot     12190: <td>BUILDLINK_AUTO_VARS</td>
1.269     leot     12191: </tr>
                   12192: <tr>
1.382     wiz      12193: <td>BUILDLINK_CFLAGS</td>
1.384   ! leot     12194: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269     leot     12195: </tr>
                   12196: <tr>
1.382     wiz      12197: <td>BUILDLINK_CPPFLAGS</td>
1.384   ! leot     12198: <td>BUILDLINK_DEPMETHOD</td>
1.269     leot     12199: </tr>
                   12200: <tr>
1.370     gdt      12201: <td>BUILDLINK_FILES</td>
1.384   ! leot     12202: <td>BUILDLINK_FILES_CMD</td>
1.269     leot     12203: </tr>
                   12204: <tr>
1.370     gdt      12205: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.384   ! leot     12206: <td>BUILDLINK_LDFLAGS</td>
1.320     wiz      12207: </tr>
                   12208: <tr>
1.370     gdt      12209: <td>BUILDLINK_LIBS</td>
1.384   ! leot     12210: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269     leot     12211: </tr>
                   12212: <tr>
1.370     gdt      12213: <td>BUILDLINK_PKGNAME</td>
1.384   ! leot     12214: <td>BUILDLINK_PREFIX</td>
1.269     leot     12215: </tr>
                   12216: <tr>
1.370     gdt      12217: <td>BUILDLINK_RPATHDIRS</td>
1.384   ! leot     12218: <td>BUILDLINK_TREE</td>
1.269     leot     12219: </tr>
                   12220: <tr>
1.370     gdt      12221: <td>BUILD_DEFS</td>
1.384   ! leot     12222: <td>BUILD_DEFS_EFFECTS</td>
1.269     leot     12223: </tr>
                   12224: <tr>
1.370     gdt      12225: <td>BUILD_DEPENDS</td>
1.384   ! leot     12226: <td>BUILD_DIRS</td>
1.269     leot     12227: </tr>
                   12228: <tr>
1.370     gdt      12229: <td>BUILD_ENV_SHELL</td>
1.384   ! leot     12230: <td>BUILD_MAKE_CMD</td>
1.269     leot     12231: </tr>
                   12232: <tr>
1.370     gdt      12233: <td>BUILD_MAKE_FLAGS</td>
1.384   ! leot     12234: <td>BUILD_TARGET</td>
1.269     leot     12235: </tr>
                   12236: <tr>
1.370     gdt      12237: <td>BUILTIN_FIND_FILES</td>
1.384   ! leot     12238: <td>BUILTIN_FIND_FILES_VAR</td>
1.269     leot     12239: </tr>
                   12240: <tr>
1.370     gdt      12241: <td>BUILTIN_FIND_GREP</td>
1.384   ! leot     12242: <td>BUILTIN_FIND_HEADERS</td>
1.269     leot     12243: </tr>
                   12244: <tr>
1.370     gdt      12245: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.384   ! leot     12246: <td>BUILTIN_FIND_PKGCONFIG</td>
1.269     leot     12247: </tr>
                   12248: <tr>
1.370     gdt      12249: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.384   ! leot     12250: <td>BUILTIN_PKG</td>
1.269     leot     12251: </tr>
                   12252: <tr>
1.370     gdt      12253: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.384   ! leot     12254: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.309     gutterid 12255: </tr>
                   12256: <tr>
1.370     gdt      12257: <td>BUILTIN_VERSION_SCRIPT</td>
1.384   ! leot     12258: <td>BUILTIN_X11_TYPE</td>
1.269     leot     12259: </tr>
                   12260: <tr>
1.370     gdt      12261: <td>BUILTIN_X11_VERSION</td>
1.384   ! leot     12262: <td>CACTI_GROUP</td>
1.269     leot     12263: </tr>
                   12264: <tr>
1.370     gdt      12265: <td>CACTI_USER</td>
1.384   ! leot     12266: <td>CANNA_GROUP</td>
1.269     leot     12267: </tr>
                   12268: <tr>
1.370     gdt      12269: <td>CANNA_USER</td>
1.384   ! leot     12270: <td>CAT</td>
1.269     leot     12271: </tr>
                   12272: <tr>
1.370     gdt      12273: <td>CBLAS_LIBS</td>
1.384   ! leot     12274: <td>CBLAS_PC</td>
1.269     leot     12275: </tr>
                   12276: <tr>
1.370     gdt      12277: <td>CCACHE_BASE</td>
1.384   ! leot     12278: <td>CCACHE_DIR</td>
1.269     leot     12279: </tr>
                   12280: <tr>
1.370     gdt      12281: <td>CCACHE_LOGFILE</td>
1.384   ! leot     12282: <td>CCACHE_RECACHE</td>
1.269     leot     12283: </tr>
                   12284: <tr>
1.303     bacon    12285: <td>CC_VERSION</td>
1.384   ! leot     12286: <td>CC_VERSION_STRING</td>
1.269     leot     12287: </tr>
                   12288: <tr>
1.303     bacon    12289: <td>CDRECORD_CONF</td>
1.384   ! leot     12290: <td>CDROM_PKG_URL_DIR</td>
1.269     leot     12291: </tr>
                   12292: <tr>
1.303     bacon    12293: <td>CDROM_PKG_URL_HOST</td>
1.384   ! leot     12294: <td>CHANGES</td>
1.338     nia      12295: </tr>
                   12296: <tr>
1.382     wiz      12297: <td>CHECKOUT_DATE</td>
1.384   ! leot     12298: <td>CHECK_COMPILER</td>
1.382     wiz      12299: </tr>
                   12300: <tr>
                   12301: <td>CHECK_FAKEHOME</td>
1.384   ! leot     12302: <td>CHECK_FILES</td>
1.378     leot     12303: </tr>
                   12304: <tr>
1.382     wiz      12305: <td>CHECK_FILES_ONLY_PREFIX</td>
1.384   ! leot     12306: <td>CHECK_FILES_SKIP</td>
1.376     wiz      12307: </tr>
                   12308: <tr>
1.382     wiz      12309: <td>CHECK_FILES_STRICT</td>
1.384   ! leot     12310: <td>CHECK_HEADERS</td>
1.369     wiz      12311: </tr>
                   12312: <tr>
1.382     wiz      12313: <td>CHECK_HEADERS_SKIP</td>
1.384   ! leot     12314: <td>CHECK_INTERPRETER</td>
1.367     gdt      12315: </tr>
                   12316: <tr>
1.382     wiz      12317: <td>CHECK_INTERPRETER_SKIP</td>
1.384   ! leot     12318: <td>CHECK_PERMS</td>
1.360     leot     12319: </tr>
                   12320: <tr>
1.382     wiz      12321: <td>CHECK_PERMS_AUTOFIX</td>
1.384   ! leot     12322: <td>CHECK_PERMS_SKIP</td>
1.355     rillig   12323: </tr>
                   12324: <tr>
1.382     wiz      12325: <td>CHECK_PIE</td>
1.384   ! leot     12326: <td>CHECK_PIE_SKIP</td>
1.352     wiz      12327: </tr>
                   12328: <tr>
1.382     wiz      12329: <td>CHECK_PIE_SUPPORTED</td>
1.384   ! leot     12330: <td>CHECK_PORTABILITY</td>
1.348     wiz      12331: </tr>
                   12332: <tr>
1.382     wiz      12333: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.384   ! leot     12334: <td>CHECK_PORTABILITY_SKIP</td>
1.342     wiz      12335: </tr>
                   12336: <tr>
1.382     wiz      12337: <td>CHECK_RELRO</td>
1.384   ! leot     12338: <td>CHECK_RELRO_SKIP</td>
1.332     rillig   12339: </tr>
                   12340: <tr>
1.382     wiz      12341: <td>CHECK_RELRO_SUPPORTED</td>
1.384   ! leot     12342: <td>CHECK_SHLIBS</td>
1.329     leot     12343: </tr>
                   12344: <tr>
1.382     wiz      12345: <td>CHECK_SHLIBS_SKIP</td>
1.384   ! leot     12346: <td>CHECK_SHLIBS_SUPPORTED</td>
1.327     wiz      12347: </tr>
                   12348: <tr>
1.382     wiz      12349: <td>CHECK_SHLIBS_TOXIC</td>
1.384   ! leot     12350: <td>CHECK_SSP</td>
1.320     wiz      12351: </tr>
                   12352: <tr>
1.382     wiz      12353: <td>CHECK_SSP_SKIP</td>
1.384   ! leot     12354: <td>CHECK_SSP_SUPPORTED</td>
1.311     leot     12355: </tr>
                   12356: <tr>
1.382     wiz      12357: <td>CHECK_STRIPPED</td>
1.384   ! leot     12358: <td>CHECK_STRIPPED_SKIP</td>
1.292     leot     12359: </tr>
                   12360: <tr>
1.382     wiz      12361: <td>CHECK_WRKREF</td>
1.384   ! leot     12362: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.274     rillig   12363: </tr>
                   12364: <tr>
1.382     wiz      12365: <td>CHECK_WRKREF_SKIP</td>
1.384   ! leot     12366: <td>CLAMAV_DBDIR</td>
1.331     gutterid 12367: </tr>
                   12368: <tr>
1.382     wiz      12369: <td>CLAMAV_GROUP</td>
1.384   ! leot     12370: <td>CLAMAV_USER</td>
1.269     leot     12371: </tr>
                   12372: <tr>
1.382     wiz      12373: <td>CLANGBASE</td>
1.384   ! leot     12374: <td>CLEANDEPENDS</td>
1.269     leot     12375: </tr>
                   12376: <tr>
1.382     wiz      12377: <td>CLT</td>
1.384   ! leot     12378: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269     leot     12379: </tr>
                   12380: <tr>
1.382     wiz      12381: <td>CMAKE_INSTALL_NAME_DIR</td>
1.384   ! leot     12382: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     12383: </tr>
                   12384: <tr>
1.382     wiz      12385: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.384   ! leot     12386: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     12387: </tr>
                   12388: <tr>
1.382     wiz      12389: <td>CMAKE_PREFIX_PATH</td>
1.384   ! leot     12390: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.369     wiz      12391: </tr>
                   12392: <tr>
1.382     wiz      12393: <td>COMMON_LISP_DOCFILES</td>
1.384   ! leot     12394: <td>COMMON_LISP_EXAMPLES</td>
1.382     wiz      12395: </tr>
                   12396: <tr>
                   12397: <td>COMMON_LISP_EXTRAFILES</td>
1.384   ! leot     12398: <td>COMMON_LISP_PACKAGES</td>
1.382     wiz      12399: </tr>
                   12400: <tr>
                   12401: <td>COMMON_LISP_SYSTEM</td>
1.384   ! leot     12402: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     12403: </tr>
                   12404: <tr>
1.341     gutterid 12405: <td>COMPILER_USE_SYMLINKS</td>
1.384   ! leot     12406: <td>CONFIGURE_ARGS</td>
1.269     leot     12407: </tr>
                   12408: <tr>
1.341     gutterid 12409: <td>CONFIGURE_DIRS</td>
1.384   ! leot     12410: <td>CONFIGURE_ENV</td>
1.269     leot     12411: </tr>
                   12412: <tr>
1.341     gutterid 12413: <td>CONFIGURE_ENV_SHELL</td>
1.384   ! leot     12414: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     12415: </tr>
                   12416: <tr>
1.341     gutterid 12417: <td>CONFIGURE_HAS_MANDIR</td>
1.384   ! leot     12418: <td>CONFIGURE_SCRIPT</td>
1.269     leot     12419: </tr>
                   12420: <tr>
1.341     gutterid 12421: <td>CONFIG_SHELL</td>
1.384   ! leot     12422: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     12423: </tr>
                   12424: <tr>
1.341     gutterid 12425: <td>CONF_FILES</td>
1.384   ! leot     12426: <td>CONF_FILES_MODE</td>
1.269     leot     12427: </tr>
                   12428: <tr>
1.341     gutterid 12429: <td>CONF_FILES_PERMS</td>
1.384   ! leot     12430: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     12431: </tr>
                   12432: <tr>
1.341     gutterid 12433: <td>CONSERVER_DEFAULTPORT</td>
1.384   ! leot     12434: <td>CP</td>
1.269     leot     12435: </tr>
                   12436: <tr>
1.347     gutterid 12437: <td>CPE</td>
1.384   ! leot     12438: <td>CPE_EDITION</td>
1.347     gutterid 12439: </tr>
                   12440: <tr>
                   12441: <td>CPE_LANG</td>
1.384   ! leot     12442: <td>CPE_OTHER</td>
1.347     gutterid 12443: </tr>
                   12444: <tr>
                   12445: <td>CPE_PART</td>
1.384   ! leot     12446: <td>CPE_PRODUCT</td>
1.347     gutterid 12447: </tr>
                   12448: <tr>
                   12449: <td>CPE_SW_EDITION</td>
1.384   ! leot     12450: <td>CPE_TARGET_HW</td>
1.347     gutterid 12451: </tr>
                   12452: <tr>
                   12453: <td>CPE_TARGET_SW</td>
1.384   ! leot     12454: <td>CPE_UPDATE</td>
1.347     gutterid 12455: </tr>
                   12456: <tr>
                   12457: <td>CPE_URI</td>
1.384   ! leot     12458: <td>CPE_VENDOR</td>
1.347     gutterid 12459: </tr>
                   12460: <tr>
                   12461: <td>CPE_VERSION</td>
1.384   ! leot     12462: <td>CPP</td>
1.269     leot     12463: </tr>
                   12464: <tr>
1.347     gutterid 12465: <td>CPP_PRECOMP_FLAGS</td>
1.384   ! leot     12466: <td>CREATE_WRKDIR_SYMLINK</td>
1.269     leot     12467: </tr>
                   12468: <tr>
1.347     gutterid 12469: <td>CROSSBASE</td>
1.384   ! leot     12470: <td>CTFCONVERT</td>
1.269     leot     12471: </tr>
                   12472: <tr>
1.347     gutterid 12473: <td>CTF_FILES_SKIP</td>
1.384   ! leot     12474: <td>CTF_SUPPORTED</td>
1.269     leot     12475: </tr>
                   12476: <tr>
1.347     gutterid 12477: <td>CTYPE</td>
1.384   ! leot     12478: <td>CUPS_GROUP</td>
1.269     leot     12479: </tr>
                   12480: <tr>
1.347     gutterid 12481: <td>CUPS_SYSTEM_GROUPS</td>
1.384   ! leot     12482: <td>CUPS_USER</td>
1.292     leot     12483: </tr>
                   12484: <tr>
1.347     gutterid 12485: <td>CURSES_DEFAULT</td>
1.384   ! leot     12486: <td>CURSES_TYPE</td>
1.342     wiz      12487: </tr>
                   12488: <tr>
1.382     wiz      12489: <td>CVS_EXTRACTDIR</td>
1.384   ! leot     12490: <td>CVS_MODULE</td>
1.382     wiz      12491: </tr>
                   12492: <tr>
                   12493: <td>CVS_PROJECT</td>
1.384   ! leot     12494: <td>CVS_REPOSITORIES</td>
1.382     wiz      12495: </tr>
                   12496: <tr>
                   12497: <td>CVS_ROOT</td>
1.384   ! leot     12498: <td>CVS_ROOT_GNU</td>
1.382     wiz      12499: </tr>
                   12500: <tr>
                   12501: <td>CVS_ROOT_NONGNU</td>
1.384   ! leot     12502: <td>CVS_ROOT_SOURCEFORGE</td>
1.382     wiz      12503: </tr>
                   12504: <tr>
                   12505: <td>CVS_TAG</td>
1.384   ! leot     12506: <td>CYRUS_GROUP</td>
1.378     leot     12507: </tr>
                   12508: <tr>
1.381     dholland 12509: <td>CYRUS_IDLE</td>
1.384   ! leot     12510: <td>CYRUS_USER</td>
1.376     wiz      12511: </tr>
                   12512: <tr>
1.381     dholland 12513: <td>DAEMONTOOLS_GROUP</td>
1.384   ! leot     12514: <td>DAEMONTOOLS_LOG_USER</td>
1.369     wiz      12515: </tr>
                   12516: <tr>
1.381     dholland 12517: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.384   ! leot     12518: <td>DARWIN_REQUIRES_FILTER</td>
1.367     gdt      12519: </tr>
                   12520: <tr>
1.381     dholland 12521: <td>DBUS_GROUP</td>
1.384   ! leot     12522: <td>DBUS_USER</td>
1.360     leot     12523: </tr>
                   12524: <tr>
1.381     dholland 12525: <td>DEFANG_GROUP</td>
1.384   ! leot     12526: <td>DEFANG_USER</td>
1.352     wiz      12527: </tr>
                   12528: <tr>
1.381     dholland 12529: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.384   ! leot     12530: <td>DEFAULT_DISTFILES</td>
1.348     wiz      12531: </tr>
                   12532: <tr>
1.381     dholland 12533: <td>DEFAULT_IRC_SERVER</td>
1.384   ! leot     12534: <td>DEFAULT_SERIAL_DEVICE</td>
1.332     rillig   12535: </tr>
                   12536: <tr>
1.381     dholland 12537: <td>DEF_UMASK</td>
1.384   ! leot     12538: <td>DEINSTALLDEPENDS</td>
1.329     leot     12539: </tr>
                   12540: <tr>
1.381     dholland 12541: <td>DEINSTALL_SRC</td>
1.384   ! leot     12542: <td>DEINSTALL_TEMPLATES</td>
1.327     wiz      12543: </tr>
                   12544: <tr>
1.381     dholland 12545: <td>DELAYED_ERROR_MSG</td>
1.384   ! leot     12546: <td>DELAYED_WARNING_MSG</td>
1.320     wiz      12547: </tr>
                   12548: <tr>
1.381     dholland 12549: <td>DEPENDS</td>
1.384   ! leot     12550: <td>DEPENDS_TARGET</td>
1.311     leot     12551: </tr>
                   12552: <tr>
1.381     dholland 12553: <td>DEPENDS_TYPE</td>
1.384   ! leot     12554: <td>DESTDIR</td>
1.269     leot     12555: </tr>
                   12556: <tr>
1.381     dholland 12557: <td>DESTDIR_VARNAME</td>
1.384   ! leot     12558: <td>DIALER_GROUP</td>
1.269     leot     12559: </tr>
                   12560: <tr>
1.381     dholland 12561: <td>DIGEST_REQD</td>
1.384   ! leot     12562: <td>DISTDIR</td>
1.269     leot     12563: </tr>
                   12564: <tr>
1.381     dholland 12565: <td>DISTFILES</td>
1.384   ! leot     12566: <td>DISTINFO_FILE</td>
1.309     gutterid 12567: </tr>
                   12568: <tr>
1.381     dholland 12569: <td>DISTNAME</td>
1.384   ! leot     12570: <td>DIST_PATH</td>
1.269     leot     12571: </tr>
                   12572: <tr>
1.381     dholland 12573: <td>DIST_SUBDIR</td>
1.384   ! leot     12574: <td>DJBDNS_AXFR_USER</td>
1.269     leot     12575: </tr>
                   12576: <tr>
1.381     dholland 12577: <td>DJBDNS_CACHE_USER</td>
1.384   ! leot     12578: <td>DJBDNS_DJBDNS_GROUP</td>
1.269     leot     12579: </tr>
                   12580: <tr>
1.381     dholland 12581: <td>DJBDNS_LOG_USER</td>
1.384   ! leot     12582: <td>DJBDNS_RBL_USER</td>
1.269     leot     12583: </tr>
                   12584: <tr>
1.381     dholland 12585: <td>DJBDNS_TINY_USER</td>
1.384   ! leot     12586: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269     leot     12587: </tr>
                   12588: <tr>
1.381     dholland 12589: <td>DL_AUTO_VARS</td>
1.384   ! leot     12590: <td>DL_CFLAGS</td>
1.269     leot     12591: </tr>
                   12592: <tr>
1.381     dholland 12593: <td>DL_LDFLAGS</td>
1.384   ! leot     12594: <td>DL_LIBS</td>
1.269     leot     12595: </tr>
                   12596: <tr>
1.381     dholland 12597: <td>DNS</td>
1.384   ! leot     12598: <td>DOCOWN</td>
1.269     leot     12599: </tr>
                   12600: <tr>
1.381     dholland 12601: <td>DOWNLOADED_DISTFILE</td>
1.384   ! leot     12602: <td>DQCACHE_GROUP</td>
1.269     leot     12603: </tr>
                   12604: <tr>
1.381     dholland 12605: <td>DQCACHE_USER</td>
1.384   ! leot     12606: <td>DT_LAYOUT</td>
1.269     leot     12607: </tr>
                   12608: <tr>
1.381     dholland 12609: <td>DYNAMIC_SITES_CMD</td>
1.384   ! leot     12610: <td>DYNAMIC_SITES_SCRIPT</td>
1.269     leot     12611: </tr>
                   12612: <tr>
1.381     dholland 12613: <td>ECHO</td>
1.384   ! leot     12614: <td>ECHO_N</td>
1.269     leot     12615: </tr>
                   12616: <tr>
1.381     dholland 12617: <td>ELK_GUI</td>
1.384   ! leot     12618: <td>EMACS_TYPE</td>
1.269     leot     12619: </tr>
                   12620: <tr>
1.381     dholland 12621: <td>EMULDIR</td>
1.384   ! leot     12622: <td>EMULSUBDIR</td>
1.269     leot     12623: </tr>
                   12624: <tr>
1.381     dholland 12625: <td>EMULSUBDIRSLASH</td>
1.384   ! leot     12626: <td>EMUL_ARCH</td>
1.269     leot     12627: </tr>
                   12628: <tr>
1.381     dholland 12629: <td>EMUL_DISTRO</td>
1.384   ! leot     12630: <td>EMUL_EXEC_FMT</td>
1.269     leot     12631: </tr>
                   12632: <tr>
1.381     dholland 12633: <td>EMUL_IS_NATIVE</td>
1.384   ! leot     12634: <td>EMUL_MODULES</td>
1.357     gutterid 12635: </tr>
                   12636: <tr>
1.381     dholland 12637: <td>EMUL_OPSYS</td>
1.384   ! leot     12638: <td>EMUL_PKG_FMT</td>
1.333     nia      12639: </tr>
                   12640: <tr>
1.381     dholland 12641: <td>EMUL_PLATFORM</td>
1.384   ! leot     12642: <td>EMUL_PLATFORMS</td>
1.269     leot     12643: </tr>
                   12644: <tr>
1.381     dholland 12645: <td>EMUL_PREFER</td>
1.384   ! leot     12646: <td>EMUL_REQD</td>
1.269     leot     12647: </tr>
                   12648: <tr>
1.381     dholland 12649: <td>EMUL_TYPE</td>
1.384   ! leot     12650: <td>ERROR_MSG</td>
1.269     leot     12651: </tr>
                   12652: <tr>
1.381     dholland 12653: <td>EXIM_GROUP</td>
1.384   ! leot     12654: <td>EXIM_USER</td>
1.269     leot     12655: </tr>
                   12656: <tr>
1.381     dholland 12657: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.384   ! leot     12658: <td>EXTRACTOR</td>
1.269     leot     12659: </tr>
                   12660: <tr>
1.381     dholland 12661: <td>EXTRACT_CMD</td>
1.384   ! leot     12662: <td>EXTRACT_CMD_DEFAULT</td>
1.269     leot     12663: </tr>
                   12664: <tr>
1.381     dholland 12665: <td>EXTRACT_DIR</td>
1.384   ! leot     12666: <td>EXTRACT_ELEMENTS</td>
1.269     leot     12667: </tr>
                   12668: <tr>
1.381     dholland 12669: <td>EXTRACT_ENV</td>
1.384   ! leot     12670: <td>EXTRACT_ONLY</td>
1.269     leot     12671: </tr>
                   12672: <tr>
1.381     dholland 12673: <td>EXTRACT_OPTS</td>
1.384   ! leot     12674: <td>EXTRACT_SUFX</td>
1.269     leot     12675: </tr>
                   12676: <tr>
1.381     dholland 12677: <td>EXTRACT_USING</td>
1.384   ! leot     12678: <td>FAIL</td>
1.269     leot     12679: </tr>
                   12680: <tr>
1.381     dholland 12681: <td>FAILOVER_FETCH</td>
1.384   ! leot     12682: <td>FAIL_MSG</td>
1.269     leot     12683: </tr>
                   12684: <tr>
1.381     dholland 12685: <td>FAKE_NCURSES</td>
1.384   ! leot     12686: <td>FAM</td>
1.269     leot     12687: </tr>
                   12688: <tr>
1.381     dholland 12689: <td>FAM_ACCEPTED</td>
1.384   ! leot     12690: <td>FAM_DEFAULT</td>
1.269     leot     12691: </tr>
                   12692: <tr>
1.381     dholland 12693: <td>FAM_SERVER</td>
1.384   ! leot     12694: <td>FCPATH</td>
1.338     nia      12695: </tr>
                   12696: <tr>
1.381     dholland 12697: <td>FETCH_AFTER_ARGS</td>
1.384   ! leot     12698: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     12699: </tr>
                   12700: <tr>
1.381     dholland 12701: <td>FETCH_CMD</td>
1.384   ! leot     12702: <td>FETCH_INSECURE</td>
1.269     leot     12703: </tr>
                   12704: <tr>
1.381     dholland 12705: <td>FETCH_OUTPUT_ARGS</td>
1.384   ! leot     12706: <td>FETCH_PROXY</td>
1.269     leot     12707: </tr>
                   12708: <tr>
1.381     dholland 12709: <td>FETCH_RESUME_ARGS</td>
1.384   ! leot     12710: <td>FETCH_TIMEOUT</td>
1.269     leot     12711: </tr>
                   12712: <tr>
1.381     dholland 12713: <td>FETCH_USE_IPV4_ONLY</td>
1.384   ! leot     12714: <td>FETCH_USING</td>
1.269     leot     12715: </tr>
                   12716: <tr>
1.381     dholland 12717: <td>FILES_SUBST</td>
1.384   ! leot     12718: <td>FILES_SUBST_SED</td>
1.269     leot     12719: </tr>
                   12720: <tr>
1.378     leot     12721: <td>FIX_SYSTEM_HEADERS</td>
1.384   ! leot     12722: <td>FONTDIR</td>
1.269     leot     12723: </tr>
                   12724: <tr>
1.377     jnemeth  12725: <td>FONTS_DIRS</td>
1.384   ! leot     12726: <td>FONTS_VERBOSE</td>
1.382     wiz      12727: </tr>
                   12728: <tr>
                   12729: <td>FOO_HACKS_MK</td>
1.384   ! leot     12730: <td>FORCE_CXX_STD</td>
1.269     leot     12731: </tr>
                   12732: <tr>
1.382     wiz      12733: <td>FORCE_C_STD</td>
1.384   ! leot     12734: <td>FOSSIL_EXTRACTDIR</td>
1.382     wiz      12735: </tr>
                   12736: <tr>
                   12737: <td>FOSSIL_REPO</td>
1.384   ! leot     12738: <td>FOSSIL_REPOSITORIES</td>
1.382     wiz      12739: </tr>
                   12740: <tr>
                   12741: <td>FOSSIL_VERSION</td>
1.384   ! leot     12742: <td>FOX_USE_XUNICODE</td>
1.292     leot     12743: </tr>
                   12744: <tr>
1.382     wiz      12745: <td>FREEWNN_GROUP</td>
1.384   ! leot     12746: <td>FREEWNN_USER</td>
1.378     leot     12747: </tr>
                   12748: <tr>
1.382     wiz      12749: <td>FTP_PKG_URL_DIR</td>
1.384   ! leot     12750: <td>FTP_PKG_URL_HOST</td>
1.269     leot     12751: </tr>
                   12752: <tr>
1.382     wiz      12753: <td>GAMEDATAMODE</td>
1.384   ! leot     12754: <td>GAMEDATA_PERMS</td>
1.269     leot     12755: </tr>
                   12756: <tr>
1.382     wiz      12757: <td>GAMEDIRMODE</td>
1.384   ! leot     12758: <td>GAMEDIR_PERMS</td>
1.269     leot     12759: </tr>
                   12760: <tr>
1.382     wiz      12761: <td>GAMEGRP</td>
1.384   ! leot     12762: <td>GAMEMODE</td>
1.269     leot     12763: </tr>
                   12764: <tr>
1.382     wiz      12765: <td>GAMEOWN</td>
1.384   ! leot     12766: <td>GAMES_GROUP</td>
1.269     leot     12767: </tr>
                   12768: <tr>
1.382     wiz      12769: <td>GAMES_USER</td>
1.384   ! leot     12770: <td>GCC</td>
1.269     leot     12771: </tr>
                   12772: <tr>
1.382     wiz      12773: <td>GCCBASE</td>
1.384   ! leot     12774: <td>GCC_REQD</td>
1.269     leot     12775: </tr>
                   12776: <tr>
1.382     wiz      12777: <td>GCC_VERSION_SUFFIX</td>
1.384   ! leot     12778: <td>GEM_BUILD</td>
1.269     leot     12779: </tr>
                   12780: <tr>
1.382     wiz      12781: <td>GEM_CLEANBUILD</td>
1.384   ! leot     12782: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.269     leot     12783: </tr>
                   12784: <tr>
1.382     wiz      12785: <td>GEM_DOCDIR</td>
1.384   ! leot     12786: <td>GEM_EXTSDIR</td>
1.269     leot     12787: </tr>
                   12788: <tr>
1.382     wiz      12789: <td>GEM_HOME</td>
1.384   ! leot     12790: <td>GEM_KEEPBUILD</td>
1.269     leot     12791: </tr>
                   12792: <tr>
1.382     wiz      12793: <td>GEM_LIBDIR</td>
1.384   ! leot     12794: <td>GEM_NAME</td>
1.374     wiz      12795: </tr>
                   12796: <tr>
1.382     wiz      12797: <td>GEM_PATH</td>
1.384   ! leot     12798: <td>GEM_PLUGINSDIR</td>
1.292     leot     12799: </tr>
                   12800: <tr>
1.382     wiz      12801: <td>GEM_SPECFILE</td>
1.384   ! leot     12802: <td>GENERATE_PLIST</td>
1.269     leot     12803: </tr>
                   12804: <tr>
1.382     wiz      12805: <td>GHC</td>
1.384   ! leot     12806: <td>GHOSTSCRIPT_REQD</td>
1.269     leot     12807: </tr>
                   12808: <tr>
1.382     wiz      12809: <td>GITHUB_PROJECT</td>
1.384   ! leot     12810: <td>GITHUB_RELEASE</td>
1.269     leot     12811: </tr>
                   12812: <tr>
1.382     wiz      12813: <td>GITHUB_SUBMODULES</td>
1.384   ! leot     12814: <td>GITHUB_TAG</td>
1.269     leot     12815: </tr>
                   12816: <tr>
1.382     wiz      12817: <td>GITHUB_TYPE</td>
1.384   ! leot     12818: <td>GITLAB_PROJECT</td>
1.292     leot     12819: </tr>
                   12820: <tr>
1.382     wiz      12821: <td>GITLAB_RELEASE</td>
1.384   ! leot     12822: <td>GITLAB_SUBMODULES</td>
1.311     leot     12823: </tr>
                   12824: <tr>
1.382     wiz      12825: <td>GITLAB_TAG</td>
1.384   ! leot     12826: <td>GITLAB_TYPE</td>
1.269     leot     12827: </tr>
                   12828: <tr>
1.382     wiz      12829: <td>GIT_BRANCH</td>
1.384   ! leot     12830: <td>GIT_ENV</td>
1.382     wiz      12831: </tr>
                   12832: <tr>
                   12833: <td>GIT_EXTRACTDIR</td>
1.384   ! leot     12834: <td>GIT_REPO</td>
1.382     wiz      12835: </tr>
                   12836: <tr>
                   12837: <td>GIT_REPOSITORIES</td>
1.384   ! leot     12838: <td>GIT_REVISION</td>
1.382     wiz      12839: </tr>
                   12840: <tr>
                   12841: <td>GIT_TAG</td>
1.384   ! leot     12842: <td>GNAT</td>
1.338     nia      12843: </tr>
                   12844: <tr>
1.379     wiz      12845: <td>GNU</td>
1.381     dholland 12846: <td>GNU_CONFIGURE</td>
1.378     leot     12847: </tr>
                   12848: <tr>
1.379     wiz      12849: <td>GNU_CONFIGURE_ICONV</td>
1.381     dholland 12850: <td>GNU_CONFIGURE_INFODIR</td>
1.376     wiz      12851: </tr>
                   12852: <tr>
1.379     wiz      12853: <td>GNU_CONFIGURE_MANDIR</td>
1.381     dholland 12854: <td>GNU_CONFIGURE_QUIET</td>
1.369     wiz      12855: </tr>
                   12856: <tr>
1.379     wiz      12857: <td>GNU_CONFIGURE_STRICT</td>
1.381     dholland 12858: <td>GODEP_REDIRECTS</td>
1.369     wiz      12859: </tr>
                   12860: <tr>
1.379     wiz      12861: <td>GO_BUILD_PATTERN</td>
1.381     dholland 12862: <td>GO_DEPS</td>
1.360     leot     12863: </tr>
                   12864: <tr>
1.379     wiz      12865: <td>GO_DIST_BASE</td>
1.381     dholland 12866: <td>GO_EXTRA_MOD_DIRS</td>
1.355     rillig   12867: </tr>
                   12868: <tr>
1.379     wiz      12869: <td>GO_MODULE_EXTRACT</td>
1.381     dholland 12870: <td>GO_MODULE_FILES</td>
1.348     wiz      12871: </tr>
                   12872: <tr>
1.379     wiz      12873: <td>GO_SRCPATH</td>
1.381     dholland 12874: <td>GROUP_SPECIFIC_PKGS</td>
1.269     leot     12875: </tr>
                   12876: <tr>
1.379     wiz      12877: <td>GRUB_NETWORK_CARDS</td>
1.381     dholland 12878: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     12879: </tr>
                   12880: <tr>
1.379     wiz      12881: <td>GRUB_SCAN_ARGS</td>
1.378     leot     12882: <td>GZIP</td>
1.352     wiz      12883: </tr>
                   12884: <tr>
1.382     wiz      12885: <td>HASKELL_COMPILER</td>
1.377     jnemeth  12886: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.382     wiz      12887: </tr>
                   12888: <tr>
1.379     wiz      12889: <td>HASKELL_DISABLE_LIBRARIES</td>
1.382     wiz      12890: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.276     leot     12891: </tr>
                   12892: <tr>
1.379     wiz      12893: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.382     wiz      12894: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.269     leot     12895: </tr>
                   12896: <tr>
1.379     wiz      12897: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.382     wiz      12898: <td>HASKELL_ENABLE_TESTS</td>
1.332     rillig   12899: </tr>
                   12900: <tr>
1.379     wiz      12901: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.382     wiz      12902: <td>HASKELL_PKG_NAME</td>
1.341     gutterid 12903: </tr>
                   12904: <tr>
1.379     wiz      12905: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.382     wiz      12906: <td>HEADER_TEMPLATES</td>
                   12907: </tr>
                   12908: <tr>
                   12909: <td>HG_REPO</td>
                   12910: <td>HG_REPOSITORIES</td>
1.335     nia      12911: </tr>
                   12912: <tr>
1.382     wiz      12913: <td>HG_TAG</td>
1.381     dholland 12914: <td>HOMEPAGE</td>
1.378     leot     12915: </tr>
                   12916: <tr>
1.379     wiz      12917: <td>HOST_PKGTOOLS_ARGS</td>
1.381     dholland 12918: <td>HOST_SPECIFIC_PKGS</td>
1.378     leot     12919: </tr>
                   12920: <tr>
1.379     wiz      12921: <td>HOWL_GROUP</td>
1.381     dholland 12922: <td>HOWL_USER</td>
1.329     leot     12923: </tr>
                   12924: <tr>
1.379     wiz      12925: <td>ICCBASE</td>
1.381     dholland 12926: <td>ICECAST_CHROOTDIR</td>
1.360     leot     12927: </tr>
                   12928: <tr>
1.379     wiz      12929: <td>ICON_THEMES</td>
1.381     dholland 12930: <td>IDOBASE</td>
1.355     rillig   12931: </tr>
                   12932: <tr>
1.379     wiz      12933: <td>IGNORE_CCACHE</td>
1.381     dholland 12934: <td>IGNORE_INFO_DIRS</td>
1.348     wiz      12935: </tr>
                   12936: <tr>
1.379     wiz      12937: <td>IGNORE_INTERACTIVE_FETCH</td>
1.381     dholland 12938: <td>IMAKE</td>
1.342     wiz      12939: </tr>
                   12940: <tr>
1.379     wiz      12941: <td>IMAKEOPTS</td>
1.381     dholland 12942: <td>IMAKE_MAKE</td>
1.338     nia      12943: </tr>
                   12944: <tr>
1.379     wiz      12945: <td>IMAKE_MANINSTALL</td>
1.381     dholland 12946: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269     leot     12947: </tr>
                   12948: <tr>
1.379     wiz      12949: <td>IMDICTDIR</td>
1.381     dholland 12950: <td>INCOMPAT_CURSES</td>
1.305     bacon    12951: </tr>
                   12952: <tr>
1.379     wiz      12953: <td>INFO_DIR</td>
1.381     dholland 12954: <td>INFO_FILES</td>
1.269     leot     12955: </tr>
                   12956: <tr>
1.379     wiz      12957: <td>INFO_MSG</td>
1.381     dholland 12958: <td>INIT_SYSTEM</td>
1.269     leot     12959: </tr>
                   12960: <tr>
1.379     wiz      12961: <td>INN_DATA_DIR</td>
1.381     dholland 12962: <td>INN_GROUP</td>
1.269     leot     12963: </tr>
                   12964: <tr>
1.379     wiz      12965: <td>INN_USER</td>
1.381     dholland 12966: <td>INSTALLATION_DIRS</td>
1.269     leot     12967: </tr>
                   12968: <tr>
1.379     wiz      12969: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.381     dholland 12970: <td>INSTALL_ENV</td>
1.269     leot     12971: </tr>
                   12972: <tr>
1.379     wiz      12973: <td>INSTALL_ENV_SHELL</td>
1.381     dholland 12974: <td>INSTALL_SH_OVERRIDE</td>
1.269     leot     12975: </tr>
                   12976: <tr>
1.378     leot     12977: <td>INSTALL_SRC</td>
1.381     dholland 12978: <td>INSTALL_TEMPLATES</td>
1.269     leot     12979: </tr>
                   12980: <tr>
1.378     leot     12981: <td>INSTALL_UNSTRIPPED</td>
1.381     dholland 12982: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269     leot     12983: </tr>
                   12984: <tr>
1.378     leot     12985: <td>IRCD_HYBRID_IRC_USER</td>
1.381     dholland 12986: <td>IRCD_HYBRID_MAXCONN</td>
1.369     wiz      12987: </tr>
                   12988: <tr>
1.378     leot     12989: <td>IRCD_HYBRID_NICLEN</td>
1.381     dholland 12990: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.287     rillig   12991: </tr>
                   12992: <tr>
1.378     leot     12993: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.381     dholland 12994: <td>IRCD_HYBRID_TOPICLEN</td>
1.269     leot     12995: </tr>
                   12996: <tr>
1.378     leot     12997: <td>IRIX</td>
1.381     dholland 12998: <td>IRRD_USE_PGP</td>
1.269     leot     12999: </tr>
                   13000: <tr>
1.378     leot     13001: <td>JABBERD_GROUP</td>
1.381     dholland 13002: <td>JABBERD_LOGDIR</td>
1.269     leot     13003: </tr>
                   13004: <tr>
1.378     leot     13005: <td>JABBERD_PIDDIR</td>
1.381     dholland 13006: <td>JABBERD_SPOOLDIR</td>
1.269     leot     13007: </tr>
                   13008: <tr>
1.378     leot     13009: <td>JABBERD_USER</td>
1.382     wiz      13010: <td>JAVA_APP_PATH</td>
                   13011: </tr>
                   13012: <tr>
                   13013: <td>JAVA_APP_TARGETS</td>
1.381     dholland 13014: <td>JAVA_BINPREFIX</td>
1.378     leot     13015: </tr>
                   13016: <tr>
                   13017: <td>JAVA_CLASSPATH</td>
1.381     dholland 13018: <td>JAVA_HOME</td>
1.376     wiz      13019: </tr>
                   13020: <tr>
1.378     leot     13021: <td>JAVA_LD_LIBRARY_PATH</td>
1.381     dholland 13022: <td>JAVA_NAME</td>
1.367     gdt      13023: </tr>
                   13024: <tr>
1.378     leot     13025: <td>JAVA_UNLIMIT</td>
1.381     dholland 13026: <td>JAVA_WRAPPERS</td>
1.360     leot     13027: </tr>
                   13028: <tr>
1.378     leot     13029: <td>JPEG_ACCEPTED</td>
1.381     dholland 13030: <td>JPEG_DEFAULT</td>
1.269     leot     13031: </tr>
                   13032: <tr>
1.378     leot     13033: <td>KERBEROS</td>
1.381     dholland 13034: <td>KERMIT_SUID_UUCP</td>
1.348     wiz      13035: </tr>
                   13036: <tr>
1.378     leot     13037: <td>KJS_USE_PCRE</td>
1.381     dholland 13038: <td>KNEWS_DOMAIN_FILE</td>
1.292     leot     13039: </tr>
                   13040: <tr>
1.378     leot     13041: <td>KNEWS_DOMAIN_NAME</td>
1.381     dholland 13042: <td>KRB5_ACCEPTED</td>
1.342     wiz      13043: </tr>
                   13044: <tr>
1.378     leot     13045: <td>KRB5_DEFAULT</td>
1.381     dholland 13046: <td>LANGUAGES</td>
1.311     leot     13047: </tr>
                   13048: <tr>
1.378     leot     13049: <td>LAPACKE_LIBS</td>
1.381     dholland 13050: <td>LAPACKE_PC</td>
1.269     leot     13051: </tr>
                   13052: <tr>
1.378     leot     13053: <td>LAPACK_LIBS</td>
1.381     dholland 13054: <td>LAPACK_PC</td>
1.332     rillig   13055: </tr>
                   13056: <tr>
1.378     leot     13057: <td>LATEX2HTML_ICONPATH</td>
1.381     dholland 13058: <td>LDCONFIG_ADD_CMD</td>
1.269     leot     13059: </tr>
                   13060: <tr>
1.378     leot     13061: <td>LDCONFIG_REMOVE_CMD</td>
1.381     dholland 13062: <td>LDD</td>
1.269     leot     13063: </tr>
                   13064: <tr>
1.378     leot     13065: <td>LEAFNODE_DATA_DIR</td>
1.381     dholland 13066: <td>LEAFNODE_GROUP</td>
1.269     leot     13067: </tr>
                   13068: <tr>
1.378     leot     13069: <td>LEAFNODE_USER</td>
1.381     dholland 13070: <td>LIBDVDCSS_HOMEPAGE</td>
1.269     leot     13071: </tr>
                   13072: <tr>
1.378     leot     13073: <td>LIBDVDCSS_MASTER_SITES</td>
1.381     dholland 13074: <td>LIBIMAGEQUANT_TYPE</td>
1.292     leot     13075: </tr>
                   13076: <tr>
1.378     leot     13077: <td>LIBRSVG_TYPE</td>
1.381     dholland 13078: <td>LIBTOOL</td>
1.271     brook    13079: </tr>
                   13080: <tr>
1.378     leot     13081: <td>LIBTOOLIZE_PLIST</td>
1.381     dholland 13082: <td>LIBTOOL_M4_OVERRIDE</td>
1.269     leot     13083: </tr>
                   13084: <tr>
1.378     leot     13085: <td>LIBUSB_TYPE</td>
1.381     dholland 13086: <td>LICENSE</td>
1.269     leot     13087: </tr>
                   13088: <tr>
1.378     leot     13089: <td>LINKER_RPATH_FLAG</td>
1.376     wiz      13090: <td>LINK_RPATH_FLAG</td>
1.369     wiz      13091: </tr>
                   13092: <tr>
1.382     wiz      13093: <td>LINUX_BASE_NODEPS</td>
                   13094: <td>LINUX_BASE_PREFERRED</td>
                   13095: </tr>
                   13096: <tr>
                   13097: <td>LINUX_BASE_REQUIRED</td>
1.375     jkoshy   13098: <td>LINUX_LOCALES</td>
1.355     rillig   13099: </tr>
                   13100: <tr>
1.382     wiz      13101: <td>LOCALBASE</td>
1.375     jkoshy   13102: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     13103: </tr>
                   13104: <tr>
1.382     wiz      13105: <td>LOCALPATCHES</td>
1.375     jkoshy   13106: <td>LOVE_DATA</td>
1.352     wiz      13107: </tr>
                   13108: <tr>
1.382     wiz      13109: <td>LOVE_GAME</td>
1.375     jkoshy   13110: <td>LOVE_VERSION</td>
1.338     nia      13111: </tr>
                   13112: <tr>
1.382     wiz      13113: <td>LOWER_OPSYS</td>
1.375     jkoshy   13114: <td>LOWER_OPSYS_VERSUFFIX</td>
1.370     gdt      13115: </tr>
                   13116: <tr>
1.382     wiz      13117: <td>LOWER_VARIANT_VERSION</td>
1.375     jkoshy   13118: <td>LOWER_VENDOR</td>
1.370     gdt      13119: </tr>
                   13120: <tr>
1.382     wiz      13121: <td>LP32PLATFORMS</td>
1.375     jkoshy   13122: <td>LP64PLATFORMS</td>
1.269     leot     13123: </tr>
                   13124: <tr>
1.382     wiz      13125: <td>LUA_BUSTED_ARGS</td>
1.375     jkoshy   13126: <td>LUA_CDIR</td>
1.329     leot     13127: </tr>
                   13128: <tr>
1.382     wiz      13129: <td>LUA_COMPILER</td>
1.375     jkoshy   13130: <td>LUA_DOCDIR</td>
1.269     leot     13131: </tr>
                   13132: <tr>
1.382     wiz      13133: <td>LUA_EXAMPLESDIR</td>
1.375     jkoshy   13134: <td>LUA_INCDIR</td>
1.269     leot     13135: </tr>
                   13136: <tr>
1.382     wiz      13137: <td>LUA_INTERPRETER</td>
1.375     jkoshy   13138: <td>LUA_LDIR</td>
1.269     leot     13139: </tr>
                   13140: <tr>
1.382     wiz      13141: <td>LUA_LINKER_MAGIC</td>
1.375     jkoshy   13142: <td>LUA_PKGPREFIX</td>
1.336     nia      13143: </tr>
                   13144: <tr>
1.382     wiz      13145: <td>LUA_SELF_CONFLICT</td>
1.375     jkoshy   13146: <td>LUA_USE_BUSTED</td>
1.333     nia      13147: </tr>
                   13148: <tr>
1.382     wiz      13149: <td>LUA_VERSIONS_ACCEPTED</td>
1.375     jkoshy   13150: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.382     wiz      13151: </tr>
                   13152: <tr>
1.377     jnemeth  13153: <td>LUA_VERSION_DEFAULT</td>
1.382     wiz      13154: <td>LUA_VERSION_REQD</td>
1.333     nia      13155: </tr>
                   13156: <tr>
1.377     jnemeth  13157: <td>Lua</td>
1.382     wiz      13158: <td>MACHINE_PLATFORM</td>
1.333     nia      13159: </tr>
                   13160: <tr>
1.377     jnemeth  13161: <td>MAILAGENT_DOMAIN</td>
1.382     wiz      13162: <td>MAILAGENT_EMAIL</td>
1.333     nia      13163: </tr>
                   13164: <tr>
1.377     jnemeth  13165: <td>MAILAGENT_FQDN</td>
1.382     wiz      13166: <td>MAILAGENT_ORGANIZATION</td>
1.333     nia      13167: </tr>
                   13168: <tr>
1.358     gutterid 13169: <td>MAJORDOMO_HOMEDIR</td>
1.382     wiz      13170: <td>MAJOR_OS_VERSION</td>
1.376     wiz      13171: </tr>
                   13172: <tr>
1.368     gutterid 13173: <td>MAKEINFO_ARGS</td>
1.381     dholland 13174: <td>MAKE_DIRS</td>
1.378     leot     13175: </tr>
                   13176: <tr>
                   13177: <td>MAKE_DIRS_PERMS</td>
1.381     dholland 13178: <td>MAKE_ENV</td>
1.367     gdt      13179: </tr>
                   13180: <tr>
1.378     leot     13181: <td>MAKE_FILE</td>
1.381     dholland 13182: <td>MAKE_FLAGS</td>
1.360     leot     13183: </tr>
                   13184: <tr>
1.378     leot     13185: <td>MAKE_JOBS</td>
1.381     dholland 13186: <td>MAKE_JOBS_SAFE</td>
1.320     wiz      13187: </tr>
                   13188: <tr>
1.378     leot     13189: <td>MAKE_PROGRAM</td>
1.381     dholland 13190: <td>MANCOMPRESSED_IF_MANZ</td>
1.348     wiz      13191: </tr>
                   13192: <tr>
1.378     leot     13193: <td>MANINSTALL</td>
1.381     dholland 13194: <td>MANZ</td>
1.342     wiz      13195: </tr>
                   13196: <tr>
1.378     leot     13197: <td>MARIADB_VERSIONS_ALL</td>
1.381     dholland 13198: <td>MASTER_SITES</td>
1.269     leot     13199: </tr>
                   13200: <tr>
1.378     leot     13201: <td>MASTER_SITE_BACKUP</td>
1.381     dholland 13202: <td>MASTER_SITE_LOCAL</td>
1.327     wiz      13203: </tr>
                   13204: <tr>
1.378     leot     13205: <td>MASTER_SITE_MOZILLA</td>
1.381     dholland 13206: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     13207: </tr>
                   13208: <tr>
1.378     leot     13209: <td>MASTER_SITE_PERL_CPAN</td>
1.381     dholland 13210: <td>MASTER_SORT</td>
1.269     leot     13211: </tr>
                   13212: <tr>
1.378     leot     13213: <td>MASTER_SORT_RANDOM</td>
1.381     dholland 13214: <td>MASTER_SORT_REGEX</td>
1.269     leot     13215: </tr>
                   13216: <tr>
1.378     leot     13217: <td>MECAB_CHARSET</td>
1.381     dholland 13218: <td>MEDIATOMB_GROUP</td>
1.303     bacon    13219: </tr>
                   13220: <tr>
1.378     leot     13221: <td>MEDIATOMB_USER</td>
1.381     dholland 13222: <td>MIPSPROBASE</td>
1.269     leot     13223: </tr>
                   13224: <tr>
1.378     leot     13225: <td>MIREDO_GROUP</td>
1.381     dholland 13226: <td>MIREDO_USER</td>
1.269     leot     13227: </tr>
                   13228: <tr>
1.378     leot     13229: <td>MISSING_FEATURES</td>
1.381     dholland 13230: <td>MKDIR</td>
1.269     leot     13231: </tr>
                   13232: <tr>
1.378     leot     13233: <td>MKPIE_SUPPORTED</td>
1.381     dholland 13234: <td>MLDONKEY_GROUP</td>
1.269     leot     13235: </tr>
                   13236: <tr>
1.378     leot     13237: <td>MLDONKEY_HOME</td>
1.381     dholland 13238: <td>MLDONKEY_USER</td>
1.269     leot     13239: </tr>
                   13240: <tr>
1.378     leot     13241: <td>MONOTONE_GROUP</td>
1.381     dholland 13242: <td>MONOTONE_USER</td>
1.269     leot     13243: </tr>
                   13244: <tr>
1.378     leot     13245: <td>MOTIFBASE</td>
1.381     dholland 13246: <td>MOTIF_TYPE</td>
1.269     leot     13247: </tr>
                   13248: <tr>
1.378     leot     13249: <td>MOTIF_TYPE_DEFAULT</td>
1.381     dholland 13250: <td>MPI_TYPE</td>
1.269     leot     13251: </tr>
                   13252: <tr>
1.378     leot     13253: <td>MSGFMT_STRIP_MSGCTXT</td>
1.381     dholland 13254: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.269     leot     13255: </tr>
                   13256: <tr>
1.378     leot     13257: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.382     wiz      13258: <td>MUST</td>
                   13259: </tr>
                   13260: <tr>
1.377     jnemeth  13261: <td>MV</td>
1.382     wiz      13262: <td>MYSQL_CHARSET</td>
1.355     rillig   13263: </tr>
                   13264: <tr>
1.377     jnemeth  13265: <td>MYSQL_DATADIR</td>
1.382     wiz      13266: <td>MYSQL_EXTRA_CHARSET</td>
1.269     leot     13267: </tr>
                   13268: <tr>
1.377     jnemeth  13269: <td>MYSQL_GROUP</td>
1.382     wiz      13270: <td>MYSQL_USER</td>
1.352     wiz      13271: </tr>
                   13272: <tr>
1.377     jnemeth  13273: <td>MYSQL_VERSION</td>
1.382     wiz      13274: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.338     nia      13275: </tr>
                   13276: <tr>
1.377     jnemeth  13277: <td>MYSQL_VERSION_DEFAULT</td>
1.382     wiz      13278: <td>NAGIOSCMD_GROUP</td>
1.329     leot     13279: </tr>
                   13280: <tr>
1.377     jnemeth  13281: <td>NAGIOSDIR</td>
1.382     wiz      13282: <td>NAGIOS_GROUP</td>
1.269     leot     13283: </tr>
                   13284: <tr>
1.377     jnemeth  13285: <td>NAGIOS_USER</td>
1.382     wiz      13286: <td>NATIVE_EXEC_FMT</td>
1.320     wiz      13287: </tr>
                   13288: <tr>
1.377     jnemeth  13289: <td>NATIVE_LOWER_OPSYS</td>
1.382     wiz      13290: <td>NATIVE_LOWER_VENDOR</td>
1.269     leot     13291: </tr>
                   13292: <tr>
1.377     jnemeth  13293: <td>NATIVE_MACHINE_PLATFORM</td>
1.382     wiz      13294: <td>NATIVE_OBJECT_FMT</td>
1.269     leot     13295: </tr>
                   13296: <tr>
1.377     jnemeth  13297: <td>NATIVE_OPSYS_VERSION</td>
1.382     wiz      13298: <td>NATIVE_OS_VARIANT</td>
1.269     leot     13299: </tr>
                   13300: <tr>
1.377     jnemeth  13301: <td>NATIVE_OS_VERSION</td>
1.382     wiz      13302: <td>NBPAX_PROGRAM_PREFIX</td>
1.370     gdt      13303: </tr>
                   13304: <tr>
1.377     jnemeth  13305: <td>NETBSD_LOGIN_NAME</td>
1.382     wiz      13306: <td>NMH_EDITOR</td>
1.370     gdt      13307: </tr>
                   13308: <tr>
1.377     jnemeth  13309: <td>NMH_MTA</td>
1.382     wiz      13310: <td>NMH_PAGER</td>
1.309     gutterid 13311: </tr>
                   13312: <tr>
1.377     jnemeth  13313: <td>NODE_VERSIONS_ACCEPTED</td>
1.382     wiz      13314: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13315: </tr>
                   13316: <tr>
1.377     jnemeth  13317: <td>NODE_VERSION_DEFAULT</td>
1.382     wiz      13318: <td>NODE_VERSION_REQD</td>
1.269     leot     13319: </tr>
                   13320: <tr>
1.377     jnemeth  13321: <td>NOLOGIN</td>
1.382     wiz      13322: <td>NOTE</td>
1.269     leot     13323: </tr>
                   13324: <tr>
1.377     jnemeth  13325: <td>NOT_FOR_PLATFORM</td>
1.382     wiz      13326: <td>NOT_PAX_ASLR_SAFE</td>
1.269     leot     13327: </tr>
                   13328: <tr>
1.377     jnemeth  13329: <td>NOT_PAX_MPROTECT_SAFE</td>
1.382     wiz      13330: <td>NO_BUILD</td>
1.269     leot     13331: </tr>
                   13332: <tr>
1.377     jnemeth  13333: <td>NO_CHECKSUM</td>
1.382     wiz      13334: <td>NO_CONFIGURE</td>
1.269     leot     13335: </tr>
                   13336: <tr>
1.377     jnemeth  13337: <td>NO_SKIP</td>
1.382     wiz      13338: <td>NSD_GROUP</td>
1.344     gutterid 13339: </tr>
                   13340: <tr>
1.379     wiz      13341: <td>NSD_LOG_FACILITY</td>
1.382     wiz      13342: <td>NSD_USER</td>
1.379     wiz      13343: </tr>
                   13344: <tr>
1.375     jkoshy   13345: <td>NS_PREFERRED</td>
1.382     wiz      13346: <td>NULLMAILER_GROUP</td>
1.333     nia      13347: </tr>
                   13348: <tr>
1.375     jkoshy   13349: <td>NULLMAILER_USER</td>
1.382     wiz      13350: <td>OBJECT_FMT</td>
1.333     nia      13351: </tr>
                   13352: <tr>
1.375     jkoshy   13353: <td>OBJHOSTNAME</td>
1.382     wiz      13354: <td>OBJMACHINE</td>
1.293     rillig   13355: </tr>
                   13356: <tr>
1.375     jkoshy   13357: <td>OCAML_FINDLIB_DIRS</td>
1.382     wiz      13358: <td>OCAML_FINDLIB_REGISTER</td>
1.269     leot     13359: </tr>
                   13360: <tr>
1.375     jkoshy   13361: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.382     wiz      13362: <td>OCAML_SITELIBDIR</td>
1.269     leot     13363: </tr>
                   13364: <tr>
1.375     jkoshy   13365: <td>OMF</td>
1.382     wiz      13366: <td>ONLY_FOR_COMPILER</td>
1.269     leot     13367: </tr>
                   13368: <tr>
1.375     jkoshy   13369: <td>ONLY_FOR_PLATFORM</td>
1.382     wiz      13370: <td>OPENSSH_CHROOT</td>
1.269     leot     13371: </tr>
                   13372: <tr>
1.375     jkoshy   13373: <td>OPENSSH_GROUP</td>
1.382     wiz      13374: <td>OPENSSH_USER</td>
1.269     leot     13375: </tr>
                   13376: <tr>
1.375     jkoshy   13377: <td>OPSYS</td>
1.382     wiz      13378: <td>OPSYS_EMULDIR</td>
1.269     leot     13379: </tr>
                   13380: <tr>
1.375     jkoshy   13381: <td>OPSYS_VERSION</td>
1.382     wiz      13382: <td>OS</td>
1.269     leot     13383: </tr>
                   13384: <tr>
1.375     jkoshy   13385: <td>OSS_TYPE</td>
1.382     wiz      13386: <td>OSX</td>
1.269     leot     13387: </tr>
                   13388: <tr>
1.375     jkoshy   13389: <td>OSX_PATH_TO_M4</td>
1.382     wiz      13390: <td>OSX_PATH_TO_YACC</td>
                   13391: </tr>
                   13392: <tr>
                   13393: <td>OS_HAVE_ALSA</td>
                   13394: <td>OS_HAVE_RCD</td>
1.376     wiz      13395: </tr>
                   13396: <tr>
1.375     jkoshy   13397: <td>OS_VARIANT</td>
1.382     wiz      13398: <td>OS_VERSION</td>
1.369     wiz      13399: </tr>
                   13400: <tr>
1.375     jkoshy   13401: <td>OTF_FONTS_DIR</td>
1.382     wiz      13402: <td>OVERRIDE_DIRDEPTH</td>
1.352     wiz      13403: </tr>
                   13404: <tr>
1.375     jkoshy   13405: <td>OVERRIDE_GEMSPEC</td>
1.382     wiz      13406: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.376     wiz      13407: </tr>
                   13408: <tr>
1.382     wiz      13409: <td>OVERRIDE_ROCKSPEC</td>
1.381     dholland 13410: <td>OWN_DIRS</td>
1.378     leot     13411: </tr>
                   13412: <tr>
1.376     wiz      13413: <td>OWN_DIRS_PERMS</td>
1.381     dholland 13414: <td>P4GROUP</td>
1.367     gdt      13415: </tr>
                   13416: <tr>
1.376     wiz      13417: <td>P4PORT</td>
1.381     dholland 13418: <td>P4ROOT</td>
1.360     leot     13419: </tr>
                   13420: <tr>
1.376     wiz      13421: <td>P4USER</td>
1.381     dholland 13422: <td>PACKAGES</td>
1.348     wiz      13423: </tr>
                   13424: <tr>
1.376     wiz      13425: <td>PALMOS_DEFAULT_SDK</td>
1.381     dholland 13426: <td>PAMBASE</td>
1.329     leot     13427: </tr>
                   13428: <tr>
1.376     wiz      13429: <td>PAM_DEFAULT</td>
1.381     dholland 13430: <td>PAPERSIZE</td>
1.342     wiz      13431: </tr>
                   13432: <tr>
1.376     wiz      13433: <td>PASSIVE_FETCH</td>
1.381     dholland 13434: <td>PATCHDIR</td>
1.320     wiz      13435: </tr>
                   13436: <tr>
1.376     wiz      13437: <td>PATCHFILES</td>
1.381     dholland 13438: <td>PATCH_ARGS</td>
1.269     leot     13439: </tr>
                   13440: <tr>
1.376     wiz      13441: <td>PATCH_DEBUG</td>
1.381     dholland 13442: <td>PATCH_DIST_ARGS</td>
1.269     leot     13443: </tr>
                   13444: <tr>
1.376     wiz      13445: <td>PATCH_DIST_CAT</td>
1.381     dholland 13446: <td>PATCH_DIST_STRIP</td>
1.269     leot     13447: </tr>
                   13448: <tr>
1.376     wiz      13449: <td>PATCH_FUZZ_FACTOR</td>
1.381     dholland 13450: <td>PATCH_STRIP</td>
1.269     leot     13451: </tr>
                   13452: <tr>
1.376     wiz      13453: <td>PATH</td>
1.379     wiz      13454: <td>PCCBASE</td>
1.378     leot     13455: </tr>
                   13456: <tr>
1.382     wiz      13457: <td>PEAR</td>
                   13458: <td>PEAR_CHANNEL</td>
                   13459: </tr>
                   13460: <tr>
                   13461: <td>PEAR_CHANNEL_ALIAS</td>
                   13462: <td>PEAR_CHANNEL_VERSION</td>
                   13463: </tr>
                   13464: <tr>
1.374     wiz      13465: <td>PEAR_CMD</td>
1.381     dholland 13466: <td>PEAR_LIB</td>
1.376     wiz      13467: </tr>
                   13468: <tr>
                   13469: <td>PEAR_PACKAGE_XML</td>
1.381     dholland 13470: <td>PEP-518</td>
1.342     wiz      13471: </tr>
                   13472: <tr>
1.368     gutterid 13473: <td>PERL5</td>
1.381     dholland 13474: <td>PERL5_CONFIGURE</td>
1.269     leot     13475: </tr>
                   13476: <tr>
1.368     gutterid 13477: <td>PERL5_CONFIGURE_DIRS</td>
1.381     dholland 13478: <td>PERL5_LDFLAGS</td>
1.332     rillig   13479: </tr>
                   13480: <tr>
1.368     gutterid 13481: <td>PERL5_LICENSE</td>
1.381     dholland 13482: <td>PERL5_MODULE_TYPE</td>
1.320     wiz      13483: </tr>
                   13484: <tr>
1.368     gutterid 13485: <td>PERL5_PACKLIST</td>
1.381     dholland 13486: <td>PERL5_PACKLIST_DIR</td>
1.292     leot     13487: </tr>
                   13488: <tr>
1.368     gutterid 13489: <td>PERL5_PERLBASE</td>
1.381     dholland 13490: <td>PERL5_SITEBASE</td>
1.274     rillig   13491: </tr>
                   13492: <tr>
1.368     gutterid 13493: <td>PERL5_USE_PACKLIST</td>
1.381     dholland 13494: <td>PERL5_VENDORBASE</td>
1.274     rillig   13495: </tr>
                   13496: <tr>
1.368     gutterid 13497: <td>PFCTL</td>
1.381     dholland 13498: <td>PFVAR_H</td>
1.269     leot     13499: </tr>
                   13500: <tr>
1.368     gutterid 13501: <td>PF_VERSION</td>
1.381     dholland 13502: <td>PGGROUP</td>
1.269     leot     13503: </tr>
                   13504: <tr>
1.368     gutterid 13505: <td>PGHOME</td>
1.381     dholland 13506: <td>PGPKGSRCDIR</td>
1.269     leot     13507: </tr>
                   13508: <tr>
1.368     gutterid 13509: <td>PGSQL_TYPE</td>
1.381     dholland 13510: <td>PGSQL_VERSION</td>
1.269     leot     13511: </tr>
                   13512: <tr>
1.368     gutterid 13513: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.381     dholland 13514: <td>PGSQL_VERSION_DEFAULT</td>
1.269     leot     13515: </tr>
                   13516: <tr>
1.368     gutterid 13517: <td>PGUSER</td>
1.381     dholland 13518: <td>PG_LIB_EXT</td>
1.269     leot     13519: </tr>
                   13520: <tr>
1.368     gutterid 13521: <td>PHP</td>
1.381     dholland 13522: <td>PHPCOMMON_MK</td>
1.379     wiz      13523: </tr>
                   13524: <tr>
                   13525: <td>PHPPKGSRCDIR</td>
1.381     dholland 13526: <td>PHP_BASE_VERS</td>
1.269     leot     13527: </tr>
                   13528: <tr>
1.379     wiz      13529: <td>PHP_EGDIR</td>
1.381     dholland 13530: <td>PHP_EXTENSION_DIR</td>
1.269     leot     13531: </tr>
                   13532: <tr>
1.379     wiz      13533: <td>PHP_INCDIR</td>
1.381     dholland 13534: <td>PHP_LIBDIR</td>
1.379     wiz      13535: </tr>
                   13536: <tr>
                   13537: <td>PHP_MAJOR_VERS</td>
1.381     dholland 13538: <td>PHP_MINIMUM_TEENY</td>
1.379     wiz      13539: </tr>
                   13540: <tr>
                   13541: <td>PHP_MINOR_VERS</td>
1.381     dholland 13542: <td>PHP_PKG_PREFIX</td>
1.269     leot     13543: </tr>
                   13544: <tr>
1.379     wiz      13545: <td>PHP_SHAREDIR</td>
1.381     dholland 13546: <td>PHP_VER</td>
1.269     leot     13547: </tr>
                   13548: <tr>
1.368     gutterid 13549: <td>PHP_VERSION</td>
1.381     dholland 13550: <td>PHP_VERSIONS_ACCEPTED</td>
1.269     leot     13551: </tr>
                   13552: <tr>
1.368     gutterid 13553: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.381     dholland 13554: <td>PHP_VERSION_DEFAULT</td>
1.269     leot     13555: </tr>
                   13556: <tr>
1.368     gutterid 13557: <td>PHP_VERSION_REQD</td>
1.381     dholland 13558: <td>PILRC_USE_GTK</td>
1.269     leot     13559: </tr>
                   13560: <tr>
1.368     gutterid 13561: <td>PKGCONFIG_BASE</td>
1.381     dholland 13562: <td>PKGCONFIG_FILE</td>
1.269     leot     13563: </tr>
                   13564: <tr>
1.368     gutterid 13565: <td>PKGCONFIG_OVERRIDE</td>
1.381     dholland 13566: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269     leot     13567: </tr>
                   13568: <tr>
1.368     gutterid 13569: <td>PKGDIR</td>
1.381     dholland 13570: <td>PKGGNUDIR</td>
1.269     leot     13571: </tr>
                   13572: <tr>
1.368     gutterid 13573: <td>PKGINFODIR</td>
1.381     dholland 13574: <td>PKGLOCALEDIR</td>
1.269     leot     13575: </tr>
                   13576: <tr>
1.368     gutterid 13577: <td>PKGMANDIR</td>
1.381     dholland 13578: <td>PKGNAME</td>
1.269     leot     13579: </tr>
                   13580: <tr>
1.368     gutterid 13581: <td>PKGNAME_REQD</td>
1.381     dholland 13582: <td>PKGPATH</td>
1.269     leot     13583: </tr>
                   13584: <tr>
1.368     gutterid 13585: <td>PKGREVISION</td>
1.381     dholland 13586: <td>PKGSRC_BLAS_TYPES</td>
1.269     leot     13587: </tr>
                   13588: <tr>
1.368     gutterid 13589: <td>PKGSRC_CHANGES</td>
1.381     dholland 13590: <td>PKGSRC_COMPILER</td>
1.269     leot     13591: </tr>
                   13592: <tr>
1.368     gutterid 13593: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.381     dholland 13594: <td>PKGSRC_LOCKTYPE</td>
1.269     leot     13595: </tr>
                   13596: <tr>
1.368     gutterid 13597: <td>PKGSRC_MAKE_ENV</td>
1.381     dholland 13598: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269     leot     13599: </tr>
                   13600: <tr>
1.368     gutterid 13601: <td>PKGSRC_MKPIE</td>
1.381     dholland 13602: <td>PKGSRC_MKREPRO</td>
1.269     leot     13603: </tr>
                   13604: <tr>
1.368     gutterid 13605: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.381     dholland 13606: <td>PKGSRC_RUN_TEST</td>
1.292     leot     13607: </tr>
                   13608: <tr>
1.368     gutterid 13609: <td>PKGSRC_SETENV</td>
1.381     dholland 13610: <td>PKGSRC_SLEEPSECS</td>
1.269     leot     13611: </tr>
                   13612: <tr>
1.368     gutterid 13613: <td>PKGSRC_TODO</td>
1.381     dholland 13614: <td>PKGSRC_USE_CTF</td>
1.274     rillig   13615: </tr>
                   13616: <tr>
1.368     gutterid 13617: <td>PKGSRC_USE_FORTIFY</td>
1.381     dholland 13618: <td>PKGSRC_USE_MKTOOLS</td>
1.269     leot     13619: </tr>
                   13620: <tr>
1.368     gutterid 13621: <td>PKGSRC_USE_RELRO</td>
1.381     dholland 13622: <td>PKGSRC_USE_SSP</td>
1.269     leot     13623: </tr>
                   13624: <tr>
1.368     gutterid 13625: <td>PKGSRC_USE_STACK_CHECK</td>
1.381     dholland 13626: <td>PKGTASKS_DATAFILE</td>
1.269     leot     13627: </tr>
                   13628: <tr>
1.368     gutterid 13629: <td>PKGTOOLS_ARGS</td>
1.381     dholland 13630: <td>PKGTOOLS_ENV</td>
1.269     leot     13631: </tr>
                   13632: <tr>
1.368     gutterid 13633: <td>PKG_ALTERNATIVES</td>
1.381     dholland 13634: <td>PKG_APACHE</td>
1.269     leot     13635: </tr>
                   13636: <tr>
1.368     gutterid 13637: <td>PKG_APACHE_ACCEPTED</td>
1.381     dholland 13638: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     13639: </tr>
                   13640: <tr>
1.368     gutterid 13641: <td>PKG_BEST_EXISTS</td>
1.381     dholland 13642: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     13643: </tr>
                   13644: <tr>
1.368     gutterid 13645: <td>PKG_COMPRESSION</td>
1.381     dholland 13646: <td>PKG_CONFIG</td>
1.269     leot     13647: </tr>
                   13648: <tr>
1.368     gutterid 13649: <td>PKG_CONFIG_PERMS</td>
1.381     dholland 13650: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     13651: </tr>
                   13652: <tr>
1.370     gdt      13653: <td>PKG_DBDIR</td>
1.381     dholland 13654: <td>PKG_DB_TMPDIR</td>
1.269     leot     13655: </tr>
                   13656: <tr>
1.370     gdt      13657: <td>PKG_DEBUG_LEVEL</td>
1.381     dholland 13658: <td>PKG_DEFAULT_OPTIONS</td>
1.269     leot     13659: </tr>
                   13660: <tr>
1.370     gdt      13661: <td>PKG_DESTDIR_SUPPORT</td>
1.381     dholland 13662: <td>PKG_DEVELOPER</td>
1.367     gdt      13663: </tr>
                   13664: <tr>
1.370     gdt      13665: <td>PKG_DISABLED_OPTIONS</td>
1.381     dholland 13666: <td>PKG_FATAL_ERRORS</td>
1.269     leot     13667: </tr>
                   13668: <tr>
1.370     gdt      13669: <td>PKG_FC</td>
1.381     dholland 13670: <td>PKG_FILELIST_CMD</td>
1.348     wiz      13671: </tr>
                   13672: <tr>
1.370     gdt      13673: <td>PKG_GECOS</td>
1.381     dholland 13674: <td>PKG_GID</td>
1.360     leot     13675: </tr>
                   13676: <tr>
1.370     gdt      13677: <td>PKG_GROUPS</td>
1.381     dholland 13678: <td>PKG_GROUPS_VARS</td>
1.269     leot     13679: </tr>
                   13680: <tr>
1.370     gdt      13681: <td>PKG_HOME</td>
1.381     dholland 13682: <td>PKG_INIT_SCRIPTS</td>
1.269     leot     13683: </tr>
                   13684: <tr>
1.370     gdt      13685: <td>PKG_JAVA_HOME</td>
1.381     dholland 13686: <td>PKG_JVM</td>
1.269     leot     13687: </tr>
                   13688: <tr>
1.370     gdt      13689: <td>PKG_JVMS_ACCEPTED</td>
1.381     dholland 13690: <td>PKG_JVM_DEFAULT</td>
1.269     leot     13691: </tr>
                   13692: <tr>
1.370     gdt      13693: <td>PKG_LEGACY_OPTIONS</td>
1.381     dholland 13694: <td>PKG_LIBTOOL</td>
1.269     leot     13695: </tr>
                   13696: <tr>
1.370     gdt      13697: <td>PKG_MKSYMLINKS</td>
1.381     dholland 13698: <td>PKG_OPTIONS</td>
1.269     leot     13699: </tr>
                   13700: <tr>
1.370     gdt      13701: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.381     dholland 13702: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     13703: </tr>
                   13704: <tr>
1.370     gdt      13705: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.381     dholland 13706: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     13707: </tr>
                   13708: <tr>
1.370     gdt      13709: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.381     dholland 13710: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     13711: </tr>
                   13712: <tr>
1.370     gdt      13713: <td>PKG_OPTIONS_VAR</td>
1.381     dholland 13714: <td>PKG_RCD_SCRIPTS</td>
1.269     leot     13715: </tr>
                   13716: <tr>
1.378     leot     13717: <td>PKG_REFCOUNT_DBDIR</td>
1.381     dholland 13718: <td>PKG_REGISTER_SHELLS</td>
1.269     leot     13719: </tr>
                   13720: <tr>
1.378     leot     13721: <td>PKG_RESUME_TRANSFERS</td>
1.381     dholland 13722: <td>PKG_SHELL</td>
1.269     leot     13723: </tr>
                   13724: <tr>
1.378     leot     13725: <td>PKG_SUGGESTED_OPTIONS</td>
1.381     dholland 13726: <td>PKG_SUPPORTED_OPTIONS</td>
1.269     leot     13727: </tr>
                   13728: <tr>
1.378     leot     13729: <td>PKG_SYSCONFBASE</td>
1.381     dholland 13730: <td>PKG_SYSCONFBASEDIR</td>
1.269     leot     13731: </tr>
                   13732: <tr>
1.378     leot     13733: <td>PKG_SYSCONFDIR</td>
1.381     dholland 13734: <td>PKG_SYSCONFDIR_PERMS</td>
1.269     leot     13735: </tr>
                   13736: <tr>
1.378     leot     13737: <td>PKG_SYSCONFSUBDIR</td>
1.381     dholland 13738: <td>PKG_SYSCONFVAR</td>
1.269     leot     13739: </tr>
                   13740: <tr>
1.378     leot     13741: <td>PKG_TOOLS_BIN</td>
1.381     dholland 13742: <td>PKG_UID</td>
1.269     leot     13743: </tr>
                   13744: <tr>
1.378     leot     13745: <td>PKG_UPDATE_FONTS_DB</td>
1.381     dholland 13746: <td>PKG_USERS</td>
1.269     leot     13747: </tr>
                   13748: <tr>
1.378     leot     13749: <td>PKG_USERS_VARS</td>
1.381     dholland 13750: <td>PKG_VERBOSE</td>
1.269     leot     13751: </tr>
                   13752: <tr>
1.378     leot     13753: <td>PLEASE</td>
1.381     dholland 13754: <td>PLIST</td>
1.269     leot     13755: </tr>
                   13756: <tr>
1.378     leot     13757: <td>PLIST_AWK</td>
1.381     dholland 13758: <td>PLIST_AWK_ENV</td>
1.269     leot     13759: </tr>
                   13760: <tr>
1.378     leot     13761: <td>PLIST_SRC</td>
1.381     dholland 13762: <td>PLIST_SUBST</td>
1.269     leot     13763: </tr>
                   13764: <tr>
1.378     leot     13765: <td>PLIST_TYPE</td>
1.381     dholland 13766: <td>PLIST_VARS</td>
1.269     leot     13767: </tr>
                   13768: <tr>
1.378     leot     13769: <td>POPTOP_USE_MPPE</td>
1.381     dholland 13770: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269     leot     13771: </tr>
                   13772: <tr>
1.378     leot     13773: <td>POST_FETCH_HOOK</td>
1.381     dholland 13774: <td>PREFER</td>
1.269     leot     13775: </tr>
                   13776: <tr>
1.378     leot     13777: <td>PREFER_NATIVE</td>
1.381     dholland 13778: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     13779: </tr>
                   13780: <tr>
1.378     leot     13781: <td>PREFER_PKGSRC</td>
1.381     dholland 13782: <td>PREFIX</td>
1.269     leot     13783: </tr>
                   13784: <tr>
1.378     leot     13785: <td>PREPEND_PATH</td>
1.381     dholland 13786: <td>PRE_ROOT_CMD</td>
1.269     leot     13787: </tr>
                   13788: <tr>
1.378     leot     13789: <td>PRIVILEGED_STAGES</td>
1.381     dholland 13790: <td>PS</td>
1.269     leot     13791: </tr>
                   13792: <tr>
1.378     leot     13793: <td>PTHREAD_AUTO_VARS</td>
1.381     dholland 13794: <td>PTHREAD_CFLAGS</td>
1.269     leot     13795: </tr>
                   13796: <tr>
1.378     leot     13797: <td>PTHREAD_LDFLAGS</td>
1.381     dholland 13798: <td>PTHREAD_LIBS</td>
1.269     leot     13799: </tr>
                   13800: <tr>
1.378     leot     13801: <td>PTHREAD_OPTS</td>
1.381     dholland 13802: <td>PTHREAD_TYPE</td>
1.269     leot     13803: </tr>
                   13804: <tr>
1.378     leot     13805: <td>PVM_SSH</td>
1.381     dholland 13806: <td>PYPKGPREFIX</td>
1.269     leot     13807: </tr>
                   13808: <tr>
1.384   ! leot     13809: <td>PYSOABISUFFIX</td>
1.378     leot     13810: <td>PYTHON_FOR_BUILD_ONLY</td>
1.384   ! leot     13811: </tr>
        !          13812: <tr>
1.381     dholland 13813: <td>PYTHON_SELF_CONFLICT</td>
1.384   ! leot     13814: <td>PYTHON_VERSION</td>
1.269     leot     13815: </tr>
                   13816: <tr>
1.381     dholland 13817: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.384   ! leot     13818: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     13819: </tr>
                   13820: <tr>
1.381     dholland 13821: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.384   ! leot     13822: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     13823: </tr>
                   13824: <tr>
1.381     dholland 13825: <td>PYTHON_VERSION_REQD</td>
1.384   ! leot     13826: <td>PYVERSSUFFIX</td>
1.269     leot     13827: </tr>
                   13828: <tr>
1.381     dholland 13829: <td>QMAILDIR</td>
1.384   ! leot     13830: <td>QMAIL_ALIAS_USER</td>
1.269     leot     13831: </tr>
                   13832: <tr>
1.381     dholland 13833: <td>QMAIL_DAEMON_USER</td>
1.384   ! leot     13834: <td>QMAIL_LOG_USER</td>
1.269     leot     13835: </tr>
                   13836: <tr>
1.381     dholland 13837: <td>QMAIL_NOFILES_GROUP</td>
1.384   ! leot     13838: <td>QMAIL_PASSWD_USER</td>
1.269     leot     13839: </tr>
                   13840: <tr>
1.381     dholland 13841: <td>QMAIL_QMAIL_GROUP</td>
1.384   ! leot     13842: <td>QMAIL_QUEUE_DIR</td>
1.269     leot     13843: </tr>
                   13844: <tr>
1.381     dholland 13845: <td>QMAIL_QUEUE_EXTRA</td>
1.384   ! leot     13846: <td>QMAIL_QUEUE_USER</td>
1.269     leot     13847: </tr>
                   13848: <tr>
1.381     dholland 13849: <td>QMAIL_REMOTE_USER</td>
1.384   ! leot     13850: <td>QMAIL_ROOT_USER</td>
1.269     leot     13851: </tr>
                   13852: <tr>
1.381     dholland 13853: <td>QMAIL_SEND_USER</td>
1.384   ! leot     13854: <td>QORE_LATEST_MODULE_API</td>
1.269     leot     13855: </tr>
                   13856: <tr>
1.381     dholland 13857: <td>QORE_MODULE_API</td>
1.384   ! leot     13858: <td>QORE_MODULE_DIR</td>
1.269     leot     13859: </tr>
                   13860: <tr>
1.381     dholland 13861: <td>QORE_USER_MODULE_DIR</td>
1.384   ! leot     13862: <td>QORE_VERSION</td>
1.269     leot     13863: </tr>
                   13864: <tr>
1.381     dholland 13865: <td>QPOPPER_FAC</td>
1.384   ! leot     13866: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     13867: </tr>
                   13868: <tr>
1.381     dholland 13869: <td>QPOPPER_USER</td>
1.384   ! leot     13870: <td>RAKE_NAME</td>
1.269     leot     13871: </tr>
                   13872: <tr>
1.370     gdt      13873: <td>RASMOL_DEPTH</td>
1.384   ! leot     13874: <td>RCD_DIR</td>
1.269     leot     13875: </tr>
                   13876: <tr>
1.382     wiz      13877: <td>RCD_ORDER</td>
1.384   ! leot     13878: <td>RCD_SCRIPTS</td>
1.382     wiz      13879: </tr>
                   13880: <tr>
1.381     dholland 13881: <td>RCD_SCRIPTS_DIR</td>
1.384   ! leot     13882: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.378     leot     13883: </tr>
                   13884: <tr>
1.381     dholland 13885: <td>RCD_SCRIPTS_MODE</td>
1.384   ! leot     13886: <td>RCD_SCRIPTS_SHELL</td>
1.376     wiz      13887: </tr>
                   13888: <tr>
1.370     gdt      13889: <td>RCD_SCRIPT_SRC</td>
1.384   ! leot     13890: <td>RCD_SUBR</td>
1.355     rillig   13891: </tr>
                   13892: <tr>
1.370     gdt      13893: <td>RDOC</td>
1.384   ! leot     13894: <td>READLINE_DEFAULT</td>
1.329     leot     13895: </tr>
                   13896: <tr>
1.370     gdt      13897: <td>READLINE_TYPE</td>
1.384   ! leot     13898: <td>REAL_ROOT_GROUP</td>
1.320     wiz      13899: </tr>
                   13900: <tr>
1.370     gdt      13901: <td>REAL_ROOT_USER</td>
1.384   ! leot     13902: <td>RECURSIVE_MAKE</td>
1.338     nia      13903: </tr>
                   13904: <tr>
1.370     gdt      13905: <td>RELAY_CTRL_DIR</td>
1.384   ! leot     13906: <td>RELRO_SUPPORTED</td>
1.292     leot     13907: </tr>
                   13908: <tr>
1.370     gdt      13909: <td>REPLACE_AWK</td>
1.384   ! leot     13910: <td>REPLACE_BASH</td>
1.329     leot     13911: </tr>
                   13912: <tr>
1.370     gdt      13913: <td>REPLACE_CSH</td>
1.384   ! leot     13914: <td>REPLACE_KSH</td>
1.327     wiz      13915: </tr>
                   13916: <tr>
1.370     gdt      13917: <td>REPLACE_LUA</td>
1.384   ! leot     13918: <td>REPLACE_NODEJS</td>
1.269     leot     13919: </tr>
                   13920: <tr>
1.370     gdt      13921: <td>REPLACE_OCTAVE</td>
1.384   ! leot     13922: <td>REPLACE_PERL</td>
1.320     wiz      13923: </tr>
                   13924: <tr>
1.370     gdt      13925: <td>REPLACE_PERL6</td>
1.384   ! leot     13926: <td>REPLACE_PHP</td>
1.311     leot     13927: </tr>
                   13928: <tr>
1.370     gdt      13929: <td>REPLACE_PYTHON</td>
1.384   ! leot     13930: <td>REPLACE_QORE</td>
1.269     leot     13931: </tr>
                   13932: <tr>
1.370     gdt      13933: <td>REPLACE_R</td>
1.384   ! leot     13934: <td>REPLACE_RUBY</td>
1.333     nia      13935: </tr>
                   13936: <tr>
1.370     gdt      13937: <td>REPLACE_RUBY_DIRS</td>
1.384   ! leot     13938: <td>REPLACE_RUBY_PAT</td>
1.269     leot     13939: </tr>
                   13940: <tr>
1.370     gdt      13941: <td>REPLACE_SH</td>
1.384   ! leot     13942: <td>REPLACE_TEXLUA</td>
1.369     wiz      13943: </tr>
                   13944: <tr>
1.370     gdt      13945: <td>REPLACE_TOOL_PYTHON</td>
1.384   ! leot     13946: <td>REPLACE_WISH</td>
1.331     gutterid 13947: </tr>
                   13948: <tr>
1.370     gdt      13949: <td>REQD_DIRS</td>
1.384   ! leot     13950: <td>REQD_DIRS_PERMS</td>
1.269     leot     13951: </tr>
                   13952: <tr>
1.370     gdt      13953: <td>REQD_FILES</td>
1.384   ! leot     13954: <td>REQD_FILES_MODE</td>
1.333     nia      13955: </tr>
                   13956: <tr>
1.370     gdt      13957: <td>REQD_FILES_PERMS</td>
1.384   ! leot     13958: <td>RESOLV_AUTO_VARS</td>
1.269     leot     13959: </tr>
                   13960: <tr>
1.370     gdt      13961: <td>RESOLV_LDFLAGS</td>
1.384   ! leot     13962: <td>RESOLV_LIBS</td>
1.369     wiz      13963: </tr>
                   13964: <tr>
1.370     gdt      13965: <td>RM</td>
1.384   ! leot     13966: <td>ROCKSPEC_NAME</td>
1.378     leot     13967: </tr>
                   13968: <tr>
1.382     wiz      13969: <td>ROCKSPEC_SPECFILE</td>
1.384   ! leot     13970: <td>ROOT_CMD</td>
1.382     wiz      13971: </tr>
                   13972: <tr>
1.381     dholland 13973: <td>ROOT_GROUP</td>
1.384   ! leot     13974: <td>ROOT_USER</td>
1.352     wiz      13975: </tr>
                   13976: <tr>
1.381     dholland 13977: <td>RPCGEN</td>
1.384   ! leot     13978: <td>RPM</td>
1.269     leot     13979: </tr>
                   13980: <tr>
1.381     dholland 13981: <td>RPM2PKG_PLIST</td>
1.384   ! leot     13982: <td>RPM2PKG_PREFIX</td>
1.269     leot     13983: </tr>
                   13984: <tr>
1.381     dholland 13985: <td>RPM2PKG_STAGE</td>
1.384   ! leot     13986: <td>RPM2PKG_STRIP</td>
1.320     wiz      13987: </tr>
                   13988: <tr>
1.381     dholland 13989: <td>RPM2PKG_SUBPREFIX</td>
1.384   ! leot     13990: <td>RPMFILES</td>
1.332     rillig   13991: </tr>
                   13992: <tr>
1.381     dholland 13993: <td>RPMIGNOREPATH</td>
1.384   ! leot     13994: <td>RPM_DB_PREFIX</td>
1.329     leot     13995: </tr>
                   13996: <tr>
1.381     dholland 13997: <td>RSSH_CVS_PATH</td>
1.384   ! leot     13998: <td>RSSH_RDIST_PATH</td>
1.327     wiz      13999: </tr>
                   14000: <tr>
1.381     dholland 14001: <td>RSSH_RSYNC_PATH</td>
1.384   ! leot     14002: <td>RSSH_SCP_PATH</td>
1.269     leot     14003: </tr>
                   14004: <tr>
1.381     dholland 14005: <td>RSSH_SFTP_SERVER_PATH</td>
1.384   ! leot     14006: <td>RUBY</td>
1.311     leot     14007: </tr>
                   14008: <tr>
1.381     dholland 14009: <td>RUBYGEM</td>
1.384   ! leot     14010: <td>RUBYGEM_MANPAGES</td>
1.269     leot     14011: </tr>
                   14012: <tr>
1.381     dholland 14013: <td>RUBYGEM_NAME</td>
1.384   ! leot     14014: <td>RUBYGEM_OPTIONS</td>
1.269     leot     14015: </tr>
                   14016: <tr>
1.381     dholland 14017: <td>RUBYGEM_USE_MANPAGES</td>
1.384   ! leot     14018: <td>RUBYGEM_VERBOSE</td>
1.269     leot     14019: </tr>
                   14020: <tr>
1.381     dholland 14021: <td>RUBY_ABI_VERSION</td>
1.384   ! leot     14022: <td>RUBY_ARCH</td>
1.346     jnemeth  14023: </tr>
                   14024: <tr>
1.381     dholland 14025: <td>RUBY_ARCHINC</td>
1.384   ! leot     14026: <td>RUBY_ARCHLIB</td>
1.269     leot     14027: </tr>
                   14028: <tr>
1.381     dholland 14029: <td>RUBY_BASE</td>
1.384   ! leot     14030: <td>RUBY_BASERIDIR</td>
1.269     leot     14031: </tr>
                   14032: <tr>
1.381     dholland 14033: <td>RUBY_BUILD_DOCUMENT</td>
1.384   ! leot     14034: <td>RUBY_DLEXT</td>
1.269     leot     14035: </tr>
                   14036: <tr>
1.381     dholland 14037: <td>RUBY_DOC</td>
1.384   ! leot     14038: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     14039: </tr>
                   14040: <tr>
1.381     dholland 14041: <td>RUBY_EG</td>
1.384   ! leot     14042: <td>RUBY_ENCODING_ARG</td>
1.269     leot     14043: </tr>
                   14044: <tr>
1.381     dholland 14045: <td>RUBY_EXTCONF</td>
1.384   ! leot     14046: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     14047: </tr>
                   14048: <tr>
1.381     dholland 14049: <td>RUBY_EXTCONF_DEBUG</td>
1.384   ! leot     14050: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     14051: </tr>
                   14052: <tr>
1.381     dholland 14053: <td>RUBY_GEM_ARCH</td>
1.384   ! leot     14054: <td>RUBY_GEM_BASE</td>
1.269     leot     14055: </tr>
                   14056: <tr>
1.381     dholland 14057: <td>RUBY_INC</td>
1.384   ! leot     14058: <td>RUBY_LIB</td>
1.269     leot     14059: </tr>
                   14060: <tr>
1.381     dholland 14061: <td>RUBY_LIB_BASE</td>
1.384   ! leot     14062: <td>RUBY_NAME</td>
1.269     leot     14063: </tr>
                   14064: <tr>
1.381     dholland 14065: <td>RUBY_NOVERSION</td>
1.384   ! leot     14066: <td>RUBY_PKGPREFIX</td>
1.269     leot     14067: </tr>
                   14068: <tr>
1.381     dholland 14069: <td>RUBY_RAILS</td>
1.384   ! leot     14070: <td>RUBY_RAILS61_VERSION</td>
1.269     leot     14071: </tr>
                   14072: <tr>
1.381     dholland 14073: <td>RUBY_RAILS70_VERSION</td>
1.384   ! leot     14074: <td>RUBY_RAILS71_VERSION</td>
1.338     nia      14075: </tr>
                   14076: <tr>
1.381     dholland 14077: <td>RUBY_RAILS72_VERSION</td>
1.384   ! leot     14078: <td>RUBY_RAILS80_VERSION</td>
1.269     leot     14079: </tr>
                   14080: <tr>
1.381     dholland 14081: <td>RUBY_RAILS_ACCEPTED</td>
1.384   ! leot     14082: <td>RUBY_RAILS_DEFAULT</td>
1.378     leot     14083: </tr>
                   14084: <tr>
1.381     dholland 14085: <td>RUBY_RAILS_REQD</td>
1.384   ! leot     14086: <td>RUBY_RAILS_STRICT_DEP</td>
1.269     leot     14087: </tr>
                   14088: <tr>
1.381     dholland 14089: <td>RUBY_RIDIR</td>
1.384   ! leot     14090: <td>RUBY_SETUP</td>
1.269     leot     14091: </tr>
                   14092: <tr>
1.381     dholland 14093: <td>RUBY_SHLIB</td>
1.384   ! leot     14094: <td>RUBY_SHLIBALIAS</td>
1.269     leot     14095: </tr>
                   14096: <tr>
1.381     dholland 14097: <td>RUBY_SHLIBVER</td>
1.384   ! leot     14098: <td>RUBY_SIMPLE_INSTALL</td>
1.269     leot     14099: </tr>
                   14100: <tr>
1.381     dholland 14101: <td>RUBY_SITEARCHLIB</td>
1.384   ! leot     14102: <td>RUBY_SITELIB</td>
1.269     leot     14103: </tr>
                   14104: <tr>
1.381     dholland 14105: <td>RUBY_SITELIB_BASE</td>
1.384   ! leot     14106: <td>RUBY_SITERIDIR</td>
1.269     leot     14107: </tr>
                   14108: <tr>
1.381     dholland 14109: <td>RUBY_SLEXT</td>
1.384   ! leot     14110: <td>RUBY_SRCDIR</td>
1.269     leot     14111: </tr>
                   14112: <tr>
1.381     dholland 14113: <td>RUBY_STATICLIB</td>
1.384   ! leot     14114: <td>RUBY_SUFFIX</td>
1.312     gdt      14115: </tr>
                   14116: <tr>
1.381     dholland 14117: <td>RUBY_SYSRIDIR</td>
1.384   ! leot     14118: <td>RUBY_USE_PTHREAD</td>
1.289     leot     14119: </tr>
                   14120: <tr>
1.381     dholland 14121: <td>RUBY_VENDORARCHLIB</td>
1.384   ! leot     14122: <td>RUBY_VENDORLIB</td>
1.269     leot     14123: </tr>
                   14124: <tr>
1.381     dholland 14125: <td>RUBY_VENDORLIB_BASE</td>
1.384   ! leot     14126: <td>RUBY_VER</td>
1.269     leot     14127: </tr>
                   14128: <tr>
1.381     dholland 14129: <td>RUBY_VERSION</td>
1.384   ! leot     14130: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269     leot     14131: </tr>
                   14132: <tr>
1.381     dholland 14133: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.384   ! leot     14134: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     14135: </tr>
                   14136: <tr>
1.381     dholland 14137: <td>RUBY_VERSION_REQD</td>
1.384   ! leot     14138: <td>RUBY_VER_DIR</td>
1.269     leot     14139: </tr>
                   14140: <tr>
1.381     dholland 14141: <td>RUN</td>
1.384   ! leot     14142: <td>RUN_LDCONFIG</td>
1.269     leot     14143: </tr>
                   14144: <tr>
1.381     dholland 14145: <td>RUST_TYPE</td>
1.384   ! leot     14146: <td>SCO</td>
1.269     leot     14147: </tr>
                   14148: <tr>
1.381     dholland 14149: <td>SCREWS_GROUP</td>
1.384   ! leot     14150: <td>SCREWS_USER</td>
1.269     leot     14151: </tr>
                   14152: <tr>
1.381     dholland 14153: <td>SCRIPTS_ENV</td>
1.384   ! leot     14154: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     14155: </tr>
                   14156: <tr>
1.381     dholland 14157: <td>SCROLLKEEPER_REBUILDDB</td>
1.384   ! leot     14158: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     14159: </tr>
                   14160: <tr>
1.381     dholland 14161: <td>SDIST_PAWD</td>
1.384   ! leot     14162: <td>SDL12_TYPE</td>
1.269     leot     14163: </tr>
                   14164: <tr>
1.381     dholland 14165: <td>SERIAL_DEVICES</td>
1.384   ! leot     14166: <td>SETGIDGAME</td>
1.269     leot     14167: </tr>
                   14168: <tr>
1.381     dholland 14169: <td>SETGID_GAMES_PERMS</td>
1.384   ! leot     14170: <td>SETUID_ROOT_PERMS</td>
1.269     leot     14171: </tr>
                   14172: <tr>
1.381     dholland 14173: <td>SH</td>
1.384   ! leot     14174: <td>SHLIB_EXT</td>
1.269     leot     14175: </tr>
                   14176: <tr>
1.382     wiz      14177: <td>SHORTNAME</td>
1.384   ! leot     14178: <td>SIGN_PACKAGES</td>
1.382     wiz      14179: </tr>
                   14180: <tr>
                   14181: <td>SILC_CLIENT_WITH_PERL</td>
1.384   ! leot     14182: <td>SITE_SPECIFIC_PKGS</td>
1.376     wiz      14183: </tr>
                   14184: <tr>
1.382     wiz      14185: <td>SKIP_DEPENDS</td>
1.384   ! leot     14186: <td>SMF_INSTANCES</td>
1.348     wiz      14187: </tr>
                   14188: <tr>
1.382     wiz      14189: <td>SMF_MANIFEST</td>
1.384   ! leot     14190: <td>SMF_METHODS</td>
1.269     leot     14191: </tr>
                   14192: <tr>
1.382     wiz      14193: <td>SMF_METHOD_SHELL</td>
1.384   ! leot     14194: <td>SMF_METHOD_SRC</td>
1.342     wiz      14195: </tr>
                   14196: <tr>
1.382     wiz      14197: <td>SMF_NAME</td>
1.384   ! leot     14198: <td>SMF_PREFIX</td>
1.269     leot     14199: </tr>
                   14200: <tr>
1.382     wiz      14201: <td>SMF_SRCDIR</td>
1.384   ! leot     14202: <td>SNIPROXY_GROUP</td>
1.269     leot     14203: </tr>
                   14204: <tr>
1.382     wiz      14205: <td>SNIPROXY_USER</td>
1.384   ! leot     14206: <td>SOURCE_BUFFSIZE</td>
1.292     leot     14207: </tr>
                   14208: <tr>
1.382     wiz      14209: <td>SPECIAL_PERMS</td>
1.384   ! leot     14210: <td>SPECIFIC_PKGS</td>
1.269     leot     14211: </tr>
                   14212: <tr>
1.382     wiz      14213: <td>SSH_SUID</td>
1.384   ! leot     14214: <td>SSLCERTBUNDLE</td>
1.332     rillig   14215: </tr>
                   14216: <tr>
1.382     wiz      14217: <td>SSLCERTS</td>
1.384   ! leot     14218: <td>SSLDIR</td>
1.378     leot     14219: </tr>
                   14220: <tr>
1.382     wiz      14221: <td>SSLKEYS</td>
1.384   ! leot     14222: <td>SSP_SUPPORTED</td>
1.378     leot     14223: </tr>
                   14224: <tr>
1.382     wiz      14225: <td>SSYNC_PAWD</td>
1.384   ! leot     14226: <td>STEP_MSG</td>
1.269     leot     14227: </tr>
                   14228: <tr>
1.382     wiz      14229: <td>STRIP</td>
1.384   ! leot     14230: <td>STRIP_DBG</td>
1.274     rillig   14231: </tr>
                   14232: <tr>
1.382     wiz      14233: <td>STRIP_DEBUG</td>
1.384   ! leot     14234: <td>STRIP_DEBUG_SUPPORTED</td>
1.269     leot     14235: </tr>
                   14236: <tr>
1.382     wiz      14237: <td>STRIP_FILES_SKIP</td>
1.384   ! leot     14238: <td>SU</td>
1.269     leot     14239: </tr>
                   14240: <tr>
1.382     wiz      14241: <td>SUBDIR</td>
1.384   ! leot     14242: <td>SUBST</td>
1.269     leot     14243: </tr>
                   14244: <tr>
1.382     wiz      14245: <td>SUBST_CLASSES</td>
1.384   ! leot     14246: <td>SUBST_FILES</td>
1.269     leot     14247: </tr>
                   14248: <tr>
1.382     wiz      14249: <td>SUBST_FILTER_CMD</td>
1.384   ! leot     14250: <td>SUBST_MESSAGE</td>
1.269     leot     14251: </tr>
                   14252: <tr>
1.382     wiz      14253: <td>SUBST_NOOP_OK</td>
1.384   ! leot     14254: <td>SUBST_SED</td>
1.269     leot     14255: </tr>
                   14256: <tr>
1.382     wiz      14257: <td>SUBST_SHOW_DIFF</td>
1.384   ! leot     14258: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269     leot     14259: </tr>
                   14260: <tr>
1.382     wiz      14261: <td>SUBST_STAGE</td>
1.384   ! leot     14262: <td>SUBST_VARS</td>
1.269     leot     14263: </tr>
                   14264: <tr>
1.382     wiz      14265: <td>SUNWSPROBASE</td>
1.384   ! leot     14266: <td>SUSE_PREFER</td>
1.269     leot     14267: </tr>
                   14268: <tr>
1.382     wiz      14269: <td>SU_CMD</td>
1.384   ! leot     14270: <td>SVN_EXTRACTDIR</td>
1.382     wiz      14271: </tr>
                   14272: <tr>
                   14273: <td>SVN_REPO</td>
1.384   ! leot     14274: <td>SVN_REPOSITORIES</td>
1.382     wiz      14275: </tr>
                   14276: <tr>
                   14277: <td>SVN_REVISION</td>
1.384   ! leot     14278: <td>SYSCONFBASE</td>
1.360     leot     14279: </tr>
                   14280: <tr>
1.382     wiz      14281: <td>TARGET_MACHINE_ARCH</td>
1.384   ! leot     14282: <td>TBL</td>
1.376     wiz      14283: </tr>
                   14284: <tr>
1.382     wiz      14285: <td>TERMCAP_TYPE</td>
1.384   ! leot     14286: <td>TERMINFO_DEFAULT</td>
1.370     gdt      14287: </tr>
                   14288: <tr>
1.382     wiz      14289: <td>TERMINFO_TYPE</td>
1.384   ! leot     14290: <td>TEST</td>
1.352     wiz      14291: </tr>
                   14292: <tr>
1.382     wiz      14293: <td>TEST_DEPENDS</td>
1.384   ! leot     14294: <td>TEST_DIRS</td>
1.269     leot     14295: </tr>
                   14296: <tr>
1.382     wiz      14297: <td>TEST_ENV</td>
1.384   ! leot     14298: <td>TEST_ENV_SHELL</td>
1.342     wiz      14299: </tr>
                   14300: <tr>
1.382     wiz      14301: <td>TEST_MAKE_CMD</td>
1.384   ! leot     14302: <td>TEST_MAKE_FLAGS</td>
1.269     leot     14303: </tr>
                   14304: <tr>
1.382     wiz      14305: <td>TEST_TARGET</td>
1.384   ! leot     14306: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.332     rillig   14307: </tr>
                   14308: <tr>
1.382     wiz      14309: <td>TEXLIVE_REV</td>
1.384   ! leot     14310: <td>TEXLIVE_UNVERSIONED</td>
1.327     wiz      14311: </tr>
                   14312: <tr>
1.382     wiz      14313: <td>TEXMFSITE</td>
1.384   ! leot     14314: <td>TEX_FORMATS</td>
1.332     rillig   14315: </tr>
                   14316: <tr>
1.382     wiz      14317: <td>TEX_HYPHEN_DAT</td>
1.384   ! leot     14318: <td>TEX_HYPHEN_DEF</td>
1.320     wiz      14319: </tr>
                   14320: <tr>
1.382     wiz      14321: <td>TEX_TEXMF_DIRS</td>
1.384   ! leot     14322: <td>THTTPD_LOG_FACILITY</td>
1.303     bacon    14323: </tr>
                   14324: <tr>
1.382     wiz      14325: <td>TINYDYN_USER</td>
1.384   ! leot     14326: <td>TLS</td>
1.274     rillig   14327: </tr>
                   14328: <tr>
1.382     wiz      14329: <td>TLSWRAPPER_CHROOT</td>
1.384   ! leot     14330: <td>TO</td>
1.269     leot     14331: </tr>
                   14332: <tr>
1.382     wiz      14333: <td>TOOLDIR</td>
1.384   ! leot     14334: <td>TOOLS_ALIASES</td>
1.269     leot     14335: </tr>
                   14336: <tr>
1.382     wiz      14337: <td>TOOLS_ALWAYS_WRAP</td>
1.384   ! leot     14338: <td>TOOLS_ARGS</td>
1.269     leot     14339: </tr>
                   14340: <tr>
1.382     wiz      14341: <td>TOOLS_BROKEN</td>
1.384   ! leot     14342: <td>TOOLS_CMD</td>
1.269     leot     14343: </tr>
                   14344: <tr>
1.382     wiz      14345: <td>TOOLS_CMDLINE_SED</td>
1.384   ! leot     14346: <td>TOOLS_CREATE</td>
1.269     leot     14347: </tr>
                   14348: <tr>
1.382     wiz      14349: <td>TOOLS_CROSS_DESTDIR</td>
1.384   ! leot     14350: <td>TOOLS_DIR</td>
1.269     leot     14351: </tr>
                   14352: <tr>
1.382     wiz      14353: <td>TOOLS_FAIL</td>
1.384   ! leot     14354: <td>TOOLS_GNU_MISSING</td>
1.269     leot     14355: </tr>
                   14356: <tr>
1.382     wiz      14357: <td>TOOLS_LDCONFIG</td>
1.384   ! leot     14358: <td>TOOLS_NOOP</td>
1.269     leot     14359: </tr>
                   14360: <tr>
1.382     wiz      14361: <td>TOOLS_PATH</td>
1.384   ! leot     14362: <td>TOOLS_SCRIPT</td>
1.269     leot     14363: </tr>
                   14364: <tr>
1.382     wiz      14365: <td>TOOLS_USE_CROSS_COMPILE</td>
1.384   ! leot     14366: <td>TOOL_DEPENDS</td>
1.269     leot     14367: </tr>
                   14368: <tr>
1.382     wiz      14369: <td>TTF_FONTDIR</td>
1.384   ! leot     14370: <td>TTF_FONTS_DIR</td>
1.369     wiz      14371: </tr>
                   14372: <tr>
1.381     dholland 14373: <td>TYPE</td>
1.384   ! leot     14374: <td>UAC_REQD_EXECS</td>
1.378     leot     14375: </tr>
                   14376: <tr>
1.381     dholland 14377: <td>UCSPI_SSL_GROUP</td>
1.384   ! leot     14378: <td>UCSPI_SSL_USER</td>
1.355     rillig   14379: </tr>
                   14380: <tr>
1.381     dholland 14381: <td>UNBOUND_GROUP</td>
1.384   ! leot     14382: <td>UNBOUND_LOG_FACILITY</td>
1.352     wiz      14383: </tr>
                   14384: <tr>
1.381     dholland 14385: <td>UNBOUND_USER</td>
1.384   ! leot     14386: <td>UNLIMIT_RESOURCES</td>
1.379     wiz      14387: </tr>
                   14388: <tr>
1.381     dholland 14389: <td>UNPRIVILEGED</td>
1.384   ! leot     14390: <td>UNPRIVILEGED_GROUP</td>
1.379     wiz      14391: </tr>
                   14392: <tr>
1.381     dholland 14393: <td>UNPRIVILEGED_GROUPS</td>
1.384   ! leot     14394: <td>UNPRIVILEGED_USER</td>
1.269     leot     14395: </tr>
                   14396: <tr>
1.381     dholland 14397: <td>UNWRAP_FILES</td>
1.384   ! leot     14398: <td>UNWRAP_PATTERNS</td>
1.338     nia      14399: </tr>
                   14400: <tr>
1.381     dholland 14401: <td>UPDATE_GEMSPEC</td>
1.384   ! leot     14402: <td>UPDATE_TARGET</td>
1.269     leot     14403: </tr>
                   14404: <tr>
1.381     dholland 14405: <td>URI</td>
1.384   ! leot     14406: <td>USERGROUP_PHASE</td>
1.327     wiz      14407: </tr>
                   14408: <tr>
1.381     dholland 14409: <td>USERPPP_GROUP</td>
1.384   ! leot     14410: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     14411: </tr>
                   14412: <tr>
1.381     dholland 14413: <td>USE_ABI_DEPENDS</td>
1.384   ! leot     14414: <td>USE_ADA_FEATURES</td>
1.269     leot     14415: </tr>
                   14416: <tr>
1.379     wiz      14417: <td>USE_APR</td>
1.381     dholland 14418: <td>USE_BSD_MAKEFILE</td>
1.269     leot     14419: </tr>
                   14420: <tr>
1.379     wiz      14421: <td>USE_BUILTIN</td>
1.381     dholland 14422: <td>USE_CC_FEATURES</td>
1.269     leot     14423: </tr>
                   14424: <tr>
1.379     wiz      14425: <td>USE_CROSS_COMPILE</td>
1.381     dholland 14426: <td>USE_CURSES</td>
1.269     leot     14427: </tr>
                   14428: <tr>
1.379     wiz      14429: <td>USE_CWRAPPERS</td>
1.381     dholland 14430: <td>USE_CXX_FEATURES</td>
1.357     gutterid 14431: </tr>
                   14432: <tr>
1.379     wiz      14433: <td>USE_DB185</td>
1.381     dholland 14434: <td>USE_FEATURES</td>
1.269     leot     14435: </tr>
                   14436: <tr>
1.379     wiz      14437: <td>USE_GAMESGROUP</td>
1.381     dholland 14438: <td>USE_GCC_RUNTIME</td>
1.269     leot     14439: </tr>
                   14440: <tr>
1.379     wiz      14441: <td>USE_IMAKE</td>
1.381     dholland 14442: <td>USE_INDIRECT_DEPENDS</td>
1.269     leot     14443: </tr>
                   14444: <tr>
1.379     wiz      14445: <td>USE_JAVA</td>
1.378     leot     14446: <td>USE_JAVA2</td>
1.320     wiz      14447: </tr>
                   14448: <tr>
1.381     dholland 14449: <td>USE_LANGUAGES</td>
1.378     leot     14450: <td>USE_LIBTOOL</td>
1.269     leot     14451: </tr>
                   14452: <tr>
1.381     dholland 14453: <td>USE_NATIVE_GCC</td>
1.378     leot     14454: <td>USE_NETBSD_REPO</td>
1.269     leot     14455: </tr>
                   14456: <tr>
1.381     dholland 14457: <td>USE_PKGSRC_GCC</td>
1.378     leot     14458: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     14459: </tr>
                   14460: <tr>
1.381     dholland 14461: <td>USE_PKGTASKS</td>
1.378     leot     14462: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     14463: </tr>
                   14464: <tr>
1.381     dholland 14465: <td>USE_RUBY_EXTCONF</td>
1.378     leot     14466: <td>USE_RUBY_INSTALL</td>
1.269     leot     14467: </tr>
                   14468: <tr>
1.381     dholland 14469: <td>USE_RUBY_SETUP</td>
1.378     leot     14470: <td>USE_RUBY_SETUP_PKG</td>
1.269     leot     14471: </tr>
                   14472: <tr>
1.381     dholland 14473: <td>USE_TMPFILES</td>
1.378     leot     14474: <td>USE_TOOLS</td>
1.376     wiz      14475: </tr>
                   14476: <tr>
1.381     dholland 14477: <td>UUCP_GROUP</td>
1.378     leot     14478: <td>UUCP_USER</td>
1.269     leot     14479: </tr>
                   14480: <tr>
1.381     dholland 14481: <td>VARBASE</td>
1.378     leot     14482: <td>VARNAME</td>
1.269     leot     14483: </tr>
                   14484: <tr>
1.381     dholland 14485: <td>VIM_EXTRA_OPTS</td>
1.378     leot     14486: <td>WARNING_MSG</td>
1.269     leot     14487: </tr>
                   14488: <tr>
1.381     dholland 14489: <td>WCALC_CGIDIR</td>
1.378     leot     14490: <td>WCALC_CGIPATH</td>
1.269     leot     14491: </tr>
                   14492: <tr>
1.381     dholland 14493: <td>WCALC_HTMLDIR</td>
1.378     leot     14494: <td>WCALC_HTMLPATH</td>
1.269     leot     14495: </tr>
                   14496: <tr>
1.381     dholland 14497: <td>WDM_MANAGERS</td>
1.378     leot     14498: <td>WRAPPER_CC</td>
1.269     leot     14499: </tr>
                   14500: <tr>
1.381     dholland 14501: <td>WRAPPER_REORDER_CMDS</td>
1.378     leot     14502: <td>WRKDIR</td>
1.269     leot     14503: </tr>
                   14504: <tr>
1.381     dholland 14505: <td>WRKDIR_BASENAME</td>
1.378     leot     14506: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     14507: </tr>
                   14508: <tr>
1.381     dholland 14509: <td>WRKLOG</td>
1.378     leot     14510: <td>WRKOBJDIR</td>
1.269     leot     14511: </tr>
                   14512: <tr>
1.381     dholland 14513: <td>WRKSRC</td>
1.378     leot     14514: <td>X10_PORT</td>
1.269     leot     14515: </tr>
                   14516: <tr>
1.381     dholland 14517: <td>X11</td>
1.378     leot     14518: <td>X11BASE</td>
1.269     leot     14519: </tr>
                   14520: <tr>
1.381     dholland 14521: <td>X11_PKGSRCDIR</td>
1.378     leot     14522: <td>X11_TYPE</td>
1.269     leot     14523: </tr>
                   14524: <tr>
1.381     dholland 14525: <td>X509_CERTIFICATE</td>
1.378     leot     14526: <td>X509_KEY</td>
1.269     leot     14527: </tr>
                   14528: <tr>
1.381     dholland 14529: <td>XAW_TYPE</td>
1.378     leot     14530: <td>XLOCK_DEFAULT_MODE</td>
1.303     bacon    14531: </tr>
                   14532: <tr>
1.381     dholland 14533: <td>XMKMF</td>
1.378     leot     14534: <td>XMKMF_FLAGS</td>
1.269     leot     14535: </tr>
                   14536: <tr>
1.381     dholland 14537: <td>XXX</td>
1.382     wiz      14538: <td>XXXX</td>
                   14539: </tr>
                   14540: <tr>
1.379     wiz      14541: <td>YES</td>
1.382     wiz      14542: <td>ZSH_STATIC</td>
1.269     leot     14543: </tr>
                   14544: <tr>
1.379     wiz      14545: <td>__stdc__</td>
1.382     wiz      14546: <td>_vargroups</td>
1.367     gdt      14547: </tr>
                   14548: <tr>
1.379     wiz      14549: <td>accept</td>
1.382     wiz      14550: <td>acquire-localbase-lock</td>
1.360     leot     14551: </tr>
                   14552: <tr>
1.379     wiz      14553: <td>acquire-lock</td>
1.382     wiz      14554: <td>add</td>
1.348     wiz      14555: </tr>
                   14556: <tr>
1.379     wiz      14557: <td>added</td>
1.382     wiz      14558: <td>administrator</td>
1.269     leot     14559: </tr>
                   14560: <tr>
1.379     wiz      14561: <td>alloca</td>
1.382     wiz      14562: <td>alternatives</td>
1.342     wiz      14563: </tr>
                   14564: <tr>
1.379     wiz      14565: <td>aslr</td>
1.382     wiz      14566: <td>asprintf</td>
1.269     leot     14567: </tr>
                   14568: <tr>
1.379     wiz      14569: <td>atlas</td>
1.382     wiz      14570: <td>autoconf</td>
1.274     rillig   14571: </tr>
                   14572: <tr>
1.379     wiz      14573: <td>automake</td>
1.382     wiz      14574: <td>autoreconf</td>
1.332     rillig   14575: </tr>
                   14576: <tr>
1.379     wiz      14577: <td>awk</td>
1.384   ! leot     14578: <td>barrier</td>
        !          14579: </tr>
        !          14580: <tr>
1.382     wiz      14581: <td>bash</td>
1.384   ! leot     14582: <td>big-endian</td>
1.269     leot     14583: </tr>
                   14584: <tr>
1.382     wiz      14585: <td>bin-install</td>
1.384   ! leot     14586: <td>bind</td>
1.316     cirnatda 14587: </tr>
                   14588: <tr>
1.382     wiz      14589: <td>binpkg-list</td>
1.384   ! leot     14590: <td>blas</td>
1.289     leot     14591: </tr>
                   14592: <tr>
1.382     wiz      14593: <td>bootstrap-depends</td>
1.384   ! leot     14594: <td>broken</td>
1.269     leot     14595: </tr>
                   14596: <tr>
1.382     wiz      14597: <td>broken_on_platform</td>
1.384   ! leot     14598: <td>bsd</td>
1.269     leot     14599: </tr>
                   14600: <tr>
1.382     wiz      14601: <td>bsd.prog.mk</td>
1.384   ! leot     14602: <td>build</td>
1.289     leot     14603: </tr>
                   14604: <tr>
1.382     wiz      14605: <td>build-env</td>
1.384   ! leot     14606: <td>buildlink-directories</td>
1.269     leot     14607: </tr>
                   14608: <tr>
1.382     wiz      14609: <td>buildlink-oss-soundcard-h</td>
1.384   ! leot     14610: <td>built-in</td>
1.269     leot     14611: </tr>
                   14612: <tr>
1.382     wiz      14613: <td>builtin</td>
1.384   ! leot     14614: <td>c</td>
1.269     leot     14615: </tr>
                   14616: <tr>
1.382     wiz      14617: <td>c++</td>
1.384   ! leot     14618: <td>ccache</td>
1.271     brook    14619: </tr>
                   14620: <tr>
1.382     wiz      14621: <td>cce</td>
1.384   ! leot     14622: <td>cdefs</td>
1.269     leot     14623: </tr>
                   14624: <tr>
1.382     wiz      14625: <td>ceil</td>
1.384   ! leot     14626: <td>changes</td>
1.356     gutterid 14627: </tr>
                   14628: <tr>
1.382     wiz      14629: <td>changes-entry</td>
1.384   ! leot     14630: <td>changes-entry-noupdate</td>
1.292     leot     14631: </tr>
                   14632: <tr>
1.382     wiz      14633: <td>check</td>
1.384   ! leot     14634: <td>check-clean</td>
1.274     rillig   14635: </tr>
                   14636: <tr>
1.382     wiz      14637: <td>check-files</td>
1.384   ! leot     14638: <td>check-files-clean</td>
1.269     leot     14639: </tr>
                   14640: <tr>
1.382     wiz      14641: <td>check-hackage</td>
1.384   ! leot     14642: <td>check-vulnerable</td>
1.289     leot     14643: </tr>
                   14644: <tr>
1.382     wiz      14645: <td>checksum</td>
1.384   ! leot     14646: <td>checksum-phase</td>
1.269     leot     14647: </tr>
                   14648: <tr>
1.382     wiz      14649: <td>clean</td>
1.384   ! leot     14650: <td>clean-depends</td>
1.370     gdt      14651: </tr>
                   14652: <tr>
1.382     wiz      14653: <td>cleandir</td>
1.384   ! leot     14654: <td>commit</td>
1.269     leot     14655: </tr>
                   14656: <tr>
1.382     wiz      14657: <td>commit-changes-entry</td>
1.384   ! leot     14658: <td>compact</td>
1.269     leot     14659: </tr>
                   14660: <tr>
1.382     wiz      14661: <td>compiler</td>
1.384   ! leot     14662: <td>conf</td>
1.269     leot     14663: </tr>
                   14664: <tr>
1.382     wiz      14665: <td>config.guess</td>
1.384   ! leot     14666: <td>config.sub</td>
1.289     leot     14667: </tr>
                   14668: <tr>
1.382     wiz      14669: <td>configuration</td>
1.384   ! leot     14670: <td>configure</td>
1.269     leot     14671: </tr>
                   14672: <tr>
1.382     wiz      14673: <td>configure-env</td>
1.384   ! leot     14674: <td>configure-help</td>
1.269     leot     14675: </tr>
                   14676: <tr>
1.382     wiz      14677: <td>configure_args</td>
1.384   ! leot     14678: <td>connect</td>
1.269     leot     14679: </tr>
                   14680: <tr>
1.382     wiz      14681: <td>cos</td>
1.384   ! leot     14682: <td>cpe</td>
1.269     leot     14683: </tr>
                   14684: <tr>
1.382     wiz      14685: <td>cputime</td>
1.384   ! leot     14686: <td>create-usergroup</td>
1.269     leot     14687: </tr>
                   14688: <tr>
1.382     wiz      14689: <td>csh</td>
1.384   ! leot     14690: <td>ctf</td>
1.269     leot     14691: </tr>
                   14692: <tr>
1.382     wiz      14693: <td>cvs</td>
1.384   ! leot     14694: <td>debug</td>
1.269     leot     14695: </tr>
                   14696: <tr>
1.384   ! leot     14697: <td>debug-barrier</td>
1.381     dholland 14698: <td>declaration</td>
1.378     leot     14699: </tr>
                   14700: <tr>
1.379     wiz      14701: <td>declare</td>
1.381     dholland 14702: <td>defined</td>
1.376     wiz      14703: </tr>
                   14704: <tr>
1.379     wiz      14705: <td>depend</td>
1.381     dholland 14706: <td>dependencies</td>
1.355     rillig   14707: </tr>
                   14708: <tr>
1.379     wiz      14709: <td>depends</td>
1.381     dholland 14710: <td>depends-checksum</td>
1.352     wiz      14711: </tr>
                   14712: <tr>
1.379     wiz      14713: <td>depends-fetch</td>
1.381     dholland 14714: <td>deps</td>
1.338     nia      14715: </tr>
                   14716: <tr>
1.379     wiz      14717: <td>describe</td>
1.381     dholland 14718: <td>destdir</td>
1.289     leot     14719: </tr>
                   14720: <tr>
1.379     wiz      14721: <td>disable</td>
1.381     dholland 14722: <td>distclean</td>
1.329     leot     14723: </tr>
                   14724: <tr>
1.379     wiz      14725: <td>distfiles</td>
1.381     dholland 14726: <td>distinfo</td>
1.320     wiz      14727: </tr>
                   14728: <tr>
1.378     leot     14729: <td>dl</td>
1.381     dholland 14730: <td>dlopen</td>
1.269     leot     14731: </tr>
                   14732: <tr>
1.378     leot     14733: <td>do-buildlink</td>
1.381     dholland 14734: <td>do-clean</td>
1.311     leot     14735: </tr>
                   14736: <tr>
1.378     leot     14737: <td>do-configure</td>
1.381     dholland 14738: <td>do-configure-post-hook</td>
1.269     leot     14739: </tr>
                   14740: <tr>
1.378     leot     14741: <td>do-extract</td>
1.376     wiz      14742: <td>do-fetch</td>
1.269     leot     14743: </tr>
                   14744: <tr>
1.382     wiz      14745: <td>do-install</td>
1.375     jkoshy   14746: <td>download</td>
1.382     wiz      14747: </tr>
                   14748: <tr>
1.377     jnemeth  14749: <td>emul</td>
1.382     wiz      14750: <td>emul-distinfo</td>
1.269     leot     14751: </tr>
                   14752: <tr>
1.377     jnemeth  14753: <td>emul-fetch</td>
1.382     wiz      14754: <td>emulation</td>
1.269     leot     14755: </tr>
                   14756: <tr>
1.377     jnemeth  14757: <td>emulator</td>
1.382     wiz      14758: <td>enable</td>
1.277     rillig   14759: </tr>
                   14760: <tr>
1.352     wiz      14761: <td>endian</td>
1.382     wiz      14762: <td>endif</td>
1.376     wiz      14763: </tr>
                   14764: <tr>
1.365     gutterid 14765: <td>enomem</td>
1.381     dholland 14766: <td>ensurepip</td>
1.378     leot     14767: </tr>
                   14768: <tr>
                   14769: <td>err</td>
1.381     dholland 14770: <td>errx</td>
1.367     gdt      14771: </tr>
                   14772: <tr>
1.378     leot     14773: <td>etc</td>
1.381     dholland 14774: <td>exp</td>
1.348     wiz      14775: </tr>
                   14776: <tr>
1.378     leot     14777: <td>extract-rpm</td>
1.381     dholland 14778: <td>fabs</td>
1.269     leot     14779: </tr>
                   14780: <tr>
1.378     leot     14781: <td>feature</td>
1.381     dholland 14782: <td>features</td>
1.342     wiz      14783: </tr>
                   14784: <tr>
1.378     leot     14785: <td>fetch</td>
1.381     dholland 14786: <td>fetch-list</td>
1.329     leot     14787: </tr>
                   14788: <tr>
1.378     leot     14789: <td>follows</td>
1.381     dholland 14790: <td>forbids</td>
1.269     leot     14791: </tr>
                   14792: <tr>
1.378     leot     14793: <td>form</td>
1.381     dholland 14794: <td>format</td>
1.320     wiz      14795: </tr>
                   14796: <tr>
1.378     leot     14797: <td>fortify</td>
1.376     wiz      14798: <td>fortify_source</td>
1.352     wiz      14799: </tr>
                   14800: <tr>
1.382     wiz      14801: <td>fossil</td>
1.375     jkoshy   14802: <td>friend</td>
1.382     wiz      14803: </tr>
                   14804: <tr>
1.377     jnemeth  14805: <td>fts</td>
1.382     wiz      14806: <td>fts_close</td>
1.369     wiz      14807: </tr>
                   14808: <tr>
1.377     jnemeth  14809: <td>fts_open</td>
1.382     wiz      14810: <td>fts_read</td>
1.355     rillig   14811: </tr>
                   14812: <tr>
1.377     jnemeth  14813: <td>fts_set</td>
1.382     wiz      14814: <td>gcc</td>
1.332     rillig   14815: </tr>
                   14816: <tr>
1.377     jnemeth  14817: <td>gethostbyaddr</td>
1.382     wiz      14818: <td>gethostbyname</td>
1.338     nia      14819: </tr>
                   14820: <tr>
1.377     jnemeth  14821: <td>gethostbyname2</td>
1.382     wiz      14822: <td>getopt_long</td>
1.269     leot     14823: </tr>
                   14824: <tr>
1.377     jnemeth  14825: <td>getprogname</td>
1.382     wiz      14826: <td>getservbyname</td>
1.269     leot     14827: </tr>
                   14828: <tr>
1.377     jnemeth  14829: <td>getservbyport</td>
1.382     wiz      14830: <td>getservent</td>
1.269     leot     14831: </tr>
                   14832: <tr>
1.352     wiz      14833: <td>gettext</td>
1.382     wiz      14834: <td>git</td>
1.376     wiz      14835: </tr>
                   14836: <tr>
1.365     gutterid 14837: <td>github</td>
1.381     dholland 14838: <td>gitlab</td>
1.378     leot     14839: </tr>
                   14840: <tr>
                   14841: <td>glob</td>
1.381     dholland 14842: <td>gnu</td>
1.367     gdt      14843: </tr>
                   14844: <tr>
1.378     leot     14845: <td>gnu_configure_strict</td>
1.381     dholland 14846: <td>go</td>
1.348     wiz      14847: </tr>
                   14848: <tr>
1.378     leot     14849: <td>go-deps</td>
1.381     dholland 14850: <td>golang</td>
1.289     leot     14851: </tr>
                   14852: <tr>
1.378     leot     14853: <td>guess-license</td>
1.381     dholland 14854: <td>hashbang</td>
1.342     wiz      14855: </tr>
                   14856: <tr>
1.378     leot     14857: <td>heimdal</td>
1.376     wiz      14858: <td>help</td>
1.352     wiz      14859: </tr>
                   14860: <tr>
1.382     wiz      14861: <td>hg</td>
1.375     jkoshy   14862: <td>imake</td>
1.382     wiz      14863: </tr>
                   14864: <tr>
1.377     jnemeth  14865: <td>in-tree</td>
1.382     wiz      14866: <td>increment</td>
1.369     wiz      14867: </tr>
                   14868: <tr>
1.377     jnemeth  14869: <td>indirect</td>
1.382     wiz      14870: <td>inet_aton</td>
1.355     rillig   14871: </tr>
                   14872: <tr>
1.379     wiz      14873: <td>install</td>
1.382     wiz      14874: <td>install-env</td>
1.379     wiz      14875: </tr>
                   14876: <tr>
1.377     jnemeth  14877: <td>interp</td>
1.382     wiz      14878: <td>interpreter</td>
1.269     leot     14879: </tr>
                   14880: <tr>
1.377     jnemeth  14881: <td>intl</td>
1.382     wiz      14882: <td>ip4</td>
1.329     leot     14883: </tr>
                   14884: <tr>
1.377     jnemeth  14885: <td>ip6</td>
1.382     wiz      14886: <td>ipv4</td>
1.269     leot     14887: </tr>
                   14888: <tr>
1.377     jnemeth  14889: <td>ipv6</td>
1.382     wiz      14890: <td>iso</td>
1.320     wiz      14891: </tr>
                   14892: <tr>
1.377     jnemeth  14893: <td>kerberos</td>
1.382     wiz      14894: <td>krb</td>
1.311     leot     14895: </tr>
                   14896: <tr>
1.377     jnemeth  14897: <td>krb5</td>
1.382     wiz      14898: <td>ksh</td>
1.269     leot     14899: </tr>
                   14900: <tr>
1.377     jnemeth  14901: <td>lapack</td>
1.382     wiz      14902: <td>latex</td>
1.269     leot     14903: </tr>
                   14904: <tr>
1.377     jnemeth  14905: <td>libiconv</td>
1.382     wiz      14906: <td>libintl_bindtextdomain</td>
1.269     leot     14907: </tr>
                   14908: <tr>
1.377     jnemeth  14909: <td>libintl_gettext</td>
1.382     wiz      14910: <td>libintl_textdomain</td>
1.269     leot     14911: </tr>
                   14912: <tr>
1.377     jnemeth  14913: <td>libnbcompat</td>
1.382     wiz      14914: <td>libs</td>
1.303     bacon    14915: </tr>
                   14916: <tr>
1.377     jnemeth  14917: <td>libtool</td>
1.382     wiz      14918: <td>licence</td>
1.303     bacon    14919: </tr>
                   14920: <tr>
1.377     jnemeth  14921: <td>license</td>
1.382     wiz      14922: <td>lintl</td>
1.269     leot     14923: </tr>
                   14924: <tr>
1.377     jnemeth  14925: <td>little-endian</td>
1.382     wiz      14926: <td>lock</td>
1.292     leot     14927: </tr>
                   14928: <tr>
1.377     jnemeth  14929: <td>locking</td>
1.382     wiz      14930: <td>lua</td>
1.269     leot     14931: </tr>
                   14932: <tr>
1.377     jnemeth  14933: <td>lvalue</td>
1.382     wiz      14934: <td>machine_endian</td>
1.289     leot     14935: </tr>
                   14936: <tr>
1.355     rillig   14937: <td>make</td>
1.382     wiz      14938: <td>makedistinfo</td>
1.274     rillig   14939: </tr>
                   14940: <tr>
1.377     jnemeth  14941: <td>makepatchsum</td>
1.382     wiz      14942: <td>makesum</td>
1.377     jnemeth  14943: </tr>
                   14944: <tr>
                   14945: <td>mdi</td>
1.382     wiz      14946: <td>memory</td>
1.360     leot     14947: </tr>
                   14948: <tr>
1.382     wiz      14949: <td>mercurial</td>
1.381     dholland 14950: <td>meta</td>
1.378     leot     14951: </tr>
                   14952: <tr>
1.377     jnemeth  14953: <td>meta-package</td>
1.381     dholland 14954: <td>meta_package</td>
1.376     wiz      14955: </tr>
                   14956: <tr>
1.377     jnemeth  14957: <td>mit-krb5</td>
1.381     dholland 14958: <td>mk.conf</td>
1.367     gdt      14959: </tr>
                   14960: <tr>
1.377     jnemeth  14961: <td>mkl</td>
1.381     dholland 14962: <td>mount</td>
1.271     brook    14963: </tr>
                   14964: <tr>
1.377     jnemeth  14965: <td>move</td>
1.381     dholland 14966: <td>moved</td>
1.348     wiz      14967: </tr>
                   14968: <tr>
1.377     jnemeth  14969: <td>mprotect</td>
1.381     dholland 14970: <td>mps</td>
1.342     wiz      14971: </tr>
                   14972: <tr>
1.376     wiz      14973: <td>mremap</td>
1.381     dholland 14974: <td>native</td>
1.269     leot     14975: </tr>
                   14976: <tr>
1.376     wiz      14977: <td>nb</td>
1.381     dholland 14978: <td>nbcompat</td>
1.269     leot     14979: </tr>
                   14980: <tr>
1.376     wiz      14981: <td>netlib</td>
1.381     dholland 14982: <td>network</td>
1.292     leot     14983: </tr>
                   14984: <tr>
1.376     wiz      14985: <td>node</td>
1.381     dholland 14986: <td>node.js</td>
1.370     gdt      14987: </tr>
                   14988: <tr>
1.376     wiz      14989: <td>nodejs</td>
1.381     dholland 14990: <td>obstack</td>
1.274     rillig   14991: </tr>
                   14992: <tr>
1.376     wiz      14993: <td>obstack_ptr_grow</td>
1.381     dholland 14994: <td>occurs</td>
1.341     gutterid 14995: </tr>
                   14996: <tr>
1.376     wiz      14997: <td>only</td>
1.381     dholland 14998: <td>openblas</td>
1.269     leot     14999: </tr>
                   15000: <tr>
1.376     wiz      15001: <td>options</td>
1.381     dholland 15002: <td>options.mk</td>
1.269     leot     15003: </tr>
                   15004: <tr>
1.376     wiz      15005: <td>order</td>
1.381     dholland 15006: <td>override</td>
1.333     nia      15007: </tr>
                   15008: <tr>
1.376     wiz      15009: <td>override-intltool</td>
1.381     dholland 15010: <td>override-message-intltool</td>
1.333     nia      15011: </tr>
                   15012: <tr>
1.376     wiz      15013: <td>package</td>
1.381     dholland 15014: <td>parallel</td>
1.320     wiz      15015: </tr>
                   15016: <tr>
1.376     wiz      15017: <td>path</td>
1.381     dholland 15018: <td>pax</td>
1.269     leot     15019: </tr>
                   15020: <tr>
1.376     wiz      15021: <td>paxctl</td>
1.381     dholland 15022: <td>pbulk-index</td>
1.269     leot     15023: </tr>
                   15024: <tr>
1.376     wiz      15025: <td>pc</td>
1.381     dholland 15026: <td>perl</td>
1.269     leot     15027: </tr>
                   15028: <tr>
1.376     wiz      15029: <td>perl5</td>
1.381     dholland 15030: <td>perms</td>
1.271     brook    15031: </tr>
                   15032: <tr>
1.376     wiz      15033: <td>php</td>
1.381     dholland 15034: <td>pkg-build-options</td>
1.269     leot     15035: </tr>
                   15036: <tr>
1.376     wiz      15037: <td>pkg-config</td>
1.381     dholland 15038: <td>pkg_build_options</td>
1.269     leot     15039: </tr>
                   15040: <tr>
1.376     wiz      15041: <td>pkgsrc</td>
1.381     dholland 15042: <td>platform</td>
1.269     leot     15043: </tr>
                   15044: <tr>
1.376     wiz      15045: <td>plist</td>
1.381     dholland 15046: <td>post-extract</td>
1.269     leot     15047: </tr>
                   15048: <tr>
1.376     wiz      15049: <td>post-fetch</td>
1.381     dholland 15050: <td>post-wrapper</td>
1.269     leot     15051: </tr>
                   15052: <tr>
1.376     wiz      15053: <td>pre-build-checks-hook</td>
1.381     dholland 15054: <td>pre-configure-checks-hook</td>
1.269     leot     15055: </tr>
                   15056: <tr>
1.376     wiz      15057: <td>pre-extract</td>
1.381     dholland 15058: <td>pre-fetch</td>
1.269     leot     15059: </tr>
                   15060: <tr>
1.376     wiz      15061: <td>print-go-deps</td>
1.381     dholland 15062: <td>print-plist</td>
1.269     leot     15063: </tr>
                   15064: <tr>
1.376     wiz      15065: <td>print-summary-data</td>
1.381     dholland 15066: <td>privileged-install-hook</td>
1.269     leot     15067: </tr>
                   15068: <tr>
1.376     wiz      15069: <td>pypi</td>
1.381     dholland 15070: <td>python</td>
1.269     leot     15071: </tr>
                   15072: <tr>
1.376     wiz      15073: <td>r</td>
1.381     dholland 15074: <td>readme-all</td>
1.269     leot     15075: </tr>
                   15076: <tr>
1.376     wiz      15077: <td>recursive</td>
1.381     dholland 15078: <td>recv</td>
1.289     leot     15079: </tr>
                   15080: <tr>
1.376     wiz      15081: <td>recvfrom</td>
1.381     dholland 15082: <td>regcomp</td>
1.269     leot     15083: </tr>
                   15084: <tr>
1.376     wiz      15085: <td>release-localbase-lock</td>
1.381     dholland 15086: <td>release-lock</td>
1.269     leot     15087: </tr>
                   15088: <tr>
1.376     wiz      15089: <td>relro</td>
1.381     dholland 15090: <td>remove</td>
1.269     leot     15091: </tr>
                   15092: <tr>
1.376     wiz      15093: <td>removed</td>
1.381     dholland 15094: <td>rename</td>
1.269     leot     15095: </tr>
                   15096: <tr>
1.376     wiz      15097: <td>renamed</td>
1.381     dholland 15098: <td>reorder</td>
1.269     leot     15099: </tr>
                   15100: <tr>
1.376     wiz      15101: <td>replace</td>
1.381     dholland 15102: <td>replace_interpreter</td>
1.289     leot     15103: </tr>
                   15104: <tr>
1.376     wiz      15105: <td>reproducible</td>
1.381     dholland 15106: <td>resolv</td>
1.289     leot     15107: </tr>
                   15108: <tr>
1.376     wiz      15109: <td>root</td>
1.381     dholland 15110: <td>ruby</td>
1.269     leot     15111: </tr>
                   15112: <tr>
1.376     wiz      15113: <td>send</td>
1.381     dholland 15114: <td>sendfile</td>
1.341     gutterid 15115: </tr>
                   15116: <tr>
1.376     wiz      15117: <td>sendto</td>
1.381     dholland 15118: <td>setenv</td>
1.341     gutterid 15119: </tr>
                   15120: <tr>
1.376     wiz      15121: <td>setgid</td>
1.381     dholland 15122: <td>setprogname</td>
1.269     leot     15123: </tr>
                   15124: <tr>
1.376     wiz      15125: <td>setuid</td>
1.381     dholland 15126: <td>sh</td>
1.269     leot     15127: </tr>
                   15128: <tr>
1.376     wiz      15129: <td>shebang</td>
1.381     dholland 15130: <td>show</td>
1.269     leot     15131: </tr>
                   15132: <tr>
1.376     wiz      15133: <td>show-all</td>
1.381     dholland 15134: <td>show-build-defs</td>
1.289     leot     15135: </tr>
                   15136: <tr>
1.376     wiz      15137: <td>show-depends</td>
1.381     dholland 15138: <td>show-depends-dirs</td>
1.269     leot     15139: </tr>
                   15140: <tr>
1.376     wiz      15141: <td>show-depends-pkgpaths</td>
1.381     dholland 15142: <td>show-depends-recursive</td>
1.269     leot     15143: </tr>
                   15144: <tr>
1.376     wiz      15145: <td>show-deps</td>
1.381     dholland 15146: <td>show-distfiles</td>
1.269     leot     15147: </tr>
                   15148: <tr>
1.376     wiz      15149: <td>show-downlevel</td>
1.381     dholland 15150: <td>show-subdir-var</td>
1.269     leot     15151: </tr>
                   15152: <tr>
1.376     wiz      15153: <td>show-tools</td>
1.381     dholland 15154: <td>show-var</td>
1.296     rillig   15155: </tr>
                   15156: <tr>
1.376     wiz      15157: <td>show-vars</td>
1.381     dholland 15158: <td>snprintf</td>
1.269     leot     15159: </tr>
                   15160: <tr>
1.376     wiz      15161: <td>socket</td>
1.381     dholland 15162: <td>ssp</td>
1.337     gutterid 15163: </tr>
                   15164: <tr>
1.376     wiz      15165: <td>st_mode</td>
1.381     dholland 15166: <td>stage-install</td>
1.338     nia      15167: </tr>
                   15168: <tr>
1.376     wiz      15169: <td>strcasestr</td>
1.381     dholland 15170: <td>strict</td>
1.269     leot     15171: </tr>
                   15172: <tr>
1.376     wiz      15173: <td>strip</td>
1.381     dholland 15174: <td>strndup</td>
1.269     leot     15175: </tr>
                   15176: <tr>
1.376     wiz      15177: <td>strnlen</td>
1.381     dholland 15178: <td>strsep</td>
1.269     leot     15179: </tr>
                   15180: <tr>
1.376     wiz      15181: <td>subst</td>
1.379     wiz      15182: <td>substitutions</td>
1.369     wiz      15183: </tr>
                   15184: <tr>
1.382     wiz      15185: <td>subversion</td>
1.379     wiz      15186: <td>sun</td>
1.382     wiz      15187: </tr>
                   15188: <tr>
1.369     wiz      15189: <td>sunpro</td>
1.382     wiz      15190: <td>sunwspro</td>
1.329     leot     15191: </tr>
                   15192: <tr>
1.382     wiz      15193: <td>svn</td>
1.381     dholland 15194: <td>symlink</td>
1.378     leot     15195: </tr>
                   15196: <tr>
1.368     gutterid 15197: <td>test</td>
1.381     dholland 15198: <td>test-env</td>
1.367     gdt      15199: </tr>
                   15200: <tr>
1.368     gutterid 15201: <td>tex</td>
1.381     dholland 15202: <td>texlive</td>
1.327     wiz      15203: </tr>
                   15204: <tr>
1.368     gutterid 15205: <td>tmp</td>
1.381     dholland 15206: <td>todo</td>
1.342     wiz      15207: </tr>
                   15208: <tr>
1.368     gutterid 15209: <td>tool</td>
1.381     dholland 15210: <td>tools</td>
1.338     nia      15211: </tr>
                   15212: <tr>
1.368     gutterid 15213: <td>tools-libtool-m4-override</td>
1.381     dholland 15214: <td>transitive</td>
1.269     leot     15215: </tr>
                   15216: <tr>
1.368     gutterid 15217: <td>type</td>
1.381     dholland 15218: <td>ulimit</td>
1.269     leot     15219: </tr>
                   15220: <tr>
1.368     gutterid 15221: <td>undefined</td>
1.381     dholland 15222: <td>undo-replace</td>
1.269     leot     15223: </tr>
                   15224: <tr>
1.368     gutterid 15225: <td>unlimit</td>
1.381     dholland 15226: <td>unprivileged</td>
1.269     leot     15227: </tr>
                   15228: <tr>
1.368     gutterid 15229: <td>unprivileged-install-hook</td>
1.381     dholland 15230: <td>unstripped</td>
1.269     leot     15231: </tr>
                   15232: <tr>
1.368     gutterid 15233: <td>update</td>
1.381     dholland 15234: <td>updated</td>
1.269     leot     15235: </tr>
                   15236: <tr>
1.368     gutterid 15237: <td>upload</td>
1.381     dholland 15238: <td>upload-distfiles</td>
1.269     leot     15239: </tr>
                   15240: <tr>
1.368     gutterid 15241: <td>use_tools</td>
1.381     dholland 15242: <td>user</td>
1.269     leot     15243: </tr>
                   15244: <tr>
1.368     gutterid 15245: <td>utimes</td>
1.381     dholland 15246: <td>vasprintf</td>
1.269     leot     15247: </tr>
                   15248: <tr>
1.368     gutterid 15249: <td>verbose</td>
1.381     dholland 15250: <td>vsnprintf</td>
1.269     leot     15251: </tr>
                   15252: <tr>
1.368     gutterid 15253: <td>warn</td>
1.381     dholland 15254: <td>warning</td>
1.269     leot     15255: </tr>
                   15256: <tr>
1.368     gutterid 15257: <td>warnings</td>
1.381     dholland 15258: <td>warnx</td>
1.269     leot     15259: </tr>
                   15260: <tr>
1.368     gutterid 15261: <td>wattr_off</td>
1.381     dholland 15262: <td>wattr_on</td>
1.269     leot     15263: </tr>
                   15264: <tr>
1.368     gutterid 15265: <td>work</td>
1.381     dholland 15266: <td>wrapper</td>
1.269     leot     15267: </tr>
                   15268: <tr>
1.289     leot     15269: <td>wrkdir</td>
1.381     dholland 15270: <td> </td>
1.269     leot     15271: </tr>
                   15272: </table>
1.267     rillig   15273: </div>
                   15274: <div class="appendix">
                   15275: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     15276: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   15277: <div class="toc">
                   15278: <p><b>Table of Contents</b></p>
1.210     leot     15279: <dl class="toc">
1.322     leot     15280: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   15281: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig   15282: </dl>
                   15283: </div>
1.79      rillig   15284: <p>This section contains information on editing the pkgsrc
                   15285:        guide itself.</p>
1.148     asau     15286: <div class="sect1">
1.75      rillig   15287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     15288: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79      rillig   15289: <p>The pkgsrc guide's source code is stored in
                   15290:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   15291:        are created from it:</p>
1.148     asau     15292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      15293: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   15294: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     15295: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/" target="_top">https://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   15296: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   15297:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     15298: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   15299:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   15300: </ul></div>
                   15301: </div>
1.148     asau     15302: <div class="sect1">
1.75      rillig   15303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     15304: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79      rillig   15305: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      15306: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    15307: <li class="step"><p>Make sure you have checked out the htdocs repository
                   15308:        into a sibling directory of your pkgsrc directory.  You will need
                   15309:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     15310: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      15311:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   15312:        documentation) installed. These are automatically installed when
1.322     leot     15313:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     15314: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   15315:        right directory. All further steps will take place
                   15316:        here.</p></li>
1.148     asau     15317: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   15318:        <code class="filename">files/</code>.</p></li>
1.148     asau     15319: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   15320:        guide for valid XML and to build the final output files. If you
                   15321:        get any errors at this stage, you can just edit the files, as
                   15322:        there are only symbolic links in the working directory, pointing
                   15323:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     15324: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   15325:        commit)</strong></span></p></li>
1.148     asau     15326: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   15327:        regenerate the output files with the proper RCS
                   15328:        Ids.</p></li>
1.148     asau     15329: <li class="step">
1.110     hubertf  15330: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   15331:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   15332:        <code class="filename">htdocs</code>.</p>
1.148     asau     15333: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   15334: <h3 class="title">Note</h3>
                   15335: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  15336:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   15337:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   15338:        directory.</p>
                   15339: </div>
                   15340: </li>
1.79      rillig   15341: </ol></div>
1.75      rillig   15342: </div>
                   15343: </div>
                   15344: </div></body>
1.1       grant    15345: </html>

CVSweb <webmaster@jp.NetBSD.org>