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

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.328     jnemeth    33: <div><p class="copyright">Copyright © 1994-2022 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.41 2022/01/01 06:45:38 jnemeth 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>
                    106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       108: <dd><dl>
1.267     rillig    109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       112: </dl></dd>
1.267     rillig    113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    115: </dl></dd>
1.267     rillig    116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    117: <dd><dl>
1.267     rillig    118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    119: <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    120: </dl></dd>
1.267     rillig    121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    122: builds)</a></span></dt>
1.75      rillig    123: <dd><dl>
1.267     rillig    124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    129: <dd><dl>
1.294     rillig    130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    131: <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    132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    140: </dl></dd>
                    141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    143: </dl></dd>
                    144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    145: <dd><dl>
                    146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    150: <dd><dl>
                    151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <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>
                    156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    158: <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>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    160: <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       161: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    162: <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>
                    163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    168: <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    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.267     rillig    173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    175: <dd><dl>
1.299     rillig    176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    179: <dd><dl>
1.299     rillig    180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    185: </dl></dd>
1.299     rillig    186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    188: <dd><dl>
                    189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    192: </dl></dd>
                    193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    195: </dl></dd>
1.299     rillig    196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    197: <dd><dl>
1.299     rillig    198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    202: <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    203: <dd><dl>
1.299     rillig    204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    206: </dl></dd>
1.299     rillig    207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    219: </dl></dd>
                    220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    221: <dd><dl>
                    222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    223: <dd><dl>
1.334   ! nia       224: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
        !           225: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
        !           226: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig    227: </dl></dd>
1.299     rillig    228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    229: <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    230: </dl></dd>
1.299     rillig    231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    232: <dd><dl>
1.299     rillig    233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    237: <dd><dl>
1.299     rillig    238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    240: <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>
                    241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    242: </dl></dd>
                    243: </dl></dd>
1.299     rillig    244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    245: <dd><dl>
1.299     rillig    246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    247: <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>
                    248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    250: </dl></dd>
1.299     rillig    251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    252: <dd><dl>
1.299     rillig    253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    256: </dl></dd>
                    257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    258: <dd><dl>
                    259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    260: <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    261: <dd><dl>
1.299     rillig    262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       264:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    265:       and
                    266:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    267:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    268: </dl></dd>
1.299     rillig    269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    270: <dd><dl>
                    271: <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>
                    272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    273: </dl></dd>
                    274: </dl></dd>
                    275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig    276: <dd><dl>
1.299     rillig    277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    279: <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>
                    280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig    286: </dl></dd>
1.299     rillig    287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    290: <dd><dl>
                    291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig    293: </dl></dd>
1.299     rillig    294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig    295: <dd><dl>
1.299     rillig    296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                    298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                    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>
                    336: </dl></dd>
                    337: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    338: <dd><dl>
                    339: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    340: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz       341: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
                    342: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
                    343: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
                    344: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267     rillig    345: </dl></dd>
                    346: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    347: <dd><dl>
                    348: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    349: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    350: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    351: <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>
                    352: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    353: </dl></dd>
                    354: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    357: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    358: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    359: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    360: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia       361: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     rillig    362: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318     nia       364: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                    365: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                    366: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                    367: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                    368: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                    369: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                    370: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87      wiz       371:     emulation</a></span></dt>
1.318     nia       372: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                    373: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77      rillig    374: </dl></dd>
1.267     rillig    375: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    376: </dl></dd>
1.299     rillig    377: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    378: <dd><dl>
                    379: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    380: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    381: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    382: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    383: </dl></dd>
1.267     rillig    384: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    385: <dd><dl>
1.267     rillig    386: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    387: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    388: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    389: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    391: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    392: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    393: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    394: </dl></dd>
                    395: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig    396: </dl></dd>
                    397: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    398: <dd><dl>
1.299     rillig    399: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    400: <dd><dl>
1.299     rillig    401: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                    402: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                    403: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig    404: <dd><dl>
1.299     rillig    405: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                    406: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig    407: </dl></dd>
1.299     rillig    408: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    410: <dd><dl>
1.299     rillig    411: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                    412: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    413: </dl></dd>
1.299     rillig    414: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig    415: <dd><dl>
1.299     rillig    416: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    417: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    418: </dl></dd>
                    419: </dl></dd>
1.299     rillig    420: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig    421: <dd><dl>
1.299     rillig    422: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                    423: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig    424: <dd><dl>
1.299     rillig    425: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                    426: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig    427: </dl></dd>
                    428: </dl></dd>
1.299     rillig    429: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                    430: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    431: </dl></dd>
                    432: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    433: <dd><dl>
                    434: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    435: <dd><dl>
                    436: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    437: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    438: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    439: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    440: </dl></dd>
                    441: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    442: </dl></dd>
1.322     leot      443: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75      rillig    444: <dd><dl>
1.322     leot      445: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                    448: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                    449: </dl></dd>
                    450: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                    451: <dd><dl>
                    452: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                    453: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                    454: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                    455: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                    456: </dl></dd>
                    457: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                    458: <dd><dl>
                    459: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                    460: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                    461: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                    462: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                    463: </dl></dd>
                    464: </dl></dd>
                    465: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
                    466: <dd><dl>
                    467: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                    468: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75      rillig    469: </dl></dd>
1.322     leot      470: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76      rillig    471: <dd><dl>
1.322     leot      472: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    473: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    474: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    475: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    476: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261     leot      477: <code class="filename">stable</code>,
1.128     wiz       478: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    479: source packages</a></span></dt>
                    480: </dl></dd>
1.322     leot      481: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
                    482: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    483: <dd><dl>
1.322     leot      484: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                    485: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig    486: </dl></dd>
                    487: </dl>
                    488: </div>
1.82      rillig    489: <div class="list-of-tables">
                    490: <p><b>List of Tables</b></p>
                    491: <dl>
                    492: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    493: </dt>
1.299     rillig    494: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      495: </dt>
1.299     rillig    496: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      497: </dt>
1.82      rillig    498: </dl>
                    499: </div>
1.148     asau      500: <div class="chapter">
                    501: <div class="titlepage"><div><div><h1 class="title">
                    502: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    503: <div class="toc">
                    504: <p><b>Table of Contents</b></p>
1.210     leot      505: <dl class="toc">
1.75      rillig    506: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    507: <dd><dl>
                    508: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    509: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    510: </dl></dd>
1.75      rillig    511: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    512: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       513: <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    514: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    515: </dl>
                    516: </div>
1.148     asau      517: <div class="sect1">
1.75      rillig    518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    519: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    520: <p>There is a lot of software freely available for Unix-based
                    521: systems, which is usually available in form of the source code. Before
                    522: such software can be used, it needs to be configured to the local
                    523: system, compiled and installed, and this is exactly what The NetBSD
                    524: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    525: to handle binary packages, so that not every user has to build the
                    526: packages for himself, which is a time-costly task.</p>
1.75      rillig    527: <p>pkgsrc currently contains several thousand packages,
                    528:       including:</p>
1.148     asau      529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot      530: <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    531:          web server</p></li>
1.322     leot      532: <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    533:          web browser</p></li>
1.322     leot      534: <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    535:          Desktop Environment</p></li>
1.322     leot      536: <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    537:          Desktop Environment</p></li>
                    538: </ul></div>
1.219     rillig    539: <p>&#8230; just to name a few.</p>
1.75      rillig    540: <p>pkgsrc has built-in support for handling varying dependencies,
                    541:       such as pthreads and X11, and extended features such as IPv6 support on
                    542:       a range of platforms.</p>
1.148     asau      543: <div class="sect2">
1.82      rillig    544: <div class="titlepage"><div><div><h3 class="title">
                    545: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    546: <p>
                    547: pkgsrc provides the following key features:
                    548: </p>
1.148     asau      549: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       550: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    551:   and installation of binary packages. The source and latest
                    552:   patches are retrieved from a master or mirror download site, checksum
                    553:   verified, then built on your system. Support for binary-only
                    554:   distributions is available for both native platforms and NetBSD
                    555:   emulated platforms.</p></li>
1.128     wiz       556: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    557:   including binaries, libraries, man pages and other
                    558:   documentation.</p></li>
1.214     sevan     559: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    560:   performing updates, to ensure required packages are installed. The
                    561:   configuration files of various packages are handled automatically during
                    562:   updates, so local changes are preserved.</p></li>
1.128     wiz       563: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    564:   consists of highly portable code. This allows the greatest speed of
1.132     spz       565:   development when porting to a new platform. This portability also
1.82      rillig    566:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    567:   platforms</em></span>.</p></li>
1.128     wiz       568: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    569:   international encryption requirements and build-time options for a
                    570:   large number of packages are all set in a simple, central
                    571:   configuration file.</p></li>
1.128     wiz       572: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    573:   freely available under a BSD license, so you may extend and adapt
                    574:   pkgsrc to your needs. Support for local packages and patches is
                    575:   available right out of the box, so you can configure it specifically
                    576:   for your environment.</p></li>
                    577: </ul></div>
1.91      rillig    578: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       580: <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  581: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    582: them and to complain about them rather than to just install the package
                    583: and hope that it works. There are numerous checks in pkgsrc that try to
1.322     leot      584: 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    585: of shell scripts), and post-installation checks (installed files,
                    586: references to shared libraries, script interpreters).</p></li>
1.128     wiz       587: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  588: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    589: pkgsrc has been ported to many operating systems. Care is taken that
                    590: packages behave the same on all platforms.</p></li>
                    591: </ul></div>
1.82      rillig    592: </div>
1.148     asau      593: <div class="sect2">
1.82      rillig    594: <div class="titlepage"><div><div><h3 class="title">
                    595: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    596: <p>pkgsrc consists of both a source distribution and a binary
                    597: distribution for these operating systems. After retrieving the required
                    598: source or binaries, you can be up and running with pkgsrc in just
                    599: minutes!</p>
1.75      rillig    600: <p>pkgsrc was derived from FreeBSD's ports system, and
                    601:       initially developed for NetBSD only. Since then, pkgsrc has
                    602:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    603: <div class="table">
                    604: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       605: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    606: <colgroup>
                    607: <col>
                    608: <col>
1.202     sevan     609: <col>
1.82      rillig    610: </colgroup>
                    611: <thead><tr>
                    612: <th>Platform</th>
                    613: <th>Date Support Added</th>
1.202     sevan     614: <th>Notes</th>
1.82      rillig    615: </tr></thead>
                    616: <tbody>
                    617: <tr>
1.289     leot      618: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    619: <td align="center">Aug 1997</td>
1.202     sevan     620: <td class="auto-generated"> </td>
1.82      rillig    621: </tr>
                    622: <tr>
1.110     hubertf   623: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    624: <td align="center">Mar 1999</td>
1.264     sevan     625: <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    626: </tr>
                    627: <tr>
1.289     leot      628: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    629: <td align="center">Jun 1999</td>
1.264     sevan     630: <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    631: </tr>
                    632: <tr>
                    633: <td>
1.230     sevan     634:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    635:         </td>
                    636: <td align="center">Oct 2001</td>
1.305     bacon     637: <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    638: </tr>
                    639: <tr>
1.289     leot      640: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    641: <td align="center">Nov 2002</td>
1.264     sevan     642: <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    643: </tr>
                    644: <tr>
1.289     leot      645: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    646: <td align="center">Nov 2002</td>
1.264     sevan     647: <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    648: </tr>
                    649: <tr>
1.289     leot      650: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    651: <td align="center">Dec 2002</td>
1.202     sevan     652: <td>
1.264     sevan     653:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    654:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     655:        </td>
1.82      rillig    656: </tr>
                    657: <tr>
                    658: <td>BSD/OS</td>
                    659: <td align="center">Dec 2003</td>
1.202     sevan     660: <td class="auto-generated"> </td>
1.82      rillig    661: </tr>
                    662: <tr>
1.289     leot      663: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    664: <td align="center">Dec 2003</td>
1.264     sevan     665: <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    666: </tr>
                    667: <tr>
                    668: <td>
1.289     leot      669:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    670:           (Microsoft Windows Services for Unix)
                    671:         </td>
                    672: <td align="center">Mar 2004</td>
1.264     sevan     673: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    674: </tr>
                    675: <tr>
1.289     leot      676: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    677: <td align="center">Oct 2004</td>
1.202     sevan     678: <td class="auto-generated"> </td>
1.82      rillig    679: </tr>
                    680: <tr>
1.110     hubertf   681: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    682: <td align="center">Nov 2004</td>
1.264     sevan     683: <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    684: </tr>
1.98      wiz       685: <tr>
1.289     leot      686: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       687: <td align="center">Apr 2007</td>
1.264     sevan     688: <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       689: </tr>
1.128     wiz       690: <tr>
1.289     leot      691: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       692: <td align="center">Sep 2010</td>
1.264     sevan     693: <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       694: </tr>
1.151     obache    695: <tr>
1.289     leot      696: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  697: <td align="center">Jan 2011</td>
1.202     sevan     698: <td class="auto-generated"> </td>
1.151     obache    699: </tr>
                    700: <tr>
1.289     leot      701: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    702: <td align="center">Nov 2011</td>
1.264     sevan     703: <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    704: </tr>
                    705: <tr>
1.289     leot      706: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    707: <td align="center">Mar 2013</td>
1.264     sevan     708: <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    709: </tr>
1.166     jnemeth   710: <tr>
1.289     leot      711: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   712: <td align="center">Jul 2013</td>
1.264     sevan     713: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   714: </tr>
1.214     sevan     715: <tr>
1.289     leot      716: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     717: <td align="center">Jun 2014</td>
1.264     sevan     718: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.214     sevan     719: </tr>
1.82      rillig    720: </tbody>
1.91      rillig    721: </table></div>
1.82      rillig    722: </div>
1.91      rillig    723: <br class="table-break">
1.82      rillig    724: </div>
1.75      rillig    725: </div>
1.148     asau      726: <div class="sect1">
1.75      rillig    727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    728: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    729: <p>This document is divided into three parts. The first,
1.110     hubertf   730:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    731:        describes how one can use one of the packages in the Package
                    732:        Collection, either by installing a precompiled binary package,
1.93      rillig    733:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   734:        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    735:        package so it can be easily built by other NetBSD users without
                    736:        knowing about the package's building details. The third part,
1.110     hubertf   737:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    738:        is intended for those who want to understand how pkgsrc is
                    739:        implemented.</p>
                    740: <p>This document is available in various formats:
1.110     hubertf   741:        <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    742: </div>
1.148     asau      743: <div class="sect1">
1.75      rillig    744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    745: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       746: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    747:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    748:       terminology used within this document.</p>
1.148     asau      749: <div class="variablelist"><dl class="variablelist">
1.75      rillig    750: <dt><span class="term">Package</span></dt>
                    751: <dd><p>A set of files and building instructions
                    752:            that describe what's necessary
                    753:            to build a certain piece of software using
                    754:             pkgsrc. Packages are traditionally stored under
1.236     wiz       755:            <code class="filename">/usr/pkgsrc</code>,
                    756:            but may be stored in any location,
                    757:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    758: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       759: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       760:          is part of the NetBSD operating system and can be bootstrapped
                    761:          to run on non-NetBSD operating systems as well.  It handles
                    762:          building (compiling), installing, and removing of
                    763:          packages.</p></dd>
1.75      rillig    764: <dt><span class="term">Distfile</span></dt>
                    765: <dd><p>This term describes the file or files that are
                    766:            provided by the author of the piece of software to
                    767:            distribute his work. All the changes necessary to build on
                    768:            NetBSD are reflected in the corresponding package. Usually
                    769:            the distfile is in the form of a compressed tar-archive,
                    770:            but other types are possible, too. Distfiles are usually
                    771:            stored below
1.76      rillig    772:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    773: <dt><span class="term">Port</span></dt>
                    774: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    775:            for what we call a package.
1.128     wiz       776:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    777:            architecture.</p></dd>
                    778: <dt><span class="term">Precompiled/binary package</span></dt>
                    779: <dd>
                    780: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    781:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    782:            file so it can be installed on machines of the same
                    783:            machine architecture without the need to
                    784:            recompile. Packages are usually generated in
1.76      rillig    785:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       786:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       787: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    788:            especially in the context of precompiled packages.</p>
                    789: </dd>
                    790: <dt><span class="term">Program</span></dt>
1.88      wiz       791: <dd><p>The piece of software to be installed which will be
                    792:          constructed from all the files in the distfile by the
                    793:          actions defined in the corresponding package.</p></dd>
1.75      rillig    794: </dl></div>
1.148     asau      795: <div class="sect2">
1.75      rillig    796: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       797: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      798: <div class="variablelist"><dl class="variablelist">
1.75      rillig    799: <dt><span class="term">pkgsrc users</span></dt>
                    800: <dd>
                    801: <p>The
                    802:        pkgsrc users are people who use the packages provided by pkgsrc.
                    803:        Typically they are system administrators. The people using the
1.128     wiz       804:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    805:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    806: <p>There are two kinds of pkgsrc users: Some only want to
                    807:        install pre-built binary packages. Others build the pkgsrc
                    808:        packages from source, either for installing them directly or for
1.110     hubertf   809:        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    810:        documentation.</p>
                    811: </dd>
                    812: <dt><span class="term">package maintainers</span></dt>
                    813: <dd><p>A
1.110     hubertf   814:        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    815: <dt><span class="term">infrastructure developers</span></dt>
                    816: <dd><p>These people are involved in all those files
1.76      rillig    817:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   818:        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    819:        too.</p></dd>
                    820: </dl></div>
                    821: </div>
                    822: </div>
1.148     asau      823: <div class="sect1">
1.75      rillig    824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    825: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    826: <p>When giving examples for commands, shell prompts are used to
                    827:       show if the command should/can be issued as root, or if
1.128     wiz       828:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     829:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    830:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    831:       bourne shell and derivatives.</p>
1.75      rillig    832: </div>
                    833: </div>
1.148     asau      834: <div class="part">
1.75      rillig    835: <div class="titlepage"><div><div><h1 class="title">
                    836: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    837: <div class="toc">
                    838: <p><b>Table of Contents</b></p>
1.210     leot      839: <dl class="toc">
1.267     rillig    840: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    841: <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    842: <dd><dl>
1.267     rillig    843: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    844: <dd><dl>
1.267     rillig    845: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    846: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    847: </dl></dd>
1.267     rillig    848: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    849: <dd><dl>
1.267     rillig    850: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    851: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    852: </dl></dd>
                    853: </dl></dd>
1.267     rillig    854: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    855: <dd><dl>
1.267     rillig    856: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    857: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    858: </dl></dd>
1.267     rillig    859: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    860: <dd><dl>
1.267     rillig    861: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    862: <dd><dl>
1.267     rillig    863: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    864: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia       865: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    866: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    867: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    868: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    869: <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>
                    870: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig    871: </dl></dd>
1.267     rillig    872: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    873: <dd><dl>
1.267     rillig    874: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    875: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    876: <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    877: </dl></dd>
                    878: </dl></dd>
1.267     rillig    879: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    880: <dd><dl>
1.267     rillig    881: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    882: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    883: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    884: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       885: <dd><dl>
1.267     rillig    886: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    887: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    888: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       889: </dl></dd>
1.267     rillig    890: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    891: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    892: </dl></dd>
1.267     rillig    893: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    894: <dd><dl>
1.267     rillig    895: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    896: <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    897: </dl></dd>
1.267     rillig    898: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    899: builds)</a></span></dt>
1.75      rillig    900: <dd><dl>
1.267     rillig    901: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    902: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    903: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    904: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    905: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    906: <dd><dl>
1.294     rillig    907: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    908: <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    909: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    910: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    911: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    912: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    913: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    914: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    915: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    916: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    917: </dl></dd>
                    918: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    919: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    920: </dl></dd>
                    921: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    922: <dd><dl>
                    923: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    924: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    925: </dl></dd>
                    926: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    927: <dd><dl>
                    928: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    929: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    930: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    931: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    932: <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>
                    933: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    934: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    935: <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>
                    936: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    937: <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       938: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    939: <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>
                    940: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    941: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    942: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    943: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    944: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    945: <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    946: </dl></dd>
                    947: </dl>
                    948: </div>
1.148     asau      949: <div class="chapter">
1.75      rillig    950: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    951: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    952: <p>
                    953:        To get help when using pkgsrc, the definitive source is this
                    954:        document, the pkgsrc guide. If you don't find anything here,
                    955:        there are alternatives:
                    956: </p>
                    957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    958: <li class="listitem">
                    959: <p>
                    960:        The built-in pkgsrc help, which is available after bootstrapping
                    961:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    962:        help for any topic, such as a variable name like
                    963:        <code class="varname">BUILD_DEFS</code>, a make target like
                    964:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    965:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322     leot      966: <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    967: </li>
                    968: <li class="listitem"><p>
1.278     rillig    969:        To see the value of a single variable, run <span class="command"><strong>bmake
                    970:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    971: </p></li>
                    972: <li class="listitem"><p>
                    973:        To see the values of the most common variables, run
                    974:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    975:        topic. To see the variables for a single topic, run
                    976:        <span class="command"><strong>bmake
                    977:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    978:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    979: </p></li>
                    980: <li class="listitem"><p>
1.267     rillig    981:        The pkgsrc-users mailing list, to which
                    982:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    983:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    984:        questions</a>.</p></li>
                    985: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    986:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    987:        or by using a specialized chat program such as
                    988:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    989:        Pick any user name and join the channel #pkgsrc.</p></li>
                    990: </ul></div>
                    991: </div>
                    992: <div class="chapter">
                    993: <div class="titlepage"><div><div><h2 class="title">
                    994: <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    995: <div class="toc">
                    996: <p><b>Table of Contents</b></p>
1.210     leot      997: <dl class="toc">
1.267     rillig    998: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    999: <dd><dl>
1.267     rillig   1000: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                   1001: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig   1002: </dl></dd>
1.267     rillig   1003: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig   1004: <dd><dl>
1.267     rillig   1005: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                   1006: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig   1007: </dl></dd>
                   1008: </dl>
                   1009: </div>
1.91      rillig   1010: <p>Before you download and extract the files, you need to decide
                   1011: where you want to extract them. When using pkgsrc as root user, pkgsrc
                   1012: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                   1013: free to install the sources and binary packages wherever you want in
                   1014: your filesystem, provided that the pathname does not contain white-space
                   1015: or other characters that are interpreted specially by the shell and some
                   1016: other programs. A safe bet is to use only letters, digits, underscores
                   1017: and dashes.</p>
1.148     asau     1018: <div class="sect1">
1.75      rillig   1019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1020: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1021: <p>Before you download any pkgsrc files, you should decide
                   1022:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1023:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1024:        quarterly basis from the current branch and only gets modified
                   1025:        for security updates. The names of the stable branches are built
                   1026:        from the year and the quarter, for example
1.329     leot     1027:        <code class="literal">2021Q4</code>.</p>
1.75      rillig   1028: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1029:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1030:        Both ways are described here.</p>
1.157     asau     1031: <p>Note that tar archive contains CVS working copy.
                   1032:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1033: <div class="sect2">
1.75      rillig   1034: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1035: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1036: <p>The primary download location for all pkgsrc files is
1.264     sevan    1037:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1038:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1039:        (it points to the same location).
                   1040:        There are a number of subdirectories for different purposes,
1.322     leot     1041:        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     1042: <p>The tar archive for the current branch is in the directory
1.264     sevan    1043:        <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    1044:        It is autogenerated weekly.</p>
1.157     asau     1045: <p>To save download time we provide bzip2- and
                   1046:        xz-compressed archives which are published at
1.264     sevan    1047:        <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     1048:        and
1.264     sevan    1049:        <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     1050:        respectively.
                   1051:        </p>
                   1052: <p>You can fetch the same files using FTP.</p>
1.329     leot     1053: <p>The tar file for the stable branch 2021Q4 is in the
                   1054:        directory <code class="filename">pkgsrc-2021Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1055: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1056: <pre class="screen">
1.329     leot     1057: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1058: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1059:        or your web browser.</p>
1.112     weinem   1060: <p>Then, extract it with:</p>
1.188     snj      1061: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1062: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1063:        in <code class="filename">/usr/</code> and all the package source will be 
                   1064:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1065: <p>To download pkgsrc-current, run:</p>
                   1066: <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   1067: </div>
1.148     asau     1068: <div class="sect2">
1.75      rillig   1069: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1070: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1071: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.329     leot     1072: <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-2021Q4 -P pkgsrc</code></strong>
1.128     wiz      1073: </pre>
                   1074: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1075:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1076:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1077: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1078: <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    1079: </pre>
1.289     leot     1080: <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      1081: <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      1082: <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      1083: </pre>
                   1084: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1085:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1086:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1087: <pre class="programlisting">
                   1088: # set CVS remote shell command
                   1089: CVS_RSH=ssh
                   1090: export CVS_RSH
                   1091: </pre>
                   1092: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1093:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1094:        in your home directory and saving the following lines to it.
                   1095:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1096:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1097: <pre class="programlisting">
                   1098: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1099: cvs -q
1.101     rillig   1100: checkout -P
1.103     wiz      1101: update -dP
                   1102: diff -upN
1.101     rillig   1103: rdiff -u
1.128     wiz      1104: release -d
1.101     rillig   1105: </pre>
1.75      rillig   1106: </div>
                   1107: </div>
1.148     asau     1108: <div class="sect1">
1.75      rillig   1109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1110: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1111: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1112:        (which also works if you have first installed it via a tar
                   1113:        file). It saves bandwidth and hard disk activity, compared to
                   1114:        downloading the tar file again.</p>
1.148     asau     1115: <div class="sect2">
1.75      rillig   1116: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1117: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1118: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1119: <h3 class="title">Warning</h3>
1.77      rillig   1120: <p>When updating from a tar file, you first need to
                   1121:        completely remove the old pkgsrc directory. Otherwise those
                   1122:        files that have been removed from pkgsrc in the mean time will
                   1123:        not be removed on your local disk, resulting in inconsistencies.
                   1124:        When removing the old files, any changes that you have done to
                   1125:        the pkgsrc files will be lost after updating. Therefore updating
                   1126:        via CVS is strongly recommended.</p>
1.75      rillig   1127: </div>
1.82      rillig   1128: <p>Note that by default the distfiles and the binary packages
                   1129:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1130:        before updating. You can also configure pkgsrc to store distfiles
                   1131:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1132:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1133:        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   1134: <p>To update pkgsrc from a tar file, download the tar file as
                   1135:        explained above. Then, make sure that you have not made any
                   1136:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1137:        directory and extract the new tar file. Done.</p>
                   1138: </div>
1.148     asau     1139: <div class="sect2">
1.75      rillig   1140: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1141: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1142: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1143: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1144: </pre>
                   1145: <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>
                   1146: <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>
                   1147: </pre>
1.148     asau     1148: <div class="sect3">
1.75      rillig   1149: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1150: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1151: <p>When updating pkgsrc, the CVS program keeps track of the
                   1152:        branch you selected. But if you, for whatever reason, want to
                   1153:        switch from the stable branch to the current one, you can do it
1.128     wiz      1154:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1155:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1156:        back to the stable branch, add the
1.329     leot     1157:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2021Q4</span>&#8221;</span> option.</p>
1.75      rillig   1158: </div>
1.148     asau     1159: <div class="sect3">
1.75      rillig   1160: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1161: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1162: <p>When you update pkgsrc, the CVS program will only touch
                   1163:        those files that are registered in the CVS repository. That
                   1164:        means that any packages that you created on your own will stay
                   1165:        unmodified. If you change files that are managed by CVS, later
                   1166:        updates will try to merge your changes with those that have been
                   1167:        done by others. See the CVS manual, chapter
1.128     wiz      1168:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1169: </div>
                   1170: </div>
                   1171: </div>
                   1172: </div>
1.148     asau     1173: <div class="chapter">
1.75      rillig   1174: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1175: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1176: <div class="toc">
                   1177: <p><b>Table of Contents</b></p>
1.210     leot     1178: <dl class="toc">
1.267     rillig   1179: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1180: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1181: </dl>
                   1182: </div>
1.148     asau     1183: <div class="sect1">
1.75      rillig   1184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1185: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1186: <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   1187: </div>
1.148     asau     1188: <div class="sect1">
1.82      rillig   1189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1190: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1191: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1192:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1193:     to privileged one all programs are installed under one particular user
1.149     asau     1194:     and cannot utilise privileged operations (packages don't create
                   1195:     special users and all special file permissions like setuid are ignored).
                   1196:     </p>
1.82      rillig   1197: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1198: <pre class="screen">
1.167     asau     1199: <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   1200: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1201: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1202:     </pre>
1.149     asau     1203: <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>
                   1204: <p>By default, in privileged mode pkgsrc uses
                   1205:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1206:     where programs will be installed in,
1.230     sevan    1207:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1208:     directory where pkgsrc will do its internal bookkeeping,
                   1209:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1210:     where packages install their persistent data.
                   1211:     In unprivileged mode pkgsrc uses
                   1212:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1213:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1214:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1215:     </p>
                   1216: <p>You can change default layout using command-line arguments.
                   1217:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1218:     </p>
1.148     asau     1219: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1220: <h3 class="title">Note</h3>
1.110     hubertf  1221: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1222:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1223:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1224:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1225: </div>
1.149     asau     1226: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1227: <h3 class="title">Note</h3>
                   1228: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1229:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1230:       corresponding to the installation you're working with to build
                   1231:       and install packages.
                   1232:       </p>
                   1233: </div>
1.75      rillig   1234: </div>
                   1235: </div>
1.148     asau     1236: <div class="chapter">
1.75      rillig   1237: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1238: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1239: <div class="toc">
                   1240: <p><b>Table of Contents</b></p>
1.210     leot     1241: <dl class="toc">
1.267     rillig   1242: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1243: <dd><dl>
1.267     rillig   1244: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1245: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia      1246: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1247: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1248: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1249: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1250: <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>
                   1251: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267     rillig   1252: </dl></dd>
                   1253: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1254: <dd><dl>
                   1255: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1256: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1257: <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   1258: </dl></dd>
                   1259: </dl>
                   1260: </div>
                   1261: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1262: is to only install the package tools and to use binary packages
1.128     wiz      1263: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1264: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1265: of pkgsrc, too. Then you are able to build your own packages,
                   1266: and you can still use binary packages from someone else.</p>
1.148     asau     1267: <div class="sect1">
1.75      rillig   1268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1269: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317     nia      1270: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1271:   site and mirrors, there are collections of binary packages,
1.109     rillig   1272:   ready to be installed. These binary packages have been built using the
                   1273:   default settings for the directories, that is:</p>
1.148     asau     1274: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1275: <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>
                   1276: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1277: <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   1278: </ul></div>
                   1279: <p>If you cannot use these directories for whatever reasons (maybe
                   1280:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1281:   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     1282: <div class="sect2">
1.75      rillig   1283: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1284: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1285: <p>To install binary packages, you first need to know from where
                   1286:     to get them. The first place where you should look is on the main
1.317     nia      1287:     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   1288: <p>This directory contains binary packages for multiple
                   1289:     platforms. First, select your operating system. (Ignore the
                   1290:     directories with version numbers attached to it, they just exist for
                   1291:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1292:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1293: <p>In this directory, you often find a file called
                   1294:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1295:     management tools. If the file is missing, it is likely that your
                   1296:     operating system already provides those tools. Download the file and
                   1297:     extract it in the <code class="filename">/</code> directory. It will create
                   1298:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1299:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1300: </div>
1.148     asau     1301: <div class="sect2">
1.75      rillig   1302: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1303: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1304: <p>In the directory from the last section, there is a
1.196     wiz      1305:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1306:     binary packages that are available for the platform, excluding those
1.317     nia      1307:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1308: <p>To install packages directly from an FTP or HTTP server, run
                   1309:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1310:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1311: <pre class="screen">
1.317     nia      1312: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1313: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1314: <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   1315: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317     nia      1316: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1317: </pre>
                   1318: <p>Instead of URLs, you can also use local paths, for example if
                   1319:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1320:     repository. If you want to install packages from multiple sources,
                   1321:     you can separate them by a semicolon in
                   1322:     <code class="varname">PKG_PATH</code>.</p>
                   1323: <p>After these preparations, installing a package is very
                   1324:     easy:</p>
                   1325: <pre class="screen">
1.317     nia      1326: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1327: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1328: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1329: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1330: </pre>
                   1331: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1332:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1333: <p>Any prerequisite packages needed to run the
1.88      wiz      1334:     package in question will be installed, too, assuming they are
1.317     nia      1335:     present in the repository.</p>
1.75      rillig   1336: <p>After you've installed packages, be sure to have
1.88      wiz      1337:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1338:     <code class="varname">PATH</code> so you can actually start the just
                   1339:     installed program.</p>
1.75      rillig   1340: </div>
1.148     asau     1341: <div class="sect2">
1.75      rillig   1342: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1343: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
                   1344: <p>To update binary packages, it is recommended that you use
                   1345:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1346:     package repository to your locally installed packages and safely
                   1347:     replace any older packages.</p>
                   1348: <p>Note that pkgsrc is released as quarterly branches.
                   1349:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1350:     need to adjust the repository in
                   1351:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1352: </div>
                   1353: <div class="sect2">
                   1354: <div class="titlepage"><div><div><h3 class="title">
                   1355: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1356: <p>To deinstall a package, it does not matter whether it was
1.317     nia      1357:     installed from source code or from a binary package. Neither the
                   1358:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1359:     command need to know.</p>
                   1360: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1361:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317     nia      1362:     name can be given with or without version number.</p>
1.82      rillig   1363: </div>
1.148     asau     1364: <div class="sect2">
1.82      rillig   1365: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1366: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1367: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317     nia      1368:     installed packages or binary package files.
                   1369:     As with other management tools, it works with packages installed
                   1370:     from source or binaries.</p>
1.82      rillig   1371: </div>
1.148     asau     1372: <div class="sect2">
1.82      rillig   1373: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1374: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1375: <p>
1.279     leot     1376:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317     nia      1377:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1378:       included in pkgsrc.  The list is available from the NetBSD
1.317     nia      1379:       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>.
                   1380:     </p>
                   1381: <p>
                   1382:       Please note that not every "vulnerability" with a CVE assignment is
                   1383:       exploitable in every configuration.
                   1384:       Some bugs are marked as active simply because an fix was not
                   1385:       marked as such.
                   1386:       Operating system specific hardening and mitigation features may also
                   1387:       reduce the impact of bugs.
1.88      wiz      1388:     </p>
1.82      rillig   1389: <p>
1.125     wiz      1390:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1391:       this list can be downloaded
                   1392:       automatically, and a security audit of all packages installed on a system
                   1393:       can take place.
                   1394:     </p>
1.82      rillig   1395: <p>
1.125     wiz      1396:       There are two components to auditing.  The first
                   1397:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1398:       is for downloading
1.88      wiz      1399:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1400:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1401:       installed packages are vulnerable.  If a package is vulnerable, you
                   1402:       will see output similar to the following:
                   1403:     </p>
1.82      rillig   1404: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1405:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1406: <p>
1.125     wiz      1407:       You may wish to have the
1.317     nia      1408:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1409:       file downloaded daily so that
                   1410:       it remains current.  This may be done by adding an appropriate entry
1.322     leot     1411:       to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1412:       </p>
                   1413: <pre class="screen">
1.233     sevan    1414: # Download vulnerabilities file
1.230     sevan    1415: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1416: # Audit the installed packages and email results to root
                   1417: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1418:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1419:       </pre>
                   1420: <p>
1.230     sevan    1421:       will update the vulnerability list every day at 3AM, followed by an audit
                   1422:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1423: 
1.230     sevan    1424:       On NetBSD this may be accomplished instead by adding the following
                   1425:       line to <code class="filename">/etc/daily.conf</code>:
                   1426:       </p>
                   1427: <pre class="screen">
                   1428: fetch_pkg_vulnerabilities=YES
                   1429:       </pre>
                   1430: <p>
                   1431:       to fetch the vulnerability list from the daily security script. The system
                   1432:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1433:       desired (not required), by adding the following line to
1.230     sevan    1434: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1435:       </p>
                   1436: <pre class="screen">
1.230     sevan    1437: check_pkg_vulnerabilities=YES
1.125     wiz      1438:       </pre>
                   1439: <p>
1.322     leot     1440:       see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1441:     </p>
1.82      rillig   1442: </div>
1.148     asau     1443: <div class="sect2">
1.82      rillig   1444: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1445: <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   1446: <p>
1.322     leot     1447:       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      1448:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.317     nia      1449:       argument to check if any packages are stale, e.g.
1.88      wiz      1450:     </p>
                   1451: <pre class="screen">
                   1452: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1453: ...
1.88      wiz      1454: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1455:     </pre>
1.82      rillig   1456: </div>
1.148     asau     1457: <div class="sect2">
1.82      rillig   1458: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1459: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1460: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1461:     administrative functions on the package system.</p>
1.82      rillig   1462: </div>
1.75      rillig   1463: </div>
1.148     asau     1464: <div class="sect1">
1.75      rillig   1465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1466: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1467: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1468:   directory now contains a set of packages, organized into
                   1469:   categories. You can browse the online index of packages, or run
1.110     hubertf  1470:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1471:   directory to build local <code class="filename">README.html</code> files for
1.322     leot     1472:   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      1473: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1474:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1475:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1476:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1477:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1478:   system (inside a chroot is an exception). </p>
                   1479: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1480:   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      1481:   instructions how to create your own packages.</p>
1.148     asau     1482: <div class="sect2">
1.75      rillig   1483: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1484: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1485: <p>To build packages from source, you need a working C
1.88      wiz      1486:     compiler. On NetBSD, you need to install the
1.128     wiz      1487:     <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      1488:     sets. If you want to build X11-related packages, the
1.128     wiz      1489:     <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      1490:     sets are required, too.</p>
1.75      rillig   1491: </div>
1.148     asau     1492: <div class="sect2">
1.75      rillig   1493: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1494: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1495: <p>The first step for building a package is downloading the
1.88      wiz      1496:     distfiles (i.e. the unmodified source). If they have not yet been
                   1497:     downloaded, pkgsrc will fetch them automatically.</p>
                   1498: <p>If you have all files that you need in the
                   1499:     <code class="filename">distfiles</code> directory,
                   1500:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1501:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1502:     </p>
1.82      rillig   1503: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1504: <p>
1.110     hubertf  1505:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1506: <p>By default a list of distribution sites will be randomly
                   1507:     intermixed to prevent huge load on servers which holding popular
                   1508:     packages (for example, SourceForge.net mirrors). Thus, every
                   1509:     time when you need to fetch yet another distfile all the mirrors
                   1510:     will be tried in new (random) order. You can turn this feature
                   1511:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1512:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1513: <p>You can overwrite some of the major distribution sites to
                   1514:     fit to sites that are close to your own.  By setting one or two
                   1515:     variables you can modify the order in which the master sites are
                   1516:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1517:     delimited list of domain suffixes.
                   1518:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1519:     contains a whitespace delimited list of regular expressions.  It
                   1520:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1521:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1522:     some examples.  This may save some of your bandwidth and
                   1523:     time.</p>
1.75      rillig   1524: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1525:     if you want to keep the settings, by editing the
1.110     hubertf  1526:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1527:     and adding the definitions there.</p>
1.82      rillig   1528: <p>
1.88      wiz      1529:       If a package depends on many other packages (such as
1.322     leot     1530:       <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      1531:       alternate between periods of
                   1532:       downloading source, and compiling. To ensure you have all the source
                   1533:       downloaded initially you can run the command:
                   1534:       </p>
1.82      rillig   1535: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1536: <p>
1.88      wiz      1537:       which will output and run a set of shell commands to fetch the
                   1538:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1539:       also choose to download the files manually.
                   1540:     </p>
1.75      rillig   1541: </div>
1.148     asau     1542: <div class="sect2">
1.75      rillig   1543: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1544: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1545: <p>
1.88      wiz      1546:       Once the software has downloaded, any patches will be applied, then it
                   1547:       will be compiled for you. This may take some time depending on your
                   1548:       computer, and how many other packages the software depends on and their
                   1549:       compile time.
                   1550:     </p>
1.148     asau     1551: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1552: <h3 class="title">Note</h3>
                   1553: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1554:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1555:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1556: </div>
1.87      wiz      1557: <p>For example, type</p>
1.88      wiz      1558: <pre class="screen">
                   1559: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1560: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1561:     </pre>
1.75      rillig   1562: <p>at the shell prompt to build the various components of the
1.88      wiz      1563:     package.</p>
1.82      rillig   1564: <p>The next stage is to actually install the newly compiled
1.88      wiz      1565:     program onto your system. Do this by entering:
1.82      rillig   1566: 
1.88      wiz      1567:     </p>
1.82      rillig   1568: <pre class="screen">
1.88      wiz      1569: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1570:     </pre>
1.82      rillig   1571: <p>
                   1572: 
1.88      wiz      1573:     while you are still in the directory for whatever package you
                   1574:     are installing.</p>
1.82      rillig   1575: <p>Installing the package on your system may require you to
1.88      wiz      1576:     be root.  However, pkgsrc has a
                   1577:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1578:     to only become root for the actual installation step.</p>
1.82      rillig   1579: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1580:     You can now enter:
1.82      rillig   1581: 
1.88      wiz      1582:     </p>
1.82      rillig   1583: <pre class="screen">
1.88      wiz      1584: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1585:     </pre>
1.82      rillig   1586: <p>
                   1587: 
1.88      wiz      1588:     to remove the compiled files in the work directory, as you shouldn't need
                   1589:     them any more. If other packages were also added to your system
                   1590:     (dependencies) to allow your program to compile, you can tidy these up
                   1591:     also with the command:</p>
1.82      rillig   1592: <pre class="screen">
1.88      wiz      1593: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1594:     </pre>
1.75      rillig   1595: <p>Taking the figlet utility as an example, we can install it on our
1.322     leot     1596:     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      1597: <p>The program is installed under the default root of the
                   1598:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1599:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1600:     variable in your environment, and it will use that value as the
                   1601:     root of your packages tree. So, to use
                   1602:     <code class="filename">/usr/local</code>, set
                   1603:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1604:     Please note that you should use a directory which is dedicated to
                   1605:     packages and not shared with other programs (i.e., do not try and
                   1606:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1607:     to add any of your own files or directories (such as
                   1608:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1609:     <code class="filename">pkgsrc/</code>) below the
                   1610:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1611:     conflicts between programs and other files installed by the
                   1612:     package system and whatever else may have been installed
                   1613:     there.</p>
1.110     hubertf  1614: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1615:     alter some configuration options at build time.  Have a look at
                   1616:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1617:     of what will be set there by default.  Environment variables such
                   1618:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1619:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1620:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1621: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1622:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1623:     or being installed. This may be for debugging purposes, or out of
                   1624:     simple curiosity. A number of utility values have been added to
                   1625:     help with this.</p>
1.128     wiz      1626: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1627: <li class="listitem">
1.322     leot     1628: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1629:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1630:        information will be displayed. For example,</p>
1.75      rillig   1631: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1632: <p>will show all the commands that are invoked, up to and
1.128     wiz      1633:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1634: </li>
1.128     wiz      1635: <li class="listitem">
1.322     leot     1636: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1637:        definition, then the <code class="varname">VARNAME</code> definition
                   1638:        should be used, in conjunction with the show-var
1.322     leot     1639:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1640:        variable <code class="varname">LOCALBASE</code>:</p>
                   1641: <pre class="screen">
                   1642: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1643: /usr/pkg
                   1644: <code class="prompt">%</code>
1.88      wiz      1645:        </pre>
1.75      rillig   1646: </li>
                   1647: </ol></div>
                   1648: <p>If you want to install a binary package that you've either
1.88      wiz      1649:     created yourself (see next section), that you put into
                   1650:     pkgsrc/packages manually or that is located on a remote FTP
                   1651:     server, you can use the "bin-install" target. This target will
1.322     leot     1652:     install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1653:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1654:     sites searched is kept in the variable
                   1655:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.322     leot     1656:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1657:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1658:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1659:     details.</p>
                   1660: <p>A final word of warning: If you set up a system that has a
                   1661:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1662:     set that before any packages are installed, as you cannot use
                   1663:     several directories for the same purpose. Doing so will result in
                   1664:     pkgsrc not being able to properly detect your installed packages,
                   1665:     and fail miserably. Note also that precompiled binary packages are
                   1666:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1667:     <code class="filename">/usr/pkg</code>, and that you should
                   1668:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1669:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1670: </div>
                   1671: </div>
                   1672: </div>
1.148     asau     1673: <div class="chapter">
1.75      rillig   1674: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1675: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1676: <div class="toc">
                   1677: <p><b>Table of Contents</b></p>
1.210     leot     1678: <dl class="toc">
1.267     rillig   1679: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1680: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1681: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1682: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1683: <dd><dl>
                   1684: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1685: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1686: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1687: </dl></dd>
1.267     rillig   1688: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1689: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1690: </dl>
                   1691: </div>
1.104     rillig   1692: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1693: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1694: that file depends on the installation. On NetBSD, when you use
1.322     leot     1695: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   1696: <code class="filename">/etc/</code>. In all other cases the default location is
                   1697: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1698: bootstrap program to install the binary packages.</p>
                   1699: <p>The format of the configuration file is that of the usual
                   1700: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1701: is done by setting variables in this file. Note that you can define all
                   1702: kinds of variables, and no special error checking (for example for
1.223     rillig   1703: spelling mistakes) takes place.</p>
1.148     asau     1704: <div class="sect1">
1.75      rillig   1705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1706: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1707: <p>The following variables apply to all
1.89      rillig   1708:     pkgsrc packages. A complete list of the variables that can be
                   1709:     configured by the user is available in
                   1710:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1711:     comments that describe each variable's intent.</p>
1.148     asau     1712: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1713: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1714:            packages will be installed. The default is
1.76      rillig   1715:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1716:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1717: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1718:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1719:            installed. The default is
1.76      rillig   1720:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1721: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1722:            X11 is installed on the system. The default is
1.194     bsiegert 1723:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1724: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1725:            downloaded copies of the original source distributions used
                   1726:            for building pkgsrc packages. The default is
1.76      rillig   1727:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1728: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1729:            database about installed packages is stored.  The default is
1.230     sevan    1730:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1731: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1732:            If set, override the packages'
                   1733:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1734: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1735:            Backup location(s) for distribution files and patch files
                   1736:            if not found locally or in
1.76      rillig   1737:            <code class="filename">${MASTER_SITES}</code> or
                   1738:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1739:            The defaults is
                   1740:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1741: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1742:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1743:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1744:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1745:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1746: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1747:            List of acceptable licenses. License names are case-sensitive.
                   1748:            Whenever you try to build a package whose license is not in this
                   1749:            list, you will get an error message. If the license condition is
                   1750:            simple enough, the error message will include specific
                   1751:            instructions on how to change this variable.</p></li>
1.75      rillig   1752: </ul></div>
                   1753: </div>
1.148     asau     1754: <div class="sect1">
1.75      rillig   1755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1756: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1757: <p>
1.75      rillig   1758:       </p>
1.148     asau     1759: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1760: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1761:            directory for the binary packages. The default is
1.76      rillig   1762:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1763: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1764:            The top level directory where, if defined, the separate
                   1765:            working directories will get created, and symbolically
1.76      rillig   1766:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1767:            This is useful for building packages on several
1.76      rillig   1768:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1769:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1770:            is local to every architecture. (It should be noted that
                   1771:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1772:            &mdash; it is an internal definition which refers to the
1.75      rillig   1773:            root of the pkgsrc tree. It is possible to have many
                   1774:            pkgsrc tree instances.)</p></li>
1.128     wiz      1775: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1776:            Directory for local patches that aren't part of pkgsrc.
1.299     rillig   1777:            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   1778:            information.</p></li>
1.128     wiz      1779: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1780:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1781:            BSD-style Makefile. If this is not set,
                   1782:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1783:            <code class="filename">/dev/null</code> to avoid picking up
                   1784:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1785: </ul></div>
                   1786: </div>
1.148     asau     1787: <div class="sect1">
1.75      rillig   1788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1789: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1790: <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     1791:                 By default, binary packages of built packages are
1.263     leot     1792:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1793:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1794: <p>Packages have to support installation into a
1.103     wiz      1795:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1796:     to be built, before the actual filesystem is touched. DESTDIR
                   1797:     support exists in two variations:</p>
1.148     asau     1798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1799: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1800:       installation and packaging is still run as root.</p></li>
                   1801: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1802:       build, installation and packaging as normal user. Root
                   1803:       privileges are only needed to add packages.</p></li>
                   1804: </ul></div>
1.103     wiz      1805: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1806:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1807: <p>Considering the <code class="filename">foo/bar</code> package,
                   1808:     DESTDIR full support can be tested using the following commands
                   1809: 
                   1810: </p>
                   1811: <pre class="programlisting">
                   1812: <code class="prompt">$</code> id
                   1813: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1814: <code class="prompt">$</code> mkdir $HOME/packages
                   1815: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1816: </pre>
                   1817: <p>
                   1818: 
                   1819:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1820:     should be needed
                   1821: 
                   1822: </p>
                   1823: <pre class="programlisting">
1.174     asau     1824: <code class="prompt">$</code> make stage-install
1.118     imil     1825: </pre>
                   1826: <p>
                   1827: 
                   1828:     Create a package without root privileges
                   1829: 
                   1830: </p>
                   1831: <pre class="programlisting">
1.174     asau     1832: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1833: </pre>
                   1834: <p>
                   1835: 
                   1836:     For the following command, you must be able to gain root
1.322     leot     1837:     privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1838: 
                   1839: </p>
                   1840: <pre class="programlisting">
1.174     asau     1841: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1842: </pre>
                   1843: <p>
                   1844: 
                   1845:     Then, as a simple user
                   1846: 
                   1847: </p>
                   1848: <pre class="programlisting">
                   1849: <code class="prompt">$</code> make clean
                   1850: </pre>
                   1851: <p>
                   1852: 
                   1853:     </p>
1.103     wiz      1854: </div>
1.148     asau     1855: <div class="sect1">
1.103     wiz      1856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1857: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1858: <div class="sect2">
1.78      rillig   1859: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1860: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1861: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1862:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1863: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1864: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1865: <dd>
                   1866: <p>This is a list of values specifying the chain of
                   1867:          compilers to invoke when building packages.  Valid values
                   1868:          are:</p>
1.148     asau     1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1870: <li class="listitem"><p><code class="varname">ccc</code>:
                   1871:            Compaq C Compilers (Tru64)</p></li>
                   1872: <li class="listitem"><p><code class="varname">ccache</code>:
                   1873:            compiler cache (chainable)</p></li>
                   1874: <li class="listitem"><p><code class="varname">clang</code>:
                   1875:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1876: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1877:            distributed C/C++ (chainable)</p></li>
1.174     asau     1878: <li class="listitem"><p><code class="varname">f2c</code>:
                   1879:            Fortran 77 to C compiler (chainable)</p></li>
                   1880: <li class="listitem"><p><code class="varname">icc</code>:
                   1881:            Intel C++ Compiler (Linux)</p></li>
                   1882: <li class="listitem"><p><code class="varname">ido</code>:
                   1883:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1884: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1885:            GNU C/C++ Compiler</p></li>
1.174     asau     1886: <li class="listitem"><p><code class="varname">hp</code>:
                   1887:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1888: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1889:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1890: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1891:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1892: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1893:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1894: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1895:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1896: </ul></div>
                   1897: <p>The default is
1.128     wiz      1898:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1899:          <code class="varname">ccache</code> and/or
                   1900:          <code class="varname">distcc</code> with an appropriate
                   1901:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1902:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1903:          variable should always be terminated with a value for
                   1904:          a real compiler.  Note that only one real compiler
1.128     wiz      1905:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1906:          is not allowed).</p>
1.89      rillig   1907: </dd>
                   1908: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1909: <dd><p>This specifies the minimum version of GCC to use
                   1910:          when building packages.  If the system GCC doesn't
                   1911:          satisfy this requirement, then pkgsrc will build and
                   1912:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1913: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1914: <dd><p>Specifies which version of python to use when several
                   1915:          options are available.</p></dd>
                   1916: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1917: <dd><p>Specifies the Fortran compiler to use.
                   1918:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     1919: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1920: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1921:          <code class="varname">gfortran</code> is used, this option specifies which
                   1922:          version to use.</p></dd>
1.89      rillig   1923: </dl></div>
                   1924: </div>
1.148     asau     1925: <div class="sect2">
1.89      rillig   1926: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1927: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   1928: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1929:        please make sure to use the <code class="literal">+=</code> operator
                   1930:        instead of the <code class="literal">=</code> operator:</p>
                   1931: <pre class="programlisting">
1.100     rillig   1932: CFLAGS+=        -your -flags
1.78      rillig   1933: </pre>
                   1934: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1935:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1936:        need to add their own flags.  You may want to take a look
1.322     leot     1937:        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      1938:        package if you're interested in optimization specifically
                   1939:        for the current CPU. </p>
1.78      rillig   1940: </div>
1.148     asau     1941: <div class="sect2">
1.88      wiz      1942: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1943: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      1944: <p>If you want to pass flags to the linker, both in the configure
                   1945: step and the build step, you can do this in two ways.  Either set
                   1946: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1947: between the two is that <code class="varname">LIBS</code> will be appended to
                   1948: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1949: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1950: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1951: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1952: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1953: settings, use the <code class="literal">+=</code> operator:</p>
                   1954: <pre class="programlisting">
1.100     rillig   1955: LDFLAGS+=        -your -linkerflags
1.88      wiz      1956: </pre>
                   1957: </div>
1.78      rillig   1958: </div>
1.148     asau     1959: <div class="sect1">
1.78      rillig   1960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1961: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1962: <p>
1.75      rillig   1963:       </p>
1.148     asau     1964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1965: <li class="listitem">
1.75      rillig   1966: <p><code class="varname">PKG_DEVELOPER</code>:
                   1967:            Run some sanity checks that package developers want:
                   1968:            </p>
1.148     asau     1969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1970: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1971:              fuzz</p></li>
1.128     wiz      1972: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1973:              binaries will find their shared libs.</p></li>
1.75      rillig   1974: </ul></div>
                   1975: <p>
1.87      wiz      1976:        </p>
1.75      rillig   1977: </li>
1.128     wiz      1978: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1979:        of debugging output which is displayed whilst making and
                   1980:        installing the package.  The default value for this is 0,
                   1981:        which will not display the commands as they are executed
                   1982:        (normal, default, quiet operation); the value 1 will display
                   1983:        all shell commands before their invocation, and the value 2
                   1984:        will display both the shell commands before their invocation,
1.223     rillig   1985:        as well as their actual execution progress with <span class="command"><strong>set
                   1986:        -x</strong></span>.</p></li>
1.75      rillig   1987: </ul></div>
                   1988: <p>
                   1989:     </p>
                   1990: </div>
1.148     asau     1991: <div class="sect1">
1.75      rillig   1992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1993: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1994: <p>Some packages have build time options, usually to select
                   1995:     between different dependencies, enable optional support for big
                   1996:     dependencies or enable experimental features.</p>
1.75      rillig   1997: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1998:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1999:     show-options</strong></span>, for example:</p>
1.75      rillig   2000: <pre class="programlisting">
                   2001:     The following options are supported by this package:
                   2002:         ssl      Enable SSL support.
                   2003:     Exactly one of the following gecko options is required:
                   2004:         firefox  Use firefox as gecko rendering engine.
                   2005:         mozilla  Use mozilla as gecko rendering engine.
                   2006:     At most one of the following database options may be selected:
                   2007:         mysql    Enable support for MySQL database.
                   2008:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2009: 
1.75      rillig   2010:     These options are enabled by default: firefox
                   2011:     These options are currently enabled: mozilla ssl
1.1       grant    2012: </pre>
1.75      rillig   2013: <p>The following variables can be defined in
1.110     hubertf  2014:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2015:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2016:     which can be used to select or disable options for all packages
                   2017:     that support them, and
                   2018:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2019:     which can be used to select or disable options specifically for
                   2020:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2021:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2022:     are disabled. A few examples:</p>
1.75      rillig   2023: <pre class="screen">
1.110     hubertf  2024: <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   2025: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2026: PKG_OPTIONS.kdebase=    debug -sasl
                   2027: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2028: <p>It is important to note that options that were specifically
1.120     snj      2029:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2030:     you do not wish to include the option.  If you are unsure you can view
                   2031:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2032: <p>The following settings are consulted in the order given, and
                   2033:     the last setting that selects or disables an option is
                   2034:     used:</p>
1.128     wiz      2035: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2036: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2037:       maintainer</p></li>
1.128     wiz      2038: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2039:       variables (see below)</p></li>
1.128     wiz      2040: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2041: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2042: </ol></div>
                   2043: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2044:     selected is used, all others are automatically disabled.  If an
                   2045:     option of the group is explicitly disabled, the previously
                   2046:     selected option, if any, is used.  It is an error if no option
                   2047:     from a required group of options is selected, and building the
                   2048:     package will fail.</p>
                   2049: <p>Before the options framework was introduced, build options
                   2050:     were selected by setting a variable (often named
                   2051:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2052:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2053:     transition to the options framework for the user, these legacy
                   2054:     variables are converted to the appropriate options setting
                   2055:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2056:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2057:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2058:     directly.  Support for the legacy variables will be removed
                   2059:     eventually.</p>
1.75      rillig   2060: </div>
                   2061: </div>
1.148     asau     2062: <div class="chapter">
1.75      rillig   2063: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2064: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2065: <div class="toc">
                   2066: <p><b>Table of Contents</b></p>
1.210     leot     2067: <dl class="toc">
1.267     rillig   2068: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2069: <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   2070: </dl>
                   2071: </div>
1.148     asau     2072: <div class="sect1">
1.75      rillig   2073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2074: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2075: <p>Once you have built and installed a package, you can create
                   2076:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.322     leot     2077:     another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2078:     the same package on a group of hosts and wasting CPU time. It also
                   2079:     provides a simple means for others to install your package, should
                   2080:     you distribute it.</p>
                   2081: <p>To create a binary package, change into the appropriate
1.110     hubertf  2082:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2083:     package</strong></span>:</p>
                   2084: <pre class="screen">
1.223     rillig   2085: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2086: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2087: </pre>
1.87      wiz      2088: <p>This will build and install your package (if not already done),
                   2089:     and then build a binary package from what was installed. You can
1.110     hubertf  2090:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2091:     it. Binary packages are created by default in
                   2092:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.322     leot     2093:     gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, &#8220;Packaging figlet&#8221;</a> for a
                   2094:     continuation of 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> example.</p>
1.267     rillig   2095: <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      2096:     such a binary package.</p>
1.75      rillig   2097: </div>
1.148     asau     2098: <div class="sect1">
1.75      rillig   2099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2100: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299     rillig   2101: <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   2102: </div>
                   2103: </div>
1.148     asau     2104: <div class="chapter">
1.106     rillig   2105: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2106: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2107: builds)</h2></div></div></div>
                   2108: <div class="toc">
                   2109: <p><b>Table of Contents</b></p>
1.210     leot     2110: <dl class="toc">
1.267     rillig   2111: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2112: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2113: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2114: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig   2115: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2116: <dd><dl>
1.294     rillig   2117: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2118: <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   2119: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2120: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2121: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2122: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2123: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2124: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2125: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2126: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2127: </dl></dd>
                   2128: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2129: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2130: </dl>
                   2131: </div>
1.290     gutterid 2132: <p>For a number of reasons, you may want to build binary packages
                   2133: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2134: For instance, when you have multiple machines that should run the same software,
                   2135: it is wasted time if they all build their packages themselves from source.
                   2136: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2137: deploying onto production systems.
1.180     wiz      2138: There is a way of getting a set of binary packages:
1.290     gutterid 2139: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2140: This chapter describes how to set it up.</p>
1.148     asau     2141: <div class="sect1">
1.106     rillig   2142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2143: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2144: <p>First of all, you have to decide whether you build all packages
                   2145: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2146: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2147: A number of particularly heavy packages exist that are not actually
                   2148: interesting to a wide audience. (The approximate resource consumption for a
                   2149: 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>.)
                   2150: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2151: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2152: </p>
                   2153: <p>During bulk builds various packages are installed and deinstalled
                   2154: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2155: so make sure that you don't need any package during the builds.
1.223     rillig   2156: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2157: or something even more restrictive, depending on what the operating system provides,
                   2158: or dedicate the whole physical machine.
                   2159: As a useful side effect this makes sure that bulk builds cannot
                   2160: break anything in your system. There have been numerous cases where
1.106     rillig   2161: certain packages tried to install files outside the
                   2162: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2163: <code class="filename">/etc</code>.
                   2164: </p>
1.106     rillig   2165: </div>
1.148     asau     2166: <div class="sect1">
1.106     rillig   2167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295     rillig   2168: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2169: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2170: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2171: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2172: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2173: </ul></div>
1.148     asau     2174: <div class="sect2">
1.116     rillig   2175: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2176: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2177: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2178: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2179: Configure network access to fetch distribution files.
1.223     rillig   2180: Create a user with name "pbulk".</p>
1.178     asau     2181: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2182: <pre class="screen">
1.264     sevan    2183: <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>
                   2184: <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      2185: <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     2186: </pre>
                   2187: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2188: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2189: <pre class="screen">
1.230     sevan    2190: <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     2191: <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>
                   2192: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2193: </pre>
                   2194: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2195: <h3 class="title">Note</h3>
                   2196: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2197: <code class="filename">mk.conf</code> that contains settings you want to
                   2198: apply to packages you build. For instance,</p>
                   2199: <pre class="programlisting">
1.223     rillig   2200: PKG_DEVELOPER=          yes     # perform more checks
                   2201: X11_TYPE=               modular # use pkgsrc X11
                   2202: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2203:                                 # when building all packages)
1.178     asau     2204: </pre>
                   2205: </div>
                   2206: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2207: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2208: <pre class="programlisting">
                   2209: www/firefox
                   2210: mail/thunderbird
                   2211: misc/libreoffice4
                   2212: </pre>
1.179     asau     2213: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2214: and make final amendments, if wanted.</p>
1.178     asau     2215: <p>Start it:</p>
                   2216: <pre class="screen">
                   2217: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2218: </pre>
                   2219: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2220: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2221: </p>
                   2222: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2223: <h3 class="title">Note</h3>
                   2224: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2225: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2226: The script is kept small enough for better understanding.</p>
                   2227: </div>
                   2228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2229: <h3 class="title">Note</h3>
                   2230: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320     wiz      2231: unprivileged bulk build and helps configuring distributed bulk builds.
                   2232: Distributed bulk builds support either building in worker chroots
                   2233: (each node is a path to a different chroot)
                   2234: that replicate the target system, including the pbulk prefix,
                   2235: or remote machines (each node is
                   2236: an IP address that must be accessible over SSH without a password).</p>
1.178     asau     2237: </div>
1.106     rillig   2238: </div>
                   2239: </div>
1.148     asau     2240: <div class="sect1">
1.106     rillig   2241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2242: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2243: <p>A complete bulk build requires lots of disk space. Some of the
                   2244: disk space can be read-only, some other must be writable. Some can be on
                   2245: remote filesystems (such as NFS) and some should be local. Some can be
                   2246: temporary filesystems, others must survive a sudden reboot.</p>
                   2247: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320     wiz      2248: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2249: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180     wiz      2250: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2251: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2252: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2253: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2254: </ul></div>
                   2255: </div>
                   2256: <div class="sect1">
                   2257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293     rillig   2258: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2259: <p>To ensure that pkgsrc packages work in different configurations, it
                   2260: makes sense to run non-default bulk builds from time to time. This
                   2261: section lists some ideas for bulk builds that intentionally let packages
                   2262: fail if they don't follow the pkgsrc style.</p>
                   2263: <div class="sect2">
                   2264: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2265: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2266: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2267: <pre class="programlisting">
                   2268: GNU_CONFIGURE_STRICT=   yes
                   2269: </pre>
                   2270: <p>When a package fails this additional check, the most common cause
                   2271: is that the configure option was valid for an older version of the
                   2272: package but does not apply anymore. In that case, just remove it.</p>
                   2273: </div>
                   2274: <div class="sect2">
                   2275: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2276: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2277: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2278: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2279: compiler wrappers make it easy to force compiler options when the package
                   2280: is built. This can be used to find typical bugs across all packages that
                   2281: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2282: more reliable with the next updates.</p>
                   2283: <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   2284: <pre class="programlisting">
                   2285: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2286: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2287: </pre>
1.294     rillig   2288: <p>When a package fails to build using these stricter compiler
                   2289: options, document the circumstances in which the compiler produced the
                   2290: error message. This includes:</p>
1.293     rillig   2291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2292: <li class="listitem"><p>The platform
                   2293: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2294: <li class="listitem"><p>The source file</p></li>
                   2295: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2296: part of the diagnostic.</p></li>
1.294     rillig   2297: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2298: </ul></div>
                   2299: <p>If a package produces these error messages, but the package is
1.294     rillig   2300: 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
                   2301: in the next builds:</p>
1.293     rillig   2302: <pre class="programlisting">
1.294     rillig   2303: .if ${PKGPATH} == category/package
1.293     rillig   2304: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2305: # error message
                   2306: # code
1.294     rillig   2307: # Reason why the code does not need to be fixed.
1.293     rillig   2308: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2309: .endif
1.293     rillig   2310: </pre>
                   2311: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2312: needs to be fixed, prepare a local patch (see
                   2313: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2314: authors of the package, providing them with the information you collected
                   2315: above.</p>
                   2316: <p>Patches that are not essential for the package to work should only
                   2317: be reported upstream but not committed to pkgsrc, to make future updates
                   2318: easier.</p>
1.293     rillig   2319: </div>
                   2320: <div class="sect2">
                   2321: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2322: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2323: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2324: these apply to all phases of the package build process. Especially in the
                   2325: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2326: decisions. The GNU configure scripts feed many small test programs to the
                   2327: C compiler to see whether certain headers are available, functions are
                   2328: defined in a library and programs can be run. In many cases these
                   2329: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2330: -Wextra -Werror</code>.</p>
                   2331: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2332: options being added between the <code class="literal">configure</code> and
                   2333: <code class="literal">build</code> phases. It's a little more complicated than the
                   2334: other examples in this section but still easy enough.</p>
                   2335: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2336: desired compiler options. The compiler wrapper's original task is to hide
                   2337: unwanted directories of include files and to normalize compiler options.
                   2338: It does this by wrapping the compiler command and rewriting the command
                   2339: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2340: package directory and examine the
                   2341: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2342: individual configurations for the C compiler and the related tools. The
                   2343: plan is to find a hook between the configure and build phases, and to
                   2344: modify these configuration files at that point.</p>
                   2345: <p>To find this hook, have a look at
                   2346: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2347: <code class="literal">pre-build-checks-hook</code>. The word
                   2348: <code class="literal">checks</code> doesn't quite fit, but the
                   2349: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2350: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2351: <pre class="programlisting">
                   2352: # Just a few example options.
                   2353: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2354: 
                   2355: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2356: pre-build-checks-hook: add-build-only-cflags
                   2357: 
                   2358: add-build-only-cflags: .PHONY
                   2359:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2360:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2361:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2362:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2363:         done;                                   \
                   2364:         &gt; ${.TARGET}
                   2365: .endif
                   2366: </pre>
                   2367: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2368: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2369: not with spaces.)</p>
                   2370: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2371: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2372: should be undefined, possibly because it is only defined for a subset of
                   2373: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2374: at least one compiler option, to prevent a syntax error in the shell
                   2375: parser.</p>
                   2376: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2377: that the additional compiler options are only appended once, even if
                   2378: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2379: creates a marker file.</p>
                   2380: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2381: configure</strong></span> in a package directory. Up to now, everything works
                   2382: as usual. Examine the directory
                   2383: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2384: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2385: the file <code class="filename">cc</code>. Examine the tail of the
                   2386: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2387: options are used.</p>
                   2388: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2389: options to the file <code class="filename">cc</code> and will create the marker
                   2390: file in the same directory. After that, the build starts as usual, but
                   2391: with the added compiler options. Examine the tail of the file
                   2392: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2393: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2394: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2395: with these options.</p>
                   2396: <p>Building packages using this setup variant and fixing the resulting
                   2397: 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>
                   2398: </div>
                   2399: <div class="sect2">
                   2400: <div class="titlepage"><div><div><h3 class="title">
                   2401: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293     rillig   2402: <p>Some directories like <code class="varname">PREFIX</code>,
                   2403: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2404: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2405: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2406: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2407: <pre class="programlisting">
                   2408: PREFIX=         /a-random-uuid
                   2409: PKG_SYSCONFDIR= /a-random-uuid
                   2410: VARBASE=        /a-random-uuid
                   2411: PKGMANDIR=     a-random-uuid
                   2412: PKG_INFODIR=   a-random-uuid
                   2413: </pre>
                   2414: </div>
                   2415: <div class="sect2">
                   2416: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2417: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2418: <p>When building a package, warnings are typically ignored since they
                   2419: just flow by and do not cause the build to fail immediately. To find
                   2420: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2421: <pre class="programlisting">
                   2422: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2423: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2424: </pre>
                   2425: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2426: them can be redefined with a simple definition like above.</p>
1.294     rillig   2427: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2428: the package Makefile, research whether the package actually needs Perl.
                   2429: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2430: Makefile, and if it doesn't, add
                   2431: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2432: </div>
                   2433: <div class="sect2">
                   2434: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2435: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2436: <p>Using pkglint as part of the regular build process is mostly a
                   2437: waste of time. If you want to fix some of the warnings, just run pkglint
                   2438: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2439: 10), which is much faster than a complete bulk build.</p>
                   2440: </div>
                   2441: <div class="sect2">
                   2442: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2443: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2444: <p>To ensure that the binary packages don't contain references to the
                   2445: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2446: that variable includes the item <code class="literal">extra</code>, it is
                   2447: possible to define additional patterns that must not appear in any
                   2448: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2449: <pre class="programlisting">
                   2450: CHECK_WRKREF=                   extra
                   2451: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2452: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2453: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2454: </pre>
                   2455: <p>The above patterns will probably generate many false positives,
                   2456: therefore the results need to be taken with a grain of salt.</p>
                   2457: </div>
                   2458: <div class="sect2">
                   2459: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2460: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2461: <p>To run the test suites that come with each package, add this line
                   2462: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2463: <pre class="programlisting">
                   2464: PKGSRC_RUN_TEST=        yes
                   2465: </pre>
                   2466: <p>Be prepared that even the most basic packages fail this test. When
                   2467: doing a bulk build with this, it will often abort in the early phase
                   2468: where the packages are scanned for their dependencies since there are
                   2469: cyclic dependencies. There is still a lot to do in this area.</p>
                   2470: </div>
                   2471: <div class="sect2">
                   2472: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2473: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2474: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2475: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2476: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2477: <pre class="programlisting">
                   2478: RUN=    @set -eu;
                   2479: </pre>
1.296     rillig   2480: <p>After that, ensure that none of the bulk build log files (even
                   2481: those for successfully built packages) contains the string
                   2482: <code class="literal">parameter not set</code> or whatever error message the
                   2483: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2484: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2485: definition.</p>
                   2486: </div>
                   2487: <div class="sect2">
                   2488: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2489: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2490: <p>The build logs of a package are often quite long. This allows error
                   2491: messages or other interesting details to hide between the noise. To make
                   2492: the actual error message stand out more, add these lines to
                   2493: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2494: <pre class="programlisting">
                   2495: GNU_CONFIGURE_QUIET=    yes
                   2496: MAKE_FLAGS+=            -s
                   2497: </pre>
                   2498: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2499: Make. On exotic platforms with their own make, it may be a little
                   2500: different.</p>
                   2501: </div>
                   2502: </div>
                   2503: <div class="sect1">
                   2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2505: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2506: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2507:     create a CD-ROM set of the resulting binary packages to assist
                   2508:     in installing packages on other machines.  The
1.322     leot     2509:     <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      2510:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2511:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2512:     way that keeps all the dependencies for a given package on the same
                   2513:     CD as that package.</p>
1.148     asau     2514: <div class="sect2">
1.75      rillig   2515: <div class="titlepage"><div><div><h3 class="title">
1.293     rillig   2516: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2517: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2518:       man page. The following short example assumes that the binary
                   2519:       packages are left in
                   2520:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2521:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2522:       hold the ISO 9660 images.</p>
                   2523: <pre class="screen">
                   2524: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2525: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2526: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2527:       </pre>
                   2528: <p>If you wish to include a common set of files
                   2529:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2530:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2531:       directory which contains these files, e.g.:</p>
1.87      wiz      2532: <pre class="screen">
                   2533: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2534: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2535: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2536: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2537: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2539: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2540:       </pre>
1.75      rillig   2541: <p>Now create the images:</p>
                   2542: <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   2543: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2544:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2545:       in their root directories.</p>
1.75      rillig   2546: </div>
                   2547: </div>
                   2548: </div>
1.148     asau     2549: <div class="chapter">
1.75      rillig   2550: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2551: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2552: <div class="toc">
                   2553: <p><b>Table of Contents</b></p>
1.210     leot     2554: <dl class="toc">
1.267     rillig   2555: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2556: <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   2557: </dl>
                   2558: </div>
                   2559: <p>The files that are installed by pkgsrc are organized in a way that
                   2560: is similar to what you find in the <code class="filename">/usr</code> directory
                   2561: of the base system. But some details are different. This is because
                   2562: pkgsrc initially came from FreeBSD and had adopted its file system
                   2563: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2564: which operating system you are using pkgsrc with, you can expect the
                   2565: same layout for pkgsrc.</p>
1.91      rillig   2566: <p>There are mainly four root directories for pkgsrc, which are all
                   2567: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2568: When pkgsrc has been installed as root, the default locations
                   2569: are:</p>
                   2570: <pre class="programlisting">
1.100     rillig   2571: LOCALBASE=              /usr/pkg
                   2572: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2573: VARBASE=                /var
1.231     sevan    2574: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2575: </pre>
                   2576: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2577: user), the default locations are:</p>
                   2578: <pre class="programlisting">
1.100     rillig   2579: LOCALBASE=              ${HOME}/pkg
                   2580: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2581: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2582: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2583: </pre>
                   2584: <p>What these four directories are for, and what they look like is
                   2585: explained below.</p>
1.148     asau     2586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2587: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2588: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2589: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2590: the well-known subdirectories like <code class="filename">bin</code>,
                   2591: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2592: <code class="filename">share</code> and
                   2593: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2594: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2595: <code class="filename">/var</code> in the base system. Some programs (especially
                   2596: games, network daemons) need write access to it during normal
                   2597: operation.</p></li>
1.128     wiz      2598: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2599: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2600: 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   2601: itself.</p></li>
                   2602: </ul></div>
1.148     asau     2603: <div class="sect1">
1.90      rillig   2604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2605: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2606: </h2></div></div></div>
1.90      rillig   2607: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2608: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2609: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2610: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2611: <dd><p>Contains executable programs that are intended to be
                   2612: directly used by the end user.</p></dd>
                   2613: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2614: <dd><p>Contains files for the emulation layers of various other
                   2615: operating systems, especially for
                   2616: NetBSD.</p></dd>
                   2617: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2618: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2619: <dd><p>Contains
                   2620: the configuration files.</p></dd>
                   2621: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2622: <dd><p>Contains headers for the C and C++ programming
                   2623: languages.</p></dd>
                   2624: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2625: <dd><p>Contains GNU info files of various
                   2626: packages.</p></dd>
                   2627: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2628: <dd><p>Contains shared and static
                   2629: libraries.</p></dd>
                   2630: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2631: <dd><p>Contains data files that don't change after
                   2632: installation. Other data files belong into
                   2633: <code class="filename">${VARBASE}</code>.</p></dd>
                   2634: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2635: <dd><p>Contains programs that are not intended to be used by
                   2636: end users, such as helper programs or network
                   2637: daemons.</p></dd>
                   2638: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2639: <dd><p>Contains programs that are intended to be executed as
                   2640: CGI scripts by a web server.</p></dd>
                   2641: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2642: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2643: <dd><p>Contains brief
                   2644: documentation in form of manual pages.</p></dd>
                   2645: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2646: <dd><p>Contains programs that are intended to be used only by
                   2647: the super-user.</p></dd>
                   2648: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2649: <dd><p>Contains platform-independent data files that don't
                   2650: change after installation.</p></dd>
                   2651: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2652: <dd><p>Contains documentation files provided by the
                   2653: packages.</p></dd>
                   2654: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2655: <dd><p>Contains example files provided by the packages. Among
                   2656: others, the original configuration files are saved here and copied to
                   2657: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2658: installation.</p></dd>
                   2659: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2660: <dd><p>Contains the original files for rc.d
                   2661: scripts.</p></dd>
                   2662: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2663: <code class="filename">${VARBASE}</code>)</span></dt>
                   2664: <dd><p>Contains files
                   2665: that may be modified after
                   2666: installation.</p></dd>
                   2667: </dl></div>
                   2668: </div>
1.148     asau     2669: <div class="sect1">
1.90      rillig   2670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2671: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2672: </h2></div></div></div>
1.148     asau     2673: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2674: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2675: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2676: <dd><p>Contains
                   2677: information about the currently installed
                   2678: packages.</p></dd>
                   2679: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2680: <dd><p>Contains highscore
                   2681: files.</p></dd>
                   2682: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2683: <dd><p>Contains log files.</p></dd>
                   2684: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2685: <dd><p>Contains informational files about daemons that are
                   2686: currently running.</p></dd>
                   2687: </dl></div>
                   2688: </div>
                   2689: </div>
1.148     asau     2690: <div class="chapter">
1.90      rillig   2691: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2692: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2693: <div class="toc">
                   2694: <p><b>Table of Contents</b></p>
1.210     leot     2695: <dl class="toc">
1.267     rillig   2696: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2697: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2698: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2699: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2700: <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>
                   2701: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2702: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2703: <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>
                   2704: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2705: <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      2706: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2707: <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>
                   2708: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2709: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2710: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2711: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2712: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2713: <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   2714: </dl>
                   2715: </div>
                   2716: <p>This section contains hints, tips &amp; tricks on special things in
                   2717: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2718: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2719: <div class="sect1">
1.75      rillig   2720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2721: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2722: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2723: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2724: <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   2725:          This is a general purpose list for most issues regarding
                   2726:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2727:          for pkgsrc configuration, unexpected build failures, using
                   2728:          particular packages, upgrading pkgsrc installations,
                   2729:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2730:          proposals for changes that impact the pkgsrc user community,
                   2731:          e.g. major infrastructure changes, new features, package
                   2732:          removals, etc., may also be posted.</p></li>
1.289     leot     2733: <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   2734:          A list where the results of pkgsrc bulk builds are sent and
                   2735:          discussed.</p></li>
1.289     leot     2736: <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   2737:          This list is for those who are interested in getting a
                   2738:          commit message for every change committed to pkgsrc. It is
                   2739:          also available in digest form, meaning one daily message
                   2740:          containing all commit messages for changes to the package
                   2741:          source tree in that 24 hour period.</p></li>
                   2742: </ul></div>
                   2743: <p>To subscribe, do:</p>
                   2744: <pre class="programlisting">
1.100     rillig   2745: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2746: </pre>
                   2747: <p>Archives for all these mailing lists are available from
1.289     leot     2748: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2749: </div>
1.148     asau     2750: <div class="sect1">
1.75      rillig   2751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2752: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2753: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2754: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2755: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2756: they might be useful, and not to duplicate the documentation that comes
                   2757: with each package.</p>
                   2758: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322     leot     2759: <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   2760:       Symlinks for use by buildlink.</p></li></ul></div>
                   2761: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2763: <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    2764:       Calculates various kinds of checksums (including SHA3).</p></li>
1.322     leot     2765: <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   2766:       Compatibility library for pkgsrc tools.</p></li>
1.322     leot     2767: <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      2768:       non-BSD systems due to lack of native mtree.</p></li>
1.322     leot     2769: <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   2770:       Up-to-date replacement for
1.76      rillig   2771:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2772:       systems where pkg_install is not present.</p></li>
                   2773: </ul></div>
                   2774: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2776: <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   2777:       Create a binary package from an
1.110     hubertf  2778:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2779:       save the old package.</p></li>
1.322     leot     2780: <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   2781:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2782:       from multiple locations. It currently supports the following
                   2783:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322     leot     2784: <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  2785:       the best compiler flags to optimise code for your current
1.128     wiz      2786:       CPU and compiler. </p></li>
1.75      rillig   2787: </ul></div>
                   2788: <p>Utilities for keeping track of installed packages, being up to date,
                   2789: etc:</p>
1.148     asau     2790: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2791: <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      2792:     update tool similar to apt(1). Download, install, and upgrade
                   2793:     binary packages easily.</p></li>
1.322     leot     2794: <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   2795:       packages whose installed versions do not match the latest pkgsrc
                   2796:       entries.</p></li>
1.322     leot     2797: <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   2798:       dependency graphs of packages, to aid in choosing a strategy for
                   2799:       updating.</p></li>
1.322     leot     2800: <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
                   2801:       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>
                   2802: <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   2803:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322     leot     2804: <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   2805:       does various checks on the complete pkgsrc system.</p></li>
1.322     leot     2806: <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   2807:       packages you have installed.</p></li>
                   2808: </ul></div>
                   2809: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2810: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2811: <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   2812:       making and maintaining patches for a package (includes pkgdiff,
                   2813:       pkgvi, mkpatches, etc.).</p></li>
1.322     leot     2814: <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   2815:       converting to pkgsrc.</p></li>
                   2816: </ul></div>
                   2817: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2818: utilities)</p>
1.148     asau     2819: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2820: <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   2821:       packages in a chrooted area.</p></li>
1.322     leot     2822: <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   2823:       kernel version for chrooted cross builds.</p></li>
                   2824: </ul></div>
                   2825: </div>
1.148     asau     2826: <div class="sect1">
1.75      rillig   2827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2828: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2829: <p>To install packages from source as a non-root user, download
1.267     rillig   2830: 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   2831: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2832: --unprivileged</strong></span>.</p>
                   2833: <p>This will install the binary part of pkgsrc to
                   2834: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2835: into <code class="filename">~/pkg/etc</code>.</p>
                   2836: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2837: </div>
1.148     asau     2838: <div class="sect1">
1.75      rillig   2839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2840: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2841: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2842: enable this feature by adding the option
                   2843: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2844: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2845: distfile is found, pkgsrc will try to resume it.</p>
                   2846: <p>You can also
1.168     wiz      2847: use a different program than the platform default program by changing the
1.117     jnemeth  2848: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2849: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2850: by using the value manual.  A value of custom disables the system defaults
                   2851: and dependency tracking for the fetch program.  In that case you have to
                   2852: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2853: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2854: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2855: <p>For example, if you want to use
1.117     jnemeth  2856: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2857: like:</p>
                   2858: <pre class="programlisting">
1.223     rillig   2859: FETCH_USING=    wget
1.1       grant    2860: </pre>
1.75      rillig   2861: </div>
1.148     asau     2862: <div class="sect1">
1.75      rillig   2863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2864: <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      2865: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2866: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2867: you will have to add the following line into
1.110     hubertf  2868: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2869: <pre class="programlisting">
1.103     wiz      2870: X11_TYPE=modular
1.1       grant    2871: </pre>
1.75      rillig   2872: </div>
1.148     asau     2873: <div class="sect1">
1.75      rillig   2874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2875: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2876: <p>If you are sitting behind a firewall which does not allow direct
                   2877: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2878: relevant proxy hosts.  This is done using an environment variable in the
                   2879: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2880: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2881: port 80 as the proxy port number.  So the proxy environment variables
                   2882: are:</p>
                   2883: <pre class="programlisting">
1.100     rillig   2884: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2885: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2886: </pre>
1.75      rillig   2887: </div>
1.148     asau     2888: <div class="sect1">
1.75      rillig   2889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2890: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2891: <p>Some fetch tools are not prepared to support HTTPS by default
                   2892: (for example, the one in NetBSD 6.0), or the one installed by the
                   2893: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2894: dependency graph).</p>
                   2895: <p>Usually you won't notice, because distribution files are
                   2896: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2897: be often enough if you are following pkgsrc-current. In that case, set
                   2898: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2899: <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
                   2900: with HTTPS support by default. Of course, these tools need to be
                   2901: installed before you can use them this way.</p>
                   2902: </div>
                   2903: <div class="sect1">
                   2904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2905: <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   2906: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2907: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2908: the first available command from the following list:</p>
1.148     asau     2909: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2910: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2911: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2912: </ul></div>
                   2913: <p>On a default NetBSD installation, this will be
1.76      rillig   2914: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2915: connections first, and falls back to active connections if the server
                   2916: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2917: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2918: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2919: <p>Having that option present will prevent
1.76      rillig   2920: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2921: transfers.</p>
                   2922: </div>
1.148     asau     2923: <div class="sect1">
1.75      rillig   2924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2925: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2926: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2927: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2928: 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   2929: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2930: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2931: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2932: resulting list to your machine at work/school and use it there.  If you
1.322     leot     2933: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2934: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2935: URL:</p>
                   2936: <p>At home:</p>
                   2937: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2938: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2939: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2940: <p>At work:</p>
                   2941: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2942: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2943: home.</p>
                   2944: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2945: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2946: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2947: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2948: directly by running:</p>
1.75      rillig   2949: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2950: <p>If you even decide to ignore
                   2951: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2952: by running:</p>
                   2953: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2954: </div>
1.148     asau     2955: <div class="sect1">
1.75      rillig   2956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2957: <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      2958: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.322     leot     2959: <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   2960: package, you get the error from make that it doesn't know how to make
1.76      rillig   2961: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2962: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2963: the NetBSD base distribution on your machine.  It is recommended to do
                   2964: that to format man pages.</p>
1.322     leot     2965: <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   2966: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2967: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2968: </div>
1.148     asau     2969: <div class="sect1">
1.75      rillig   2970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2971: <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      2972: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2973: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2974: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2975: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2976: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2977: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2978: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2979: -r</strong></span>).</p>
                   2980: </div>
1.148     asau     2981: <div class="sect1">
1.75      rillig   2982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2983: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2984: <p>When installing packages as non-root user and using the just-in-time
1.322     leot     2985: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   2986: password for each required package installed.  To avoid this, the sudo
                   2987: package can be used, which does password caching over a limited time.  To
                   2988: use it, install sudo (either as binary package or from
1.322     leot     2989: <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  2990: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2991: <span class="emphasis"><em>after</em></span> the definition of the
                   2992: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2993: <pre class="programlisting">
1.100     rillig   2994: .if exists(${LOCALBASE}/bin/sudo)
                   2995: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2996: .endif
1.1       grant    2997: </pre>
1.75      rillig   2998: </div>
1.148     asau     2999: <div class="sect1">
1.75      rillig   3000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3001: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3002: <p>As the system administrator, you can choose where configuration files
                   3003: are installed.  The default settings make all these files go into
1.76      rillig   3004: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3005: be suboptimal depending on your expectations (e.g., a read-only,
                   3006: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3007: configuration of the provided packages).</p>
                   3008: <p>In order to change the defaults, you can modify the
                   3009: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3010: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3011: directory; some common examples include <code class="filename">/etc</code> or
                   3012: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3013: <p>Furthermore, you can change this value on a per-package basis by
                   3014: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3015: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3016: package you would like to modify, that is, the contents of
                   3017: <code class="varname">PKGBASE</code>.</p>
                   3018: <p>Note that after changing these settings, you must rebuild and
                   3019: reinstall any affected packages.</p>
                   3020: </div>
1.148     asau     3021: <div class="sect1">
1.75      rillig   3022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3023: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3024: <p>Please be aware that there can often be bugs in third-party software,
                   3025: and some of these bugs can leave a machine vulnerable to exploitation by
                   3026: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3027: maintains a database of known-exploits to packages which have at one time
                   3028: been included in pkgsrc.  The database can be downloaded automatically, and
                   3029: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3030: do this, refer to the following two tools (installed as part of the
1.322     leot     3031: <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      3032: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3033: <li class="listitem">
1.122     reed     3034: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3035:     download a list of the security vulnerabilities information.  This list
1.132     spz      3036:     is kept up to date by the pkgsrc security team, and is distributed
                   3037:     from the NetBSD ftp server:</p>
1.292     leot     3038: <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   3039: </li>
1.128     wiz      3040: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3041:     current machine, checking each known vulnerability.  If a
1.75      rillig   3042:     vulnerable package is installed, it will be shown by output to stdout,
                   3043:     including a description of the type of vulnerability, and a URL
                   3044:     containing more information.</p></li>
                   3045: </ol></div>
1.233     sevan    3046: <p>Use of these tools is strongly recommended!
1.317     nia      3047: 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    3048: reporting.</p>
                   3049: <p>If this database is installed, pkgsrc builds will use it to
                   3050: perform a security check before building any package.</p>
1.75      rillig   3051: </div>
1.148     asau     3052: <div class="sect1">
1.75      rillig   3053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3054: <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   3055: <p>When you add your own preferences to the
                   3056:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3057:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3058:        environment variables to the <code class="filename">./configure</code>
1.322     leot     3059:        scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3060:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3061:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3062:        package.</p>
                   3063: <p>Currently there is no solution to this problem. If you
                   3064:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3065:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3066:        directory and then inspect any <code class="filename">Makefile</code> and
                   3067:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3068:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3069:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3070:        programmers write so bad code that it only works for the
                   3071:        specific combination of <code class="varname">CFLAGS</code> they have
                   3072:        chosen.</p>
1.287     rillig   3073: <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>
                   3074: <pre class="programlisting">
                   3075: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3076: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3077: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3078: </pre>
                   3079: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3080: to see whether the above flags are passed to the actual build
                   3081: commands in general.</p>
                   3082: <p>To find out whether the flags are passed to individual compiler
                   3083: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3084: most cases, the flags from the original command lines (the lines starting
                   3085: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3086: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3087: missing from the actual compiler command, it must have been removed by
1.299     rillig   3088: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3089: </div>
1.148     asau     3090: <div class="sect1">
1.80      rillig   3091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3092: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3093: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3094: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3095:        case that occurs often is that people only update pkgsrc in
                   3096:        parts, because of performance reasons. Since pkgsrc is one large
                   3097:        system, not a collection of many small systems, there are
                   3098:        sometimes changes that only work when the whole pkgsrc tree is
                   3099:        updated.</p></li>
1.148     asau     3100: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3101:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3102:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3103:        files.</p></li>
1.148     asau     3104: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3105:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3106:        verify this.</p></li>
1.218     rillig   3107: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   3108:        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     3109: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3110:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3111: </ol></div>
                   3112: </div>
1.148     asau     3113: <div class="sect1">
1.88      wiz      3114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3115: <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   3116: <p>You have modified a file from pkgsrc, and someone else has
                   3117: modified that same file afterwards in the CVS repository. Both changes
                   3118: are in the same region of the file, so when you updated pkgsrc, the
                   3119: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3120: file. Because of these markers, the file is no longer a valid
                   3121: <code class="filename">Makefile</code>.</p>
                   3122: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3123: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3124: -dP</strong></span> in that directory to download the current version.</p>
                   3125: </div>
1.75      rillig   3126: </div>
                   3127: </div>
1.148     asau     3128: <div class="part">
1.75      rillig   3129: <div class="titlepage"><div><div><h1 class="title">
                   3130: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3131: <div class="partintro">
1.77      rillig   3132: <div></div>
                   3133: <p>This part of the book deals with creating and
1.128     wiz      3134:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3135:        guide on creating a new package. The remaining chapters are more
                   3136:        like a reference manual for pkgsrc.</p>
1.75      rillig   3137: <div class="toc">
                   3138: <p><b>Table of Contents</b></p>
1.210     leot     3139: <dl class="toc">
1.267     rillig   3140: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3141: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3142: <dd><dl>
1.299     rillig   3143: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3144: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3145: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3146: <dd><dl>
1.299     rillig   3147: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3148: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3149: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3150: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3151: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3152: </dl></dd>
1.299     rillig   3153: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3154: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3155: <dd><dl>
                   3156: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3157: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3158: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3159: </dl></dd>
                   3160: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3161: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3162: </dl></dd>
1.299     rillig   3163: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3164: <dd><dl>
1.299     rillig   3165: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3166: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3167: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3168: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3169: <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   3170: <dd><dl>
1.299     rillig   3171: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3172: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3173: </dl></dd>
1.299     rillig   3174: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3175: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3176: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3177: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3178: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3179: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3180: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3181: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3182: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3183: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3184: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3185: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3186: </dl></dd>
                   3187: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3188: <dd><dl>
                   3189: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3190: <dd><dl>
1.334   ! nia      3191: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
        !          3192: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
        !          3193: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig   3194: </dl></dd>
1.299     rillig   3195: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3196: <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   3197: </dl></dd>
1.299     rillig   3198: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3199: <dd><dl>
1.299     rillig   3200: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3201: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3202: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3203: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3204: <dd><dl>
1.299     rillig   3205: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3206: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3207: <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>
                   3208: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   3209: </dl></dd>
                   3210: </dl></dd>
1.299     rillig   3211: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3212: <dd><dl>
1.299     rillig   3213: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3214: <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>
                   3215: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3216: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3217: </dl></dd>
1.299     rillig   3218: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3219: <dd><dl>
1.299     rillig   3220: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3221: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3222: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3223: </dl></dd>
                   3224: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3225: <dd><dl>
                   3226: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3227: <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   3228: <dd><dl>
1.299     rillig   3229: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3230: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3231:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3232:       and
                   3233:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3234:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3235: </dl></dd>
1.299     rillig   3236: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3237: <dd><dl>
                   3238: <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>
                   3239: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3240: </dl></dd>
                   3241: </dl></dd>
                   3242: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3243: <dd><dl>
1.299     rillig   3244: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3246: <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>
                   3247: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3249: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3250: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3251: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3252: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3253: </dl></dd>
1.299     rillig   3254: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3255: <dd><dl>
                   3256: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3257: <dd><dl>
                   3258: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3259: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3260: </dl></dd>
1.299     rillig   3261: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3262: <dd><dl>
1.299     rillig   3263: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3264: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   3265: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   3266: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   3267: </dl></dd>
                   3268: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3269: <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>
                   3270: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3271: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3272: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3273: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3274: <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   3275: </dl></dd>
                   3276: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3277: <dd><dl>
                   3278: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3279: <dd><dl>
                   3280: <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>
                   3281: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3282: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3283: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3284: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3285: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3286: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3287: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3288: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3289: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3290: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3291: </dl></dd>
                   3292: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3293: <dd><dl>
                   3294: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3295: <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>
                   3296: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3297: </dl></dd>
                   3298: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3299: <dd><dl>
                   3300: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3301: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3302: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   3303: </dl></dd>
                   3304: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3305: <dd><dl>
                   3306: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3307: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      3308: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
                   3309: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
                   3310: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
                   3311: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267     rillig   3312: </dl></dd>
                   3313: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3314: <dd><dl>
                   3315: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3316: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3317: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3318: <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>
                   3319: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3320: </dl></dd>
                   3321: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3322: <dd><dl>
                   3323: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3324: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3325: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3326: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3327: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      3328: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     rillig   3329: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3330: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318     nia      3331: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   3332: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   3333: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   3334: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   3335: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   3336: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   3337: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87      wiz      3338:     emulation</a></span></dt>
1.318     nia      3339: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   3340: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77      rillig   3341: </dl></dd>
1.267     rillig   3342: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3343: </dl></dd>
1.299     rillig   3344: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3345: <dd><dl>
                   3346: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3347: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3348: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3349: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3350: </dl></dd>
1.267     rillig   3351: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3352: <dd><dl>
1.267     rillig   3353: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3354: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3355: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3356: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3357: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3358: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3359: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3360: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3361: </dl></dd>
                   3362: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig   3363: </dl>
                   3364: </div>
1.77      rillig   3365: </div>
1.148     asau     3366: <div class="chapter">
1.77      rillig   3367: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3368: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3369: <p>
                   3370:        To get help when developing pkgsrc, the definitive source is this
                   3371:        document, the pkgsrc guide. If you don't find anything here,
                   3372:        there are alternatives:
                   3373: </p>
                   3374: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3375: <li class="listitem">
                   3376: <p>
                   3377:        The built-in pkgsrc help, which is available after bootstrapping
                   3378:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3379:        help for any topic, such as a variable name like
                   3380:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3381:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3382:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322     leot     3383: <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   3384: </li>
                   3385: <li class="listitem"><p>
1.278     rillig   3386:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3387:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3388: </p></li>
                   3389: <li class="listitem"><p>
                   3390:        To see the values of the most common variables, run
                   3391:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3392:        topic. To see the variables for a single topic, run
                   3393:        <span class="command"><strong>bmake
                   3394:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3395:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3396: </p></li>
                   3397: <li class="listitem"><p>
1.267     rillig   3398:        The tech-pkg mailing list, to which
                   3399:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3400:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3401:        questions</a>.</p></li>
                   3402: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3403:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3404:        or by using a specialized chat program such as
                   3405:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3406:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3407: </ul></div>
                   3408: </div>
                   3409: <div class="chapter">
                   3410: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3411: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3412: <div class="toc">
                   3413: <p><b>Table of Contents</b></p>
1.210     leot     3414: <dl class="toc">
1.299     rillig   3415: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3416: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3417: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3418: <dd><dl>
                   3419: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3420: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3421: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3422: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3423: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3424: </dl></dd>
                   3425: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3426: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3427: <dd><dl>
                   3428: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3429: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3430: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3431: </dl></dd>
1.299     rillig   3432: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3433: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3434: </dl>
                   3435: </div>
1.299     rillig   3436: <p>Whenever you're preparing a package, there are a number of
                   3437: files involved which are described in the following
                   3438: sections.</p>
                   3439: <div class="sect1">
                   3440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3441: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3442: </h2></div></div></div>
                   3443: <p>Building, installation and creation of a binary package are all
                   3444:   controlled by the package's <code class="filename">Makefile</code>.
                   3445:   The <code class="filename">Makefile</code> describes various things about
                   3446:   a package, for example from where to get it, how to configure,
                   3447:   build, and install it.</p>
                   3448: <p>A package <code class="filename">Makefile</code> contains several
                   3449:   sections that describe the package.</p>
                   3450: <p>In the first section there are the following variables, which
                   3451:   should appear exactly in the order given here.  The order and
                   3452:   grouping of the variables is mostly historical and has no further
                   3453:   meaning.</p>
                   3454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3455: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3456:     distribution file to be downloaded from the package's
                   3457:     website.</p></li>
                   3458: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3459:     package, as used by pkgsrc. You need to provide it if
                   3460:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3461:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3462:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3463:     directory name together with the version number. It must match the
                   3464:     regular expression
                   3465:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3466:     starts with a letter or digit, and contains only letters, digits,
1.319     nia      3467:     dashes, underscores, dots and plus signs.
                   3468:     New packages should have entirely lower-case names, with the exception
                   3469:     of some that must follow pre-existing conventions
                   3470:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3471:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3472:     the package name.</p></li>
1.299     rillig   3473: <li class="listitem">
                   3474: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3475:     which the package fits in. You can choose any of the top-level
                   3476:     directories of pkgsrc for it.</p>
                   3477: <p>Currently the following values are available for
                   3478:     <code class="varname">CATEGORIES</code>. If more than
                   3479:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3480: <pre class="programlisting">
1.299     rillig   3481: archivers     cross         geography     meta-pkgs     security
                   3482: audio         databases     graphics      misc          shells
                   3483: benchmarks    devel         ham           multimedia    sysutils
                   3484: biology       editors       inputmethod   net           textproc
                   3485: cad           emulators     lang          news          time
                   3486: chat          finance       mail          parallel      wm
                   3487: comms         fonts         math          pkgtools      www
                   3488: converters    games         mbone         print         x11
1.77      rillig   3489: </pre>
                   3490: </li>
1.299     rillig   3491: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3492:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3493:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3494:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3495:     <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>
                   3496: </ul></div>
                   3497: <p>The second section contains information about separately
                   3498:   downloaded patches, if any.
                   3499:   </p>
                   3500: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3501: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3502:     Name(s) of additional files that contain distribution patches.
                   3503:     There is no default. pkgsrc will look for them at
                   3504:     <code class="varname">PATCH_SITES</code>.
                   3505:     They will automatically be uncompressed before patching if
                   3506:     the names end with <code class="filename">.gz</code> or
                   3507:     <code class="filename">.Z</code>.</p></li>
                   3508: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3509:     Primary location(s) for distribution patch files (see
                   3510:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3511: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.322     leot     3512:     an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   3513:     help find the correct files to patch. It defaults to
                   3514:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3515: </ul></div>
                   3516: <p>The third section contains the following variables.
                   3517:   </p>
                   3518: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3519: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3520:     address of the person who feels responsible for this package,
                   3521:     and who is most likely to look at problems or questions regarding
1.322     leot     3522:     this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299     rillig   3523:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3524:     before making changes to the package, but are not required to
                   3525:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3526:     to yourself. If you really can't maintain the package for future
                   3527:     updates, set it to
                   3528:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3529: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3530:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3531:     developers to update or change the package without contacting
                   3532:     you first. A package Makefile should contain one of
                   3533:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3534:     not both.  </p></li>
                   3535: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3536:     find more information about the package.</p></li>
                   3537: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3538:     description of the package (should not include the package
                   3539:     name).</p></li>
                   3540: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3541:     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>
                   3542: </ul></div>
                   3543: <p>Other variables that affect the build:
                   3544:   </p>
                   3545: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3546: <p><code class="varname">WRKSRC</code>: The directory where the
                   3547:       interesting distribution files of the package are found. The
                   3548:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3549:       works for most packages.</p>
                   3550: <p>If a package doesn't create a subdirectory for itself
                   3551:       (most GNU software does, for instance), but extracts itself in
                   3552:       the current directory, you should set
                   3553:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3554: <p>If a package doesn't create a subdirectory with the
                   3555:       name of <code class="varname">DISTNAME</code> but some different name,
                   3556:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3557:       <code class="filename">${WRKDIR}</code>, for example
                   3558:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322     leot     3559:       <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   3560: <p>The name of the working directory created by pkgsrc is
                   3561:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3562:       variable. By default, its value is
                   3563:       <code class="filename">work</code>. If you want to use the same
                   3564:       pkgsrc tree for building different kinds of binary packages,
                   3565:       you can change the variable according to your needs. Two
                   3566:       other variables handle common cases of setting
                   3567:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3568:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3569:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3570:       the host's name is attached to the directory name. If
                   3571:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3572:       is attached, which might look like
                   3573:       <code class="filename">work.i386</code> or
                   3574:       <code class="filename">work.sparc</code>.</p>
                   3575: </li></ul></div>
                   3576: <p>Please pay attention to the following gotchas:</p>
                   3577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3578: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3579:       installed in compressed form by the package.  For packages using
                   3580:       BSD-style makefiles which honor MANZ, there is
                   3581:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3582: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3583:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3584:       below).</p></li>
                   3585: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
                   3586: </ul></div>
                   3587: </div>
1.148     asau     3588: <div class="sect1">
1.91      rillig   3589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   3590: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3591: </h2></div></div></div>
                   3592: <p>The <code class="filename">distinfo</code> file contains the message
                   3593:   digest, or checksum, of each distfile needed for the package. This
                   3594:   ensures that the distfiles retrieved from the Internet have not been
                   3595:   corrupted during transfer or altered by a malign force to introduce
                   3596:   a security hole. To provide maximum security, all distfiles are
                   3597:   protected using three different message digest algorithms (SHA1,
                   3598:   RMD160, SHA512), as well as the file size.</p>
                   3599: <p>The <code class="filename">distinfo</code> file also contains the
                   3600:   checksums for all the patches found in the
                   3601:   <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
                   3602:   are only applied intentionally and that they don't accidentally change,
                   3603:   e.g. when merging different changes together. They also make sure that
                   3604:   new patches are actually added to CVS and old ones are removed.
                   3605:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3606:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3607: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3608:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3609: <p>Some packages have different sets of distfiles depending on
1.322     leot     3610:   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   3611:   <code class="filename">distinfo</code> file and care should be taken when
                   3612:   upgrading such a package to ensure distfile information is not
                   3613:   lost.</p>
                   3614: </div>
                   3615: <div class="sect1">
                   3616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3617: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3618: </h2></div></div></div>
                   3619: <p>Some packages don't work out-of-the box on the various
                   3620:   platforms that are supported by pkgsrc. These packages need
                   3621:   to be patched to make them work. The patch files can be
                   3622:   found in the <code class="filename">patches/</code> directory.</p>
                   3623: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3624:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3625:   extracting them, in alphabetic order.</p>
1.148     asau     3626: <div class="sect2">
1.91      rillig   3627: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3628: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3629: <p>The <code class="filename">patch-*</code> files should be in
                   3630:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3631:   problems. (To force patches to apply with fuzz you can set
                   3632:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3633:   should contain only changes for a single file, and no file should be
                   3634:   patched by more than one patch file. This helps to keep future
                   3635:   modifications simple.</p>
                   3636: <p>Each patch file is structured as follows: In the first line,
                   3637:   there is the RCS Id of the patch itself. The second line should be
                   3638:   empty for aesthetic reasons. After that, there should be a comment for
                   3639:   each change that the patch does. There are a number of standard
                   3640:   cases:</p>
                   3641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3642: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3643:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3644: <li class="listitem"><p>Patches that change source code should mention the
                   3645:   platform and other environment (for example, the compiler) that the
                   3646:   patch is needed for.</p></li>
                   3647: </ul></div>
                   3648: <p>The patch should be commented so that any
                   3649:   developer who knows the code of the application can make some use of
                   3650:   the patch. Special care should be taken for the upstream developers,
                   3651:   since we generally want that they accept our patches, so we have less
                   3652:   work in the future.</p>
1.91      rillig   3653: </div>
1.148     asau     3654: <div class="sect2">
1.91      rillig   3655: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3656: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3657: <p>One important thing to mention is to pay attention that no RCS
                   3658:   IDs get stored in the patch files, as these will cause problems when
                   3659:   later checked into the NetBSD CVS tree. Use the
1.322     leot     3660:   <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   3661:   problems.</p>
                   3662: <p>For even more automation, we recommend using
                   3663:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
                   3664:   whole set of patches. You just have to backup files before you
                   3665:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   3666:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3667:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3668:   you upgrade a package this way, you can easily compare the new
                   3669:   set of patches with the previously existing one with
                   3670:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3671:   are replaced by new files, so carefully check if you want to take all
                   3672:   the changes.</p>
                   3673: <p>When you have finished a package, remember to generate
                   3674:   the checksums for the patch files by using the <span class="command"><strong>make
                   3675:   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>
                   3676: <p>When adding a patch that corrects a problem in the
                   3677:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3678:   man pages should go), send the patch as a bug report to the
                   3679:   maintainer.  This benefits non-pkgsrc users of the package,
                   3680:   and usually makes it possible to remove the patch in future
                   3681:   version.</p>
                   3682: <p>The file names of the patch files are usually of the form
                   3683:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3684:   Many packages still use the previous convention
                   3685:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3686:   but new patches should be of the form containing the filename.
1.322     leot     3687:   <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   3688:   automatically.</p>
1.118     imil     3689: </div>
1.275     brook    3690: <div class="sect2">
                   3691: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3692: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3693: <p>If you want to share patches between multiple packages
                   3694:   in pkgsrc, e.g. because they use the same distfiles, set
                   3695:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3696:   can be found, e.g.:</p>
                   3697: <pre class="programlisting">
                   3698: PATCHDIR=       ../../editors/xemacs/patches
                   3699: </pre>
                   3700: <p>Patch files that are distributed by the author or other
                   3701:     maintainers can be listed in
                   3702:     <code class="varname">PATCHFILES</code>.</p>
                   3703: <p>If it is desired to store any patches that should not be
                   3704:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3705:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3706:     directory tree there is expected to have the same
                   3707:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3708:     patches are expected to be stored inside these dirs (also
                   3709:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3710:     example, if you want to keep a private patch for
                   3711:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3712:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3713:     files in the named directory are expected to be patch files,
                   3714:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3715:     applied</em></span>.</p>
1.275     brook    3716: </div>
                   3717: <div class="sect2">
                   3718: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3719: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3720: <p>When fixing a portability issue in the code do not use
                   3721:       preprocessor magic to check for the current operating system nor
                   3722:       platform.  Doing so hurts portability to other platforms because
                   3723:       the OS-specific details are not abstracted appropriately.</p>
                   3724: <p>The general rule to follow is: instead of checking for the
                   3725:       operating system the application is being built on, check for the
                   3726:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3727:       instead of assuming that kqueue is available under NetBSD and
                   3728:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3729:       kqueue support, add a check that detects kqueue itself &mdash;
                   3730:       yes, this generally involves patching the
                   3731:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3732:       that prevents some OSes from adopting interfaces from other OSes
                   3733:       (e.g. Linux implementing kqueue), something that the above checks
                   3734:       cannot take into account.</p>
                   3735: <p>Of course, checking for features generally involves more
                   3736:       work on the developer's side, but the resulting changes are
                   3737:       cleaner and there are chances they will work on many other
                   3738:       platforms.  Not to mention that there are higher chances of being
                   3739:       later integrated into the mainstream sources.  Remember:
                   3740:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3741: <p>Some typical examples:</p>
                   3742: <div class="table">
                   3743: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3744: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3745: <colgroup>
                   3746: <col>
                   3747: <col>
                   3748: <col>
                   3749: </colgroup>
                   3750: <thead><tr>
                   3751: <th>Where</th>
                   3752: <th>Incorrect</th>
                   3753: <th>Correct</th>
                   3754: </tr></thead>
                   3755: <tbody>
                   3756: <tr>
                   3757: <td>configure script</td>
                   3758: <td>
1.275     brook    3759: <pre class="programlisting">
1.299     rillig   3760: case ${target_os} in
                   3761: netbsd*) have_kvm=yes ;;
                   3762: *)       have_kvm=no  ;;
                   3763: esac
1.275     brook    3764: </pre>
1.299     rillig   3765:              </td>
                   3766: <td>
1.275     brook    3767: <pre class="programlisting">
1.299     rillig   3768: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3769: </pre>
1.299     rillig   3770:              </td>
                   3771: </tr>
                   3772: <tr>
                   3773: <td>C source file</td>
                   3774: <td>
1.91      rillig   3775: <pre class="programlisting">
1.299     rillig   3776: #if defined(__NetBSD__)
                   3777: #  include &lt;sys/event.h&gt;
                   3778: #endif
1.91      rillig   3779: </pre>
1.299     rillig   3780:              </td>
                   3781: <td>
1.91      rillig   3782: <pre class="programlisting">
1.299     rillig   3783: #if defined(HAVE_SYS_EVENT_H)
                   3784: #  include &lt;sys/event.h&gt;
                   3785: #endif
1.91      rillig   3786: </pre>
1.299     rillig   3787:              </td>
                   3788: </tr>
                   3789: <tr>
                   3790: <td>C source file</td>
                   3791: <td>
1.91      rillig   3792: <pre class="programlisting">
1.299     rillig   3793: int
                   3794: monitor_file(...)
                   3795: {
                   3796: #if defined(__NetBSD__)
                   3797:         int fd = kqueue();
                   3798:         ...
                   3799: #else
                   3800:         ...
                   3801: #endif
                   3802: }
1.91      rillig   3803: </pre>
1.299     rillig   3804:              </td>
                   3805: <td>
1.91      rillig   3806: <pre class="programlisting">
1.299     rillig   3807: int
                   3808: monitor_file(...)
                   3809: {
                   3810: #if defined(HAVE_KQUEUE)
                   3811:         int fd = kqueue();
                   3812:         ...
                   3813: #else
                   3814:         ...
                   3815: #endif
                   3816: }
1.91      rillig   3817: </pre>
1.299     rillig   3818:              </td>
                   3819: </tr>
                   3820: </tbody>
                   3821: </table></div>
                   3822: </div>
                   3823: <br class="table-break">
                   3824: </div>
                   3825: <div class="sect2">
                   3826: <div class="titlepage"><div><div><h3 class="title">
                   3827: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3828: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3829:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3830:       improvements you do to a package to the mainstream developers.
                   3831:       This is the only way to get their attention on portability issues
                   3832:       and to ensure that future versions can be built out-of-the box on
                   3833:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3834:       the fixes straight from the packaged code.</p>
                   3835: <p>This generally involves cleaning up the patches
                   3836:       (because sometimes the patches that are
                   3837:       added to pkgsrc are quick hacks), filing bug reports in the
                   3838:       appropriate trackers for the projects and working with the
                   3839:       mainstream authors to accept your changes.  It is
                   3840:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3841:       the packages in pkgsrc are kept simple and thus further changes
                   3842:       can be done without much hassle.</p>
                   3843: <p>When you have done this, please add a URL to the upstream
                   3844:       bug report to the patch comment.</p>
                   3845: <p>Support the idea of free software!</p>
                   3846: </div>
1.91      rillig   3847: </div>
1.299     rillig   3848: <div class="sect1">
                   3849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3850: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3851: <div class="variablelist"><dl class="variablelist">
                   3852: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3853: <dd><p>A multi-line description of the piece of software.  This should include
                   3854:          any credits where they are due.  Please bear in mind that others do not
                   3855:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3856:          will read everything that you write here.</p></dd>
                   3857: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3858: <dd><p>This file governs the files that are installed on your
                   3859:          system: all the binaries, manual pages, etc. There are other
                   3860:          directives which may be entered in this file, to control the
                   3861:          creation and deletion of directories, and the location of
                   3862:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3863:          information.</p></dd>
                   3864: </dl></div>
                   3865: </div>
                   3866: <div class="sect1">
                   3867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3868: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3869: <div class="sect2">
                   3870: <div class="titlepage"><div><div><h3 class="title">
                   3871: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3872: <div class="variablelist"><dl class="variablelist">
                   3873: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3874: <dd>
1.322     leot     3875: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   3876:            First time after package extraction and before files are
                   3877:            moved in place, the second time after the files to install
                   3878:            are moved in place. This can be used to do any custom
                   3879:            procedures not possible with @exec commands in
1.322     leot     3880:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3881:            <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   3882:            Please note that you can modify variables in it easily by using
                   3883:            <code class="varname">FILES_SUBST</code> in the package's
                   3884:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3885: <pre class="programlisting">
1.299     rillig   3886: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3887: </pre>
1.299     rillig   3888: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3889:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3890:            performed for <code class="varname">PREFIX</code>,
                   3891:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3892:            <code class="varname">VARBASE</code>, and a few others, type
                   3893:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3894:            complete list.</p>
                   3895: </dd>
                   3896: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3897: <dd><p>This script is executed before and after any files are removed.  It is
                   3898:            this script's responsibility to clean up any additional messy details
                   3899:            around the package's installation, since all pkg_delete knows is how to
                   3900:            delete the files created in the original distribution.
1.322     leot     3901:            See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3902:            and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   3903:            The same methods to replace variables can be used as for
                   3904:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3905: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3906: <dd>
                   3907: <p>This file is displayed after installation of the package.
1.312     gdt      3908:            While this was used often in the past, it has two
                   3909:            problems: the display will be missed if many packages are
                   3910:            intalled at once, and the person installing the package
                   3911:            and the one using or configuring it may be different.  It
                   3912:            should therefore be used only in exceptional circumstances
                   3913:            where lasting negative consequences would result from
                   3914:            someone not reading it.</p>
                   3915: <p>MESSAGE should not be used for:</p>
                   3916: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3917: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   3918: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   3919: <li class="listitem"><p>anything that should be explained in the
                   3920:              installation/configuration documentation that should
                   3921:              come with the package</p></li>
                   3922: </ul></div>
                   3923: <p>If the documentation provided by upstream needs
1.313     leot     3924:            enhancing, create e.g. files/README.pkgsrc and install it
                   3925:            in the package's documentation directory.
1.312     gdt      3926:            </p>
                   3927: <p>Note that MESSAGE is shown for all operating
                   3928:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     3929:            it should be narrowed to only those operating systems and
1.312     gdt      3930:            init systems to which it applies.</p>
                   3931: <p>Note that you can modify variables in it easily by using
1.299     rillig   3932:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3933:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3934: <pre class="programlisting">
1.299     rillig   3935: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3936: </pre>
1.299     rillig   3937: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3938:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3939:            performed for <code class="varname">PKGNAME</code>,
                   3940:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3941:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3942:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3943:            <code class="varname">ROOT_GROUP</code>, and
                   3944:            <code class="varname">ROOT_USER</code>.</p>
                   3945: <p>You can display a different or additional files by
                   3946:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3947:            default is <code class="filename">MESSAGE</code>, if the file
                   3948:            exists.</p>
                   3949: </dd>
                   3950: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3951: <dd>
                   3952: <p>This file is used by the alternatives framework.
                   3953:            It creates, configures, and destroys generic wrappers used to
                   3954:            run programs with similar interfaces.
                   3955:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3956:             for more information.</p>
                   3957: <p>Each line of the file contains two filenames, first
                   3958:            the wrapper and then the alternative provided by the package.
                   3959:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3960: </dd>
                   3961: </dl></div>
                   3962: </div>
                   3963: <div class="sect2">
                   3964: <div class="titlepage"><div><div><h3 class="title">
                   3965: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3966: <div class="variablelist"><dl class="variablelist">
                   3967: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3968: <dd><p>This file contains arbitrary things that could
                   3969:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3970:        to be used by more than one package. This file should only be
                   3971:        used when the packages that will use the file are known in
                   3972:        advance. For other purposes it is often better to write a
                   3973:        <code class="filename">*.mk</code> file and give it a good name that
                   3974:        describes what it does.</p></dd>
                   3975: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3976: <dd><p>This file contains the dependency information
                   3977:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3978: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3979: <dd><p>This file contains workarounds for compiler bugs
                   3980:        and similar things. It is included automatically by the pkgsrc
                   3981:        infrastructure, so you don't need an extra
                   3982:        <code class="literal">.include</code> line for
                   3983:        it.</p></dd>
                   3984: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3985: <dd><p>This file contains the code for the
                   3986:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3987:        selected by the user. If a package has only one or two options,
                   3988:        it is equally acceptable to put the code directly into the
                   3989:        <code class="filename">Makefile</code>.</p></dd>
                   3990: </dl></div>
                   3991: </div>
                   3992: <div class="sect2">
                   3993: <div class="titlepage"><div><div><h3 class="title">
                   3994: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   3995: <div class="variablelist"><dl class="variablelist">
                   3996: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3997: <dd><p>These files do not take place in the creation of
                   3998:        a package and thus are purely informative to the package
                   3999:        developer.</p></dd>
                   4000: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4001: <dd><p>This file contains things that need to be done
                   4002:        to make the package even
                   4003:        better.</p></dd>
                   4004: </dl></div>
                   4005: </div>
                   4006: </div>
                   4007: <div class="sect1">
                   4008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4009: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   4010: </h2></div></div></div>
                   4011: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4012:     unpacked into the directory denoted by
                   4013:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4014:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4015:     directory is also used to keep various timestamp files.
                   4016:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4017:     The default is <code class="filename">${.CURDIR}/work</code>
                   4018:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4019:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   4020: </div>
1.299     rillig   4021: <div class="sect1">
                   4022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4023: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   4024: </h2></div></div></div>
                   4025: <p>If you have any files that you wish to be placed in the package
                   4026:     prior to configuration or building, you can place these files here
                   4027:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4028:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   4029: <p>If you want to share files in this way with other
                   4030:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4031:     to the other package's <code class="filename">files</code> directory,
                   4032:     e.g.:</p>
1.91      rillig   4033: <pre class="programlisting">
1.299     rillig   4034: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4035: </pre>
                   4036: </div>
                   4037: </div>
1.148     asau     4038: <div class="chapter">
1.75      rillig   4039: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   4040: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4041: <div class="toc">
                   4042: <p><b>Table of Contents</b></p>
1.210     leot     4043: <dl class="toc">
1.299     rillig   4044: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4045: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4046: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4047: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4048: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4049: <dd><dl>
                   4050: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4051: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4052: </dl></dd>
                   4053: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4054: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4055: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4056: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4057: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4058: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4059: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4060: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4061: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4062: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4063: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4064: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4065: </dl>
                   4066: </div>
1.148     asau     4067: <div class="sect1">
1.75      rillig   4068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4069: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4070: <p>This chapter gives a detailed description on how a package is
                   4071:     built. Building a package is separated into different
                   4072:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4073:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4074:     described in the following sections. Each phase is split into
                   4075:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4076:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4077:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4078:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4079:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4080: <p>Never override the regular targets (like
                   4081:     <code class="varname">fetch</code>), if you have to, override the
                   4082:     <code class="varname">do-*</code> ones instead.</p>
                   4083: <p>The basic steps for building a program are always the same.  First
                   4084:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4085:     the local system and then extracted. After any pkgsrc-specific patches
                   4086:     to compile properly are applied, the software can be configured, then
                   4087:     built (usually by compiling), and finally the generated binaries, etc.
                   4088:     can be put into place on the system.</p>
                   4089: <p>To get more details about what is happening at each step,
                   4090:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4091:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4092:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4093: </div>
                   4094: <div class="sect1">
                   4095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4096: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4097: <p>Before outlining the process performed by the NetBSD package system in
                   4098:     the next section, here's a brief discussion on where programs are
                   4099:     installed, and which variables influence this.</p>
                   4100: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4101:     where all files of the final program shall be installed. It is
                   4102:     usually set to <code class="varname">LOCALBASE</code>
                   4103:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4104:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4105:     <code class="varname">PREFIX</code> needs to be put
                   4106:     into the various places in the program's source where paths to
                   4107:     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>
                   4108: <p>When choosing which of these variables to use,
                   4109:     follow the following rules:</p>
1.148     asau     4110: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4111: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4112:        where the current pkg will be installed.  When referring to a
                   4113:        pkg's own installation path, use
                   4114:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   4115: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   4116:        are installed.  If you need to construct a -I or -L argument
                   4117:        to the compiler to find includes and libraries installed by
                   4118:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
                   4119:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4120:        installed all packages in <code class="filename">/usr/local</code>. As
                   4121:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4122:        administrator, this variable is a misnomer.</p></li>
                   4123: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4124:        distribution (from xsrc, etc.) is installed. When looking for
                   4125:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4126:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4127: <li class="listitem"><p>X11-based packages using imake must set
                   4128:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4129:        <code class="varname">LOCALBASE</code>.</p></li>
                   4130: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.322     leot     4131:        install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4132:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4133:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4134: </ul></div>
                   4135: </div>
                   4136: <div class="sect1">
                   4137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4138: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4139: <p>When building a package, various directories are used to store
                   4140:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4141:     directories are explained here.</p>
                   4142: <p>Some of the directory variables contain relative pathnames. There
                   4143:     are two common base directories for these relative directories:
                   4144:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4145:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4146:     inside the package itself.</p>
                   4147: <div class="variablelist"><dl class="variablelist">
                   4148: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4149: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4150:       root directory. Generally, you don't need
                   4151:       it.</p></dd>
                   4152: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4153: <dd><p>This is an absolute pathname that points to the
                   4154:       current package.</p></dd>
                   4155: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4156: <dd><p>This is a pathname relative to
                   4157:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4158:       package.</p></dd>
                   4159: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4160: <dd><p>This is an absolute pathname pointing to the directory
                   4161:       where all work takes place. The distfiles are extracted to this
                   4162:       directory. It also contains temporary directories and log files used by
                   4163:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4164:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4165: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4166: <dd><p>This is an absolute pathname pointing to the directory
                   4167:       where the distfiles are extracted. It is usually a direct subdirectory
                   4168:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4169:       that isn't hidden. This variable may be changed by a package
                   4170:       <code class="filename">Makefile</code>.</p></dd>
                   4171: </dl></div>
                   4172: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4173:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4174:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4175:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4176:     If users would like to have their pkgsrc trees behave in a
                   4177:     read-only manner, then the value of
                   4178:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4179:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4180: </div>
1.148     asau     4181: <div class="sect1">
1.75      rillig   4182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4183: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4184: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4185:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4186:     phase. This will automatically run all phases that are required for this
                   4187:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4188:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4189:     the package will be built, but not installed.</p>
1.75      rillig   4190: </div>
1.148     asau     4191: <div class="sect1">
1.75      rillig   4192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4193: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4194: <p>The first step in building a package is to fetch the
                   4195:     distribution files (distfiles) from the sites that are providing
                   4196:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4197:     phase.</p>
1.148     asau     4198: <div class="sect2">
1.93      rillig   4199: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4200: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4201: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4202:       defines all URLs from where the distfile, whose name is
                   4203:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4204:       fetched. The more complicated cases are described
                   4205:       below.</p>
                   4206: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4207:       the list of distfiles that have to be fetched. Its value
                   4208:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4209:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4210:       so that most packages don't need to define it at all.
                   4211:       <code class="varname">EXTRACT_SUFX</code> is
                   4212:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4213:       freely. Note that if your package requires additional
                   4214:       distfiles to the default one, you cannot just append the
                   4215:       additional filenames using the <code class="literal">+=</code>
                   4216:       operator, but you have write for example:</p>
                   4217: <pre class="programlisting">
                   4218: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4219: </pre>
                   4220: <p>Each distfile is fetched from a list of sites, usually
                   4221:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4222:       <code class="varname">DISTFILES</code> or multiple
                   4223:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4224:       set
                   4225:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4226:       to the list of URLs where the file
                   4227:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4228:       (including the suffix) can be found.</p>
                   4229: <pre class="programlisting">
                   4230: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4231: DISTFILES+=     foo-file.tar.gz
                   4232: SITES.foo-file.tar.gz= \
                   4233: https://www.somewhere.com/somehow/ \
                   4234: https://www.somewhereelse.com/mirror/somehow/
                   4235: </pre>
                   4236: <p>When actually fetching the distfiles, each item from
                   4237:       <code class="varname">MASTER_SITES</code> or
                   4238:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4239:       appended to it, without an intermediate slash. Therefore,
                   4240:       all site values have to end with a slash or other separator
                   4241:       character. This allows for example to set
                   4242:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4243:       that gets the name of the distfile as a parameter. In this
                   4244:       case, the definition would look like:</p>
                   4245: <pre class="programlisting">
                   4246: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4247: </pre>
                   4248: <p> The exception to this rule are URLs starting with a dash.
                   4249:       In that case the URL is taken as is, fetched and the result
                   4250:       stored under the name of the distfile. You can use this style
                   4251:       for the case when the download URL style does not match the
                   4252:       above common case. For example, if permanent download URL is a
                   4253:       redirector to the real download URL, or the download file name
                   4254:       is offered by an HTTP Content-Disposition header. In the
                   4255:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4256:       created instead of the default
                   4257:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4258: <pre class="programlisting">
                   4259: DISTNAME=       foo-1.0.0
                   4260: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4261: </pre>
                   4262: <p>There are some predefined values for
                   4263:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4264:       packages.  The names of the variables should speak for
                   4265:       themselves.</p>
                   4266: <table border="0" summary="Simple list" class="simplelist">
                   4267: <tr>
                   4268: <td>MASTER_SITE_APACHE</td>
                   4269: <td>MASTER_SITE_BACKUP</td>
                   4270: </tr>
                   4271: <tr>
                   4272: <td>MASTER_SITE_CRATESIO</td>
                   4273: <td>MASTER_SITE_CYGWIN</td>
                   4274: </tr>
                   4275: <tr>
                   4276: <td>MASTER_SITE_DEBIAN</td>
                   4277: <td>MASTER_SITE_FREEBSD</td>
                   4278: </tr>
                   4279: <tr>
                   4280: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4281: <td>MASTER_SITE_GENTOO</td>
                   4282: </tr>
                   4283: <tr>
                   4284: <td>MASTER_SITE_GITHUB</td>
                   4285: <td>MASTER_SITE_GNOME</td>
                   4286: </tr>
                   4287: <tr>
                   4288: <td>MASTER_SITE_GNU</td>
                   4289: <td>MASTER_SITE_GNUSTEP</td>
                   4290: </tr>
                   4291: <tr>
                   4292: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4293: <td>MASTER_SITE_IFARCHIVE</td>
                   4294: </tr>
                   4295: <tr>
                   4296: <td>MASTER_SITE_KDE</td>
                   4297: <td>MASTER_SITE_MOZILLA</td>
                   4298: </tr>
                   4299: <tr>
                   4300: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4301: <td>MASTER_SITE_MYSQL</td>
                   4302: </tr>
                   4303: <tr>
                   4304: <td>MASTER_SITE_NETLIB</td>
                   4305: <td>MASTER_SITE_OPENBSD</td>
                   4306: </tr>
                   4307: <tr>
                   4308: <td>MASTER_SITE_OPENOFFICE</td>
                   4309: <td>MASTER_SITE_OSDN</td>
                   4310: </tr>
                   4311: <tr>
                   4312: <td>MASTER_SITE_PERL_CPAN</td>
                   4313: <td>MASTER_SITE_PGSQL</td>
                   4314: </tr>
                   4315: <tr>
                   4316: <td>MASTER_SITE_PYPI</td>
                   4317: <td>MASTER_SITE_RUBYGEMS</td>
                   4318: </tr>
                   4319: <tr>
                   4320: <td>MASTER_SITE_R_CRAN</td>
                   4321: <td>MASTER_SITE_SOURCEFORGE</td>
                   4322: </tr>
1.85      jmmv     4323: <tr>
1.299     rillig   4324: <td>MASTER_SITE_SUNSITE</td>
                   4325: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4326: </tr>
                   4327: <tr>
1.299     rillig   4328: <td>MASTER_SITE_TEX_CTAN</td>
                   4329: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4330: </tr>
                   4331: <tr>
1.299     rillig   4332: <td>MASTER_SITE_XEMACS</td>
                   4333: <td>MASTER_SITE_XORG</td>
                   4334: </tr>
                   4335: </table>
                   4336: <p>Some explanations for the less self-explaining ones:
                   4337:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4338:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   4339:       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>
                   4340: <p>If you choose one of these predefined sites, you may
                   4341:       want to specify a subdirectory of that site. Since these
                   4342:       macros may expand to more than one actual site, you
                   4343:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4344:       specify a subdirectory:</p>
1.100     rillig   4345: <pre class="programlisting">
1.299     rillig   4346: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4347: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4348: </pre>
1.299     rillig   4349: <p>Note the trailing slash after the subdirectory
                   4350:       name.</p>
                   4351: </div>
                   4352: <div class="sect2">
                   4353: <div class="titlepage"><div><div><h3 class="title">
                   4354: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4355: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4356:       all the distfiles exist in a local directory
                   4357:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4358:       user). If the files do not exist, they are fetched using
                   4359:       commands of the form</p>
1.100     rillig   4360: <pre class="programlisting">
1.299     rillig   4361: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4362: </pre>
                   4363: <p>where <code class="literal">${site}</code> varies through
                   4364:       several possibilities in turn: first,
                   4365:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4366:       sites specified in either <code class="varname">SITES.file</code> if
                   4367:       defined, else <code class="varname">MASTER_SITES</code> or
                   4368:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4369:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4370:       all except the first and the last can be optionally sorted
                   4371:       by the user, via setting either
                   4372:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4373:       <code class="varname">MASTER_SORT_AWK</code> or
                   4374:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4375: <p> The specific command and arguments used depend on the
                   4376:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4377:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4378: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4379:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4380:       distfiles, if they are freely distributable.  Packages setting
                   4381:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4382:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4383:       mirrored.</p>
1.85      jmmv     4384: </div>
                   4385: </div>
1.299     rillig   4386: <div class="sect1">
                   4387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4388: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4389: <p>After the distfile(s) are fetched, their checksum is
                   4390:     generated and compared with the checksums stored in the
                   4391:     distinfo file. If the checksums don't match, the build is
                   4392:     aborted. This is to ensure the same distfile is used for
                   4393:     building, and that the distfile wasn't changed, e.g. by some
                   4394:     malign force, deliberately changed distfiles on the master
                   4395:     distribution site or network lossage.</p>
1.75      rillig   4396: </div>
1.148     asau     4397: <div class="sect1">
1.75      rillig   4398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4399: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4400: <p>When the distfiles are present on the local system, they
                   4401:     need to be extracted, as they usually come in the form of some
                   4402:     compressed archive format.</p>
                   4403: <p>By default, all <code class="varname">DISTFILES</code> are
                   4404:     extracted. If you only need some of them, you can set the
                   4405:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4406:     files.</p>
                   4407: <p>Extracting the files is usually done by a little
                   4408:     program, <code class="filename">mk/extract/extract</code>, which
                   4409:     already knows how to extract various archive formats, so most
                   4410:     likely you will not need to change anything here. But if you
                   4411:     need, the following variables may help you:</p>
1.148     asau     4412: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4413: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4414: <dd><p>Use these variables to override the default
                   4415:       options for an extract command, which are defined in
                   4416:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4417: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4418: <dd><p>This variable can be set to
                   4419:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4420:       (which is the default value), <code class="literal">pax</code>, or an
                   4421:       absolute pathname pointing to the command with which tar
                   4422:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4423:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4424: </dl></div>
1.299     rillig   4425: <p>If the <code class="filename">extract</code> program doesn't
                   4426:     serve your needs, you can also override the
                   4427:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4428:     command used for extracting the files. This command is
                   4429:     executed in the <code class="filename">${WRKSRC}</code>
                   4430:     directory. During execution of this command, the shell
                   4431:     variable <code class="varname">extract_file</code> holds the absolute
                   4432:     pathname of the file that is going to be extracted.</p>
                   4433: <p>And if that still does not suffice, you can override the
                   4434:     <code class="varname">do-extract</code> target in the package
                   4435:     Makefile.</p>
1.75      rillig   4436: </div>
1.148     asau     4437: <div class="sect1">
1.75      rillig   4438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4439: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4440: <p>After extraction, all the patches named by the
                   4441:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4442:     subdirectory of the package as well as in
                   4443:     $LOCALPATCHES/$PKGPATH (e.g.
                   4444:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4445:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4446:     <code class="filename">.gz</code> are uncompressed before they are
                   4447:     applied, files ending in <code class="filename">.orig</code> or
                   4448:     <code class="filename">.rej</code> are ignored. Any special options to
1.322     leot     4449:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299     rillig   4450:     <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.322     leot     4451: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4452:     fail if the expected text from the patch context is not found in the
                   4453:     patched file. If that happens, fix the patch file by comparing it
                   4454:     with the actual text in the file to be patched.</p>
1.78      rillig   4455: </div>
1.148     asau     4456: <div class="sect1">
1.75      rillig   4457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4458: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4459: <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>.
                   4460:     </p>
1.75      rillig   4461: </div>
1.148     asau     4462: <div class="sect1">
1.75      rillig   4463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4464: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4465: <p>This phase creates wrapper programs for the compilers and
                   4466:     linkers. The following variables can be used to tweak the
                   4467:     wrappers.</p>
                   4468: <div class="variablelist"><dl class="variablelist">
                   4469: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4470: <dd><p>The command used to print progress
                   4471:       messages. Does nothing by default. Set to
                   4472:       <code class="literal">${ECHO}</code> to see the progress
                   4473:       messages.</p></dd>
                   4474: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4475: <dd><p>This variable can be set to
                   4476:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4477:       depending on whether you want additional information in the
                   4478:       wrapper log file.</p></dd>
                   4479: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4480: <dd><p>This variable can be set to
                   4481:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4482:       on whether the wrapper should use its cache, which will
                   4483:       improve the speed. The default value is
                   4484:       <code class="literal">yes</code>, but is forced to
                   4485:       <code class="literal">no</code> if the platform does not support
                   4486:       it.</p></dd>
                   4487: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4488: <dd><p>A list of reordering commands. A reordering
                   4489:       command has the form
                   4490:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4491:       It ensures that that
                   4492:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4493:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4494:       </p></dd>
                   4495: </dl></div>
                   4496: </div>
                   4497: <div class="sect1">
                   4498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4499: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4500: <p>Most pieces of software need information on the header
                   4501:     files, system calls, and library routines which are available
                   4502:     on the platform they run on. The process of determining this
                   4503:     information is known as configuration, and is usually
                   4504:     automated. In most cases, a script is supplied with the
                   4505:     distfiles, and its invocation results in generation of header
                   4506:     files, Makefiles, etc.</p>
                   4507: <p>If the package contains a configure script, this can be
                   4508:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4509:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4510:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301     rillig   4511:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4512: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4513:     equivalent of the following command is run. See
                   4514:     <code class="filename">mk/configure/configure.mk</code>, target
                   4515:     <code class="literal">do-configure-script</code> for the exact
                   4516:     definition.</p>
                   4517: <pre class="programlisting">
                   4518: .for dir in ${CONFIGURE_DIRS}
                   4519:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4520:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4521:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4522: .endfor
1.100     rillig   4523: </pre>
1.299     rillig   4524: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4525:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4526:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4527:     configure script is run with the environment
                   4528:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4529:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4530:     <code class="varname">CONFIGURE_ENV</code>,
                   4531:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4532:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4533:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4534:     package.</p>
                   4535: <p>If the program uses the Perl way of configuration (mainly Perl
                   4536:     modules, but not only), i.e. a file called
                   4537:     <code class="filename">Makefile.PL</code>, it should include
                   4538:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4539:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4540:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4541: <p>If the program uses an <code class="filename">Imakefile</code>
                   4542:     for configuration, the appropriate steps can be invoked by
                   4543:     setting <code class="varname">USE_IMAKE</code> to
                   4544:     <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>.
                   4545:     You can add variables to xmkmf's environment by adding them to the
                   4546:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4547: <p>If the program uses <code class="filename">cmake</code>
                   4548:     for configuration, the appropriate steps can be invoked by
                   4549:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4550:     You can add variables to cmake's environment by adding them to the
                   4551:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4552:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4553:     The top directory argument is given by the
                   4554:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4555:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4556: <p>If there is no configure step at all, set
                   4557:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4558: </div>
1.148     asau     4559: <div class="sect1">
1.75      rillig   4560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4561: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4562: <p>For building a package, a rough equivalent of the following
                   4563:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4564:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4565: <pre class="programlisting">
1.301     rillig   4566: .for dir in ${BUILD_DIRS}
                   4567:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4568:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4569:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4570:                 -f ${MAKE_FILE} \
                   4571:                 ${BUILD_TARGET}
                   4572: .endfor
1.97      rillig   4573: </pre>
1.299     rillig   4574: <p><code class="varname">BUILD_DIRS</code> (default:
                   4575:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4576:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4577:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4578:     <code class="varname">MAKE_ENV</code> and arguments
                   4579:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4580:     <code class="varname">MAKE_ENV</code>,
                   4581:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4582:     <code class="varname">MAKE_FILE</code> and
                   4583:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4584:     package.</p>
                   4585: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4586:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4587:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4588:     default value of <code class="varname">MAKE_FILE</code> is
                   4589:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4590:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4591: <p>If there is no build step at all, set
                   4592:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4593: </div>
1.148     asau     4594: <div class="sect1">
1.97      rillig   4595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4596: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4597: <p>[TODO]</p>
1.75      rillig   4598: </div>
1.148     asau     4599: <div class="sect1">
1.75      rillig   4600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4601: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4602: <p>Once the build stage has completed, the final step is to
                   4603:     install the software in public directories, so users can
                   4604:     access the programs and files.</p>
1.301     rillig   4605: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4606:     of the following code is executed; see
                   4607:     <code class="filename">mk/install/install.mk</code>, target
                   4608:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4609:     before and after this code, several consistency checks are run
                   4610:     against the files-to-be-installed, see
                   4611:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4612: <pre class="programlisting">
                   4613: .for dir in ${INSTALL_DIRS}
                   4614:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4615:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4616:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4617:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4618: .endfor
1.220     wiz      4619: </pre>
1.299     rillig   4620: <p>The variable's meanings are analogous to the ones in the
                   4621:     <span class="emphasis"><em>build</em></span> phase.
                   4622:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4623:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4624:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4625:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4626:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4627:     defined.</p>
                   4628: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4629:     variables are useful. They are all variations of the
1.322     leot     4630:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4631:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4632:     install command. The specialized variants, together with their
                   4633:     intended use, are:</p>
                   4634: <div class="variablelist"><dl class="variablelist">
                   4635: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4636: <dd><p>directories that contain
                   4637:       binaries</p></dd>
                   4638: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4639: <dd><p>directories that contain
                   4640:       scripts</p></dd>
                   4641: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4642: <dd><p>directories that contain shared and static
                   4643:       libraries</p></dd>
                   4644: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4645: <dd><p>directories that contain data
                   4646:       files</p></dd>
                   4647: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4648: <dd><p>directories that contain man
                   4649:       pages</p></dd>
                   4650: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4651: <dd><p>directories that contain data files for games
                   4652:       </p></dd>
                   4653: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4654: <dd><p>binaries that can be stripped from debugging
                   4655:       symbols</p></dd>
                   4656: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4657: <dd><p>binaries that cannot be
                   4658:       stripped</p></dd>
                   4659: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4660: <dd><p>game
                   4661:       binaries</p></dd>
                   4662: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4663: <dd><p>shared and static
                   4664:       libraries</p></dd>
                   4665: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4666: <dd><p>data files</p></dd>
                   4667: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4668: <dd><p>data files for
                   4669:       games</p></dd>
                   4670: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4671: <dd><p>man pages</p></dd>
                   4672: </dl></div>
                   4673: <p>Some other variables are:</p>
                   4674: <div class="variablelist"><dl class="variablelist">
                   4675: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.322     leot     4676: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4677:       when installing binaries. Any debugging sections and symbols present in
                   4678:       binaries will be preserved.
                   4679:       </p></dd>
                   4680: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4681: <dd><p>A list of directories relative to
                   4682:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4683:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4684:       The package is supposed to create all needed directories itself
                   4685:       before installing files to it and list all other directories here.
                   4686:       </p></dd>
                   4687: </dl></div>
                   4688: <p>In the rare cases that a package shouldn't install anything,
                   4689:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4690:     mostly relevant for packages in the <code class="filename">regress</code>
                   4691:     category.</p>
1.75      rillig   4692: </div>
1.148     asau     4693: <div class="sect1">
1.75      rillig   4694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4695: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4696: <p>Once the install stage has completed, a binary package of
                   4697:     the installed files can be built.  These binary packages can be
                   4698:     used for quick installation without previous compilation, e.g. by
                   4699:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4700:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4701: <p>By default, the binary packages are created in
                   4702:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4703:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4704:     one for each category in the <code class="varname">CATEGORIES</code>
                   4705:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4706:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4707: </div>
1.148     asau     4708: <div class="sect1">
1.75      rillig   4709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4710: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4711: <p>Once you're finished with a package, you can clean the work
                   4712:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4713:     to clean the work directories of all dependencies too, use
                   4714:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4715: </div>
1.148     asau     4716: <div class="sect1">
1.75      rillig   4717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4718: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4719: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4720: <dt><span class="term">pre/post-*</span></dt>
                   4721: <dd>
                   4722: <p>For any of the main targets described in the previous
                   4723:          section (configure, build, install, etc.), two auxiliary
                   4724:          targets exist with
                   4725:          <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
                   4726:          prefix for the main target's name.  These targets are
                   4727:          invoked before and after the main target is called,
                   4728:          allowing extra configuration or installation steps be
                   4729:          performed from a package's Makefile, for example, which
                   4730:          a program's configure script or install target
                   4731:          omitted.</p>
                   4732: <p>About 5% of the pkgsrc packages define their custom
                   4733:          post-extract target, another 5% define pre-configure, and 10%
                   4734:          define post-install. The other pre/post-* targets are defined
                   4735:          even less often.</p>
                   4736: </dd>
                   4737: <dt><span class="term">do-*</span></dt>
1.75      rillig   4738: <dd>
1.299     rillig   4739: <p>Should one of the main targets do the wrong thing,
                   4740:          and should there be no variable to fix this, you can
                   4741:          redefine it with the do-* target.  (Note that redefining
                   4742:          the target itself instead of the do-* target is a bad
                   4743:          idea, as the pre-* and post-* targets won't be called
                   4744:          anymore, etc.)</p>
                   4745: <p>About 15% of the pkgsrc packages override the default
                   4746:          do-install, the other do-* targets are overridden even less
                   4747:          often.</p>
1.75      rillig   4748: </dd>
1.299     rillig   4749: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4750: <dd>
1.299     rillig   4751: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4752:          you noticed some file was not installed properly, you
                   4753:          can repeat the installation with this target, which will
                   4754:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4755: <p>This is the default value of
                   4756:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4757:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4758:          package</strong></span>, where the defaults are
                   4759:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4760:          respectively.</p>
1.75      rillig   4761: </dd>
1.299     rillig   4762: <dt><span class="term">deinstall</span></dt>
                   4763: <dd>
1.322     leot     4764: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4765:          current directory, effectively de-installing the
                   4766:          package. The following variables can be used to tune the
                   4767:          behaviour:</p>
                   4768: <div class="variablelist"><dl class="variablelist">
                   4769: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.322     leot     4770: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4771: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4772: <dd><p>Remove all packages that require (depend on)
                   4773:                the given package.  This can be used to remove any
                   4774:                packages that may have been pulled in by a given
                   4775:                package, e.g. if <span class="command"><strong>make deinstall
                   4776:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4777:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4778:                likely to remove whole KDE. Works by adding
1.322     leot     4779:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   4780:                command line.</p></dd>
                   4781: </dl></div>
                   4782: </dd>
                   4783: <dt><span class="term">bin-install</span></dt>
                   4784: <dd><p>Install a binary package from local disk and via FTP
                   4785:          from a list of sites (see the
                   4786:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4787:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4788:          available anywhere.  The arguments given to
                   4789:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4790:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4791:          operation, etc.</p></dd>
                   4792: <dt><span class="term">install-clean</span></dt>
                   4793: <dd><p>This target removes the state files for the "install" and later
                   4794:          phases so that the "install" target may be re-invoked. This can be
                   4795:          used after editing the PLIST to install the package without
                   4796:          rebuilding it.</p></dd>
                   4797: <dt><span class="term">build-clean</span></dt>
                   4798: <dd><p>This target removes the state files for the "build" and later
                   4799:          phases so that the "build" target may be re-invoked.</p></dd>
                   4800: <dt><span class="term">update</span></dt>
                   4801: <dd>
                   4802: <p>This target causes the current package to be
                   4803:          updated to the latest version.  The package and all
                   4804:          depending packages first get de-installed, then current
                   4805:          versions of the corresponding packages get compiled and
                   4806:          installed.  This is similar to manually noting which
                   4807:          packages are currently installed, then performing a
                   4808:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4809:          <span class="command"><strong>make install</strong></span> (or whatever
                   4810:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4811:          packages.</p>
                   4812: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4813:          resume package updating in case a previous <span class="command"><strong>make
                   4814:          update</strong></span> was interrupted for some reason.
                   4815:          However, in this case, make sure you don't call
                   4816:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4817:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4818:          Otherwise, you lose the ability to automatically update
                   4819:          the current package along with the dependent packages
                   4820:          you have installed.</p>
                   4821: <p>Resuming an interrupted <span class="command"><strong>make
                   4822:          update</strong></span> will only work as long as the package
                   4823:          tree remains unchanged.  If the source code for one of
                   4824:          the packages to be updated has been changed, resuming
                   4825:          <span class="command"><strong>make update</strong></span> will most certainly
                   4826:          fail!</p>
                   4827: <p>The following variables can be used either on the
                   4828:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4829:          alter the behaviour of <span class="command"><strong>make
                   4830:          update</strong></span>:</p>
                   4831: <div class="variablelist"><dl class="variablelist">
                   4832: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4833: <dd><p>Install target to recursively use for the
                   4834:                updated package and the dependent packages.
                   4835:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4836:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4837:                <span class="command"><strong>make update</strong></span>.  Other good
                   4838:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4839:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4840:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4841:                endless loop!</p></dd>
                   4842: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4843: <dd><p>Don't clean up after updating.  Useful if
                   4844:                you want to leave the work sources of the updated
                   4845:                packages around for inspection or other purposes.
                   4846:                Be sure you eventually clean up the source tree
                   4847:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4848:                or you may run into troubles with old source code
                   4849:                still lying around on your next
                   4850:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4851:                update</strong></span>.</p></dd>
                   4852: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4853: <dd><p>Deinstall each package before installing
                   4854:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4855:                may be necessary if the
                   4856:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4857:                called after interrupting a running <span class="command"><strong>make
                   4858:                update</strong></span>.</p></dd>
                   4859: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4860: <dd><p>Allows you to disable recursion and hardcode
                   4861:                the target for packages.  The default is
                   4862:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4863:                facilitating a recursive update of prerequisite
                   4864:                packages.  Only set
                   4865:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4866:                disable recursive updates. Use
                   4867:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4868:                set a specific target for each package to be
                   4869:                installed during <span class="command"><strong>make update</strong></span>
                   4870:                (see above).</p></dd>
                   4871: </dl></div>
                   4872: </dd>
                   4873: <dt><span class="term">clean-update</span></dt>
                   4874: <dd>
                   4875: <p>Clean the source tree for all packages that would
                   4876:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4877:          from the current directory.  This target should not be
                   4878:          used if the current package (or any of its depending
                   4879:          packages) have already been de-installed (e.g., after
                   4880:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4881:          some packages you intended to update. As a rule of
                   4882:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4883:          the first time you run <span class="command"><strong>make update</strong></span>
                   4884:          and only if you have a dirty package tree (e.g., if you
                   4885:          used <code class="varname">NOCLEAN</code>).</p>
                   4886: <p>If you are unsure about whether your tree is
                   4887:          clean, you can either perform a <span class="command"><strong>make
                   4888:          clean</strong></span> at the top of the tree, or use the
                   4889:          following sequence of commands from the directory of the
                   4890:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4891:          running <span class="command"><strong>make update</strong></span> for the first
                   4892:          time, otherwise you lose all the packages you wanted to
                   4893:          update!):</p>
                   4894: <pre class="screen">
                   4895: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4896: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4897: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4898:          </pre>
                   4899: <p>The following variables can be used either on the
                   4900:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4901:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4902: <div class="variablelist"><dl class="variablelist">
                   4903: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4904: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4905:                reconstruct the list of directories to update for
                   4906:                this package.  Only use this if <span class="command"><strong>make
                   4907:                update</strong></span> successfully installed all
                   4908:                packages you wanted to update.  Normally, this is
                   4909:                done automatically on <span class="command"><strong>make
                   4910:                update</strong></span>, but may have been suppressed by
                   4911:                the <code class="varname">NOCLEAN</code> variable (see
                   4912:                above).</p></dd>
                   4913: </dl></div>
                   4914: </dd>
                   4915: <dt><span class="term">replace</span></dt>
                   4916: <dd>
                   4917: <p>Update the installation of the current package.  This
                   4918:          differs from update in that it does not replace dependent
1.322     leot     4919:          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   4920:          target to work.</p>
                   4921: <p><span class="emphasis"><em>Be careful when using this
                   4922:          target!</em></span> There are no guarantees that dependent
                   4923:          packages will still work, in particular they will most
                   4924:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4925:          library package whose shared library major version changed
                   4926:          between your installed version and the new one.  For this
                   4927:          reason, this target is not officially supported and only
                   4928:          recommended for advanced users.</p>
                   4929: </dd>
                   4930: <dt><span class="term">info</span></dt>
1.322     leot     4931: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   4932:          package. You can use this to check which version of a
                   4933:          package is installed.</p></dd>
                   4934: <dt><span class="term">index</span></dt>
                   4935: <dd>
                   4936: <p>This is a top-level command, i.e. it should be used in
                   4937:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4938:          database of all packages in the local pkgsrc tree, including
                   4939:          dependencies, comment, maintainer, and some other useful
                   4940:          information.  Individual entries are created by running
                   4941:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4942:          directories.  This index file is saved as
                   4943:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4944:          verbose format by running <span class="command"><strong>make
                   4945:          print-index</strong></span>.  You can search in it with
                   4946:          <span class="command"><strong>make search
                   4947:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4948:          extract a list of all packages that depend on a particular
                   4949:          one by running <span class="command"><strong>make show-deps
                   4950:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4951: <p>Running this command takes a very long time, some
                   4952:          hours even on fast machines!</p>
                   4953: </dd>
                   4954: <dt><span class="term">readme</span></dt>
                   4955: <dd>
                   4956: <p>This target generates a
1.314     nia      4957:          <code class="filename">index.html</code> file, which can be
1.322     leot     4958:          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   4959:          contain references to any packages which are in the
                   4960:          <code class="varname">PACKAGES</code> directory on the local
                   4961:          host. The generated files can be made to refer to URLs
                   4962:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4963:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      4964:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   4965:          files which pointed to binary packages on the local
                   4966:          machine, in the directory
                   4967:          <code class="filename">/usr/packages</code>, set
                   4968:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4969:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4970:          <code class="varname">${PACKAGES}</code> directory and its
                   4971:          subdirectories will be searched for all the binary
                   4972:          packages.</p>
                   4973: <p>The target can be run at the toplevel or in category
                   4974:          directories, in which case it descends recursively.</p>
                   4975: </dd>
                   4976: <dt><span class="term">readme-all</span></dt>
                   4977: <dd><p>This is a top-level command, run it in
                   4978:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4979:          file <code class="filename">README-all.html</code> which contains a
                   4980:          list of all packages currently available in the NetBSD
                   4981:          Packages Collection, together with the category they belong
                   4982:          to and a short description. This file is compiled from the
1.314     nia      4983:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   4984:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4985:          readme</strong></span>.</p></dd>
                   4986: <dt><span class="term">cdrom-readme</span></dt>
                   4987: <dd><p>This is very much the same as the
                   4988:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   4989:          used when generating a pkgsrc tree to be written to a
                   4990:          CD-ROM.  This target also produces
1.314     nia      4991:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   4992:          to refer to URLs based on
                   4993:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   4994:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   4995: <dt><span class="term">show-distfiles</span></dt>
                   4996: <dd><p>This target shows which distfiles and patchfiles
                   4997:          are needed to build the package
                   4998:          (<code class="varname">ALLFILES</code>, which contains all
                   4999:          <code class="varname">DISTFILES</code> and
                   5000:          <code class="varname">PATCHFILES</code>, but not
                   5001:          <code class="filename">patches/*</code>).</p></dd>
                   5002: <dt><span class="term">show-downlevel</span></dt>
                   5003: <dd><p>This target shows nothing if the package is not
                   5004:          installed. If a version of this package is installed,
                   5005:          but is not the version provided in this version of
                   5006:          pkgsrc, then a warning message is displayed. This target
                   5007:          can be used to show which of your installed packages are
                   5008:          downlevel, and so the old versions can be deleted, and
                   5009:          the current ones added.</p></dd>
                   5010: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5011: <dd><p>This target shows the directory in the pkgsrc
                   5012:          hierarchy from which the package can be built and
                   5013:          installed. This may not be the same directory as the one
                   5014:          from which the package was installed. This target is
                   5015:          intended to be used by people who may wish to upgrade
                   5016:          many packages on a single host, and can be invoked from
                   5017:          the top-level pkgsrc Makefile by using the
                   5018:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   5019: <dt><span class="term">show-installed-depends</span></dt>
                   5020: <dd><p>This target shows which installed packages match
                   5021:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5022:          if out of date dependencies are causing build
                   5023:          problems.</p></dd>
                   5024: <dt><span class="term">print-build-depends-list</span></dt>
                   5025: <dd><p>This target shows the list of packages that the current package
                   5026:            depends on for building.</p></dd>
                   5027: <dt><span class="term">print-run-depends-list</span></dt>
                   5028: <dd><p>This target shows the list of packages that the current package
                   5029:            depends on for running.</p></dd>
                   5030: <dt><span class="term">check-shlibs</span></dt>
                   5031: <dd><p>After a package is installed, check all its
                   5032:          binaries and (on ELF platforms) shared libraries to see
                   5033:          if they find the shared libs they need.  Run by default
                   5034:          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>
                   5035: <dt><span class="term">print-PLIST</span></dt>
                   5036: <dd>
                   5037: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5038:          upgraded pkg, this prints out an attempt to generate a
                   5039:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5040:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5041:          to care for shared libs etc., but it is
                   5042:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5043:          result before putting it into
                   5044:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5045:          diff the output of this command against an already
                   5046:          existing <code class="filename">PLIST</code> file.</p>
1.322     leot     5047: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5048:          other methods that don't update file access times, be
                   5049:          sure to add these files manually to your
                   5050:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5051:          -newer</span>&#8221;</span> command used by this target won't catch
                   5052:          them!</p>
                   5053: <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
                   5054:          information on this target.</p>
                   5055: </dd>
                   5056: </dl></div>
                   5057: </div>
                   5058: </div>
                   5059: <div class="chapter">
                   5060: <div class="titlepage"><div><div><h2 class="title">
                   5061: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5062: <div class="toc">
                   5063: <p><b>Table of Contents</b></p>
                   5064: <dl class="toc">
                   5065: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5066: <dd><dl>
1.334   ! nia      5067: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
        !          5068: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
        !          5069: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299     rillig   5070: </dl></dd>
                   5071: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5072: <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>
                   5073: </dl>
                   5074: </div>
                   5075: <p>When you find a package that is not yet in pkgsrc, you
                   5076: most likely have a URL from where you can download the source
                   5077: code. Starting with this URL, creating a package involves only a
                   5078: few steps.</p>
                   5079: <div class="procedure"><ol class="procedure" type="1">
                   5080: <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
                   5081: enable the basic quality checks.</p></li>
                   5082: <li class="step">
1.322     leot     5083: <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   5084: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5085: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5086: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5087: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5088: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5089: </li>
                   5090: <li class="step">
                   5091: <p>Choose one of the top-level directories as the category in
                   5092: which you want to place your package. You can also create a directory of
1.334   ! nia      5093: your own (maybe called <code class="filename">local</code>). Change into that
        !          5094: category directory:</p>
        !          5095: <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   5096: </li>
                   5097: <li class="step">
1.334   ! nia      5098: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
        !          5099: argument the URL of the distribution file (in most cases a
        !          5100: <code class="filename">.tar.gz</code> file). This will download the distribution
        !          5101: file and create the necessary files of the package, based on what's in
        !          5102: the distribution file:</p>
1.299     rillig   5103: <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>
                   5104: </li>
                   5105: <li class="step">
                   5106: <p>Examine the extracted files to determine the dependencies of
                   5107: your package. Ideally, this is mentioned in some
                   5108: <code class="filename">README</code> file, but things may differ. For each of
                   5109: these dependencies, look where it exists in pkgsrc, and if there is a
                   5110: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5111: line to your package <code class="filename">Makefile</code> which includes that
                   5112: file just before the last line. If the
                   5113: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5114: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5115: that the package's include files and libraries are provided.</p>
1.334   ! nia      5116: <p>If you just need binaries from a dependent package, add a
1.299     rillig   5117: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5118: version of the dependency and where it can be found in pkgsrc. This line
                   5119: should be placed in the third paragraph. If the dependency is only
                   5120: needed for building the package, but not when using it, use
                   5121: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5122: instead of <code class="varname">DEPENDS</code>.
                   5123: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5124: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5125: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334   ! nia      5126: packages, i.e. packages for the platform where the package is built;
1.299     rillig   5127: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334   ! nia      5128: packages, i.e. packages for the platform for which the package
        !          5129: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
        !          5130: specifies a dependency used only for testing the resulting package
        !          5131: built, using the upstream project's included test suite, on the native
        !          5132: platform.
1.299     rillig   5133: Your package may then look like this:</p>
                   5134: <pre class="programlisting">
                   5135: [...]
                   5136: 
                   5137: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5138: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5139: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5140: 
                   5141: [...]
                   5142: 
                   5143: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5144: .include "../../devel/glib2/buildlink3.mk"
                   5145: .include "../../mk/bsd.pkg.mk"
                   5146: </pre>
                   5147: </li>
                   5148: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5149: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5150: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5151: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5152: additional explanations.</p></li>
                   5153: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5154: 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
                   5155: over there, you can hopefully continue here.</p></li>
                   5156: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5157: directory from the extracted files. Besides these files, a lot of cache
1.334   ! nia      5158: files and other system information have been saved in the working
        !          5159: directory, which may have become outdated after you edited the
1.299     rillig   5160: <code class="filename">Makefile</code>.</p></li>
                   5161: <li class="step">
                   5162: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5163: 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      5164: <p>If the extracted files from the package need to be fixed, run
        !          5165: multiple rounds of these commands:</p>
        !          5166: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299     rillig   5167: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5168: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334   ! nia      5169: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
        !          5170: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299     rillig   5171: </li>
                   5172: <li class="step"><p>When the package builds fine, the next step is to install
                   5173: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5174: everything works.</p></li>
                   5175: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5176: contains a list of the files that are installed by the package, is
                   5177: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5178: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5179: the file using your preferred text editor to see if the list of
                   5180: files looks plausible.</p></li>
                   5181: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5182: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5183: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5184: had been registered in the database of installed files, but with an
                   5185: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5186: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5187: registered with the list of files from
                   5188: <code class="filename">PLIST</code>.</p></li>
                   5189: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5190: from above again in a single step, making sure that the PLIST is correct
                   5191: and the whole package is created as intended.</p></li>
1.334   ! nia      5192: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
        !          5193: left to do.</p></li>
1.299     rillig   5194: <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>
                   5195: </ol></div>
                   5196: <div class="sect1">
                   5197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5198: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5199: <div class="sect2">
                   5200: <div class="titlepage"><div><div><h3 class="title">
1.334   ! nia      5201: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299     rillig   5202: <p>Python modules and programs packages are easily created using a
                   5203: set of predefined variables.</p>
                   5204: <p>
                   5205: If some Python versions are not supported by the software, set the
                   5206: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5207: that are not supported, e.g.
                   5208: </p>
                   5209: <pre class="programlisting">
                   5210: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5211: </pre>
                   5212: <p>
                   5213: If the packaged software is a Python module, include one of
1.330     wiz      5214: <code class="filename">../../lang/python/egg.mk</code> or
1.299     rillig   5215: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.330     wiz      5216: <p>Most Python packages use setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
1.299     rillig   5217: If the packaged software is using setuptools, you only need
                   5218: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
1.330     wiz      5219: </p>
1.299     rillig   5220: <p>Either way, the package directory should be called
                   5221: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5222: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5223: </p>
                   5224: <pre class="programlisting">
                   5225: DISTNAME=   foopymodule-1.2.10
                   5226: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5227: </pre>
                   5228: <p>If it is an application, include
                   5229: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5230: In order to correctly set the path to the Python interpreter, use the
                   5231: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5232: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5233: For example:
                   5234: </p>
                   5235: <pre class="programlisting">
                   5236: REPLACE_PYTHON=   *.py
                   5237: </pre>
                   5238: <p>Some Python modules have separate distributions for Python-2.x
                   5239: and Python-3.x support. In pkgsrc this is handled by the
                   5240: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5241: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5242: packages that should be depended upon and include
                   5243: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5244: then the pkgsrc infrastructure will depend on the appropriate package
                   5245: version. For example:
                   5246: </p>
                   5247: <pre class="programlisting">
                   5248: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5249: </pre>
                   5250: <p>
                   5251: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5252: of supported packages.</p>
                   5253: </div>
                   5254: <div class="sect2">
                   5255: <div class="titlepage"><div><div><h3 class="title">
1.334   ! nia      5256: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299     rillig   5257: <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>
                   5258: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322     leot     5259: 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   5260: Individual packages (and optionally their dependencies) may be created
                   5261: and updated.  R packages generally follow the same form, and most of
                   5262: the relevant information needed is contained in a
                   5263: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5264: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5265: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5266: creates or updates a package in the canonical form.  The resulting
                   5267: package should be reviewed for correctness.</p>
                   5268: </div>
                   5269: <div class="sect2">
                   5270: <div class="titlepage"><div><div><h3 class="title">
1.334   ! nia      5271: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299     rillig   5272: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322     leot     5273: <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   5274: <p>If the TeXlive package name is not known, it may be useful to
                   5275: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5276: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5277: 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
                   5278: archive</a>.</p>
                   5279: <p>If the TeXlive package name is known, download the files from
                   5280: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5281: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5282: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5283: also have associated documentation packages, so download
                   5284: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5285: should be placed in the appropriate category directory, which is often
                   5286: but not always <code class="filename">print</code>.  Then run the following
                   5287: command in the category directory.</p>
                   5288: <pre class="programlisting">
                   5289: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5290: </pre>
                   5291: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5292: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5293: are correct.</p>
                   5294: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5295: currently does not include version information in package filenames
                   5296: and changes their contents periodically when updates occur.
                   5297: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5298: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5299: main one and the corresponding documentation, upload the distfiles
                   5300: with the following command in each package directory.</p>
                   5301: <pre class="programlisting">
                   5302: make upload-distfiles
                   5303: </pre>
                   5304: </div>
                   5305: </div>
                   5306: <div class="sect1">
                   5307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5308: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5309: <div class="sect2">
                   5310: <div class="titlepage"><div><div><h3 class="title">
                   5311: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5312: <div class="sect3">
                   5313: <div class="titlepage"><div><div><h4 class="title">
                   5314: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5315: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5316: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5317: pkgsrc. As the description says it has to do with the web, the obvious
                   5318: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5319: <pre class="programlisting">
                   5320: <code class="prompt">$</code> mkdir www/nvu
                   5321: <code class="prompt">$</code> cd www/nvu
                   5322: </pre>
                   5323: <p>The web site says that the sources are available as a tar file, so
                   5324: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5325: <pre class="programlisting">
                   5326: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5327: </pre>
                   5328: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5329: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5330: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5331: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5332: <code class="varname">COMMENT</code> fields. Then the package
                   5333: <code class="filename">Makefile</code> looked like that:</p>
                   5334: <pre class="programlisting">
                   5335: # $NetBSD $
                   5336: #
                   5337: 
                   5338: DISTNAME=       nvu-1.0-sources
                   5339: PKGNAME=        nvu-1.0
                   5340: CATEGORIES=     www
                   5341: MASTER_SITES=   http://cvs.nvu.com/download/
                   5342: EXTRACT_SUFX=   .tar.bz2
                   5343: 
                   5344: MAINTAINER=     rillig@NetBSD.org
                   5345: HOMEPAGE=       http://cvs.nvu.com/
                   5346: COMMENT=        Web Authoring System
                   5347: 
                   5348: # url2pkg-marker (please do not remove this line.)
                   5349: .include "../../mk/bsd.pkg.mk"
                   5350: </pre>
                   5351: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5352: this is a workaround to prevent CVS expanding to the filename of the
                   5353: guide.</p>
                   5354: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5355: source archive:</p>
                   5356: <pre class="programlisting">
                   5357: url2pkg&gt; Running "make makesum" ...
                   5358: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5359: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5360: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5361: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5362: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5363: url2pkg&gt; Running "make extract" ...
                   5364: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5365: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5366: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5367: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5368: ===&gt; Installing dependencies for nvu-1.0
                   5369: ===&gt; Overriding tools for nvu-1.0
                   5370: ===&gt; Extracting for nvu-1.0
                   5371: url2pkg&gt; Adjusting the Makefile.
                   5372: 
                   5373: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5374: 
                   5375: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5376: </pre>
                   5377: </div>
                   5378: <div class="sect3">
                   5379: <div class="titlepage"><div><div><h4 class="title">
                   5380: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5381: <p>Now that the package has been extracted, let's see what's inside
                   5382: it. The package has a <code class="filename">README.txt</code>, but that only
                   5383: says something about mozilla, so it's probably useless for seeing what
                   5384: dependencies this package has. But since there is a GNU configure script
                   5385: in the package, let's hope that it will complain about everything it
                   5386: needs.</p>
                   5387: <pre class="programlisting">
                   5388: <code class="prompt">$</code> bmake
                   5389: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5390: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5391: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5392: ===&gt; Patching for nvu-1.0
                   5393: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5394: ===&gt; Configuring for nvu-1.0
                   5395: [...]
                   5396: configure: error: Perl 5.004 or higher is required.
                   5397: [...]
                   5398: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5399: [...]
                   5400: </pre>
                   5401: <p>That worked quite well. So I opened the package Makefile in my
                   5402: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5403: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5404: package have changed now, and since a perl wrapper is automatically
                   5405: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5406: from scratch.</p>
                   5407: <pre class="programlisting">
                   5408: <code class="prompt">$</code> bmake clean
                   5409: ===&gt; Cleaning for nvu-1.0
                   5410: <code class="prompt">$</code> bmake
                   5411: [...]
                   5412: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5413: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5414: [...]
                   5415: </pre>
                   5416: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5417: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5418: <pre class="programlisting">
                   5419: [...]
                   5420: checking for GTK - version &gt;= 1.2.0... no
                   5421: *** Could not run GTK test program, checking why...
                   5422: [...]
                   5423: </pre>
                   5424: <p>Now to the other dependencies. The first question is: Where is the
                   5425: GTK package hidden in pkgsrc?</p>
                   5426: <pre class="programlisting">
                   5427: <code class="prompt">$</code> echo ../../*/gtk*
                   5428: [many packages ...]
                   5429: <code class="prompt">$</code> echo ../../*/gtk
                   5430: ../../x11/gtk
                   5431: <code class="prompt">$</code> echo ../../*/gtk2
                   5432: ../../x11/gtk2
                   5433: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5434: ../../x11/gtk2/buildlink3.mk
                   5435: </pre>
                   5436: <p>The first try was definitely too broad. The second one had exactly
                   5437: one result, which is very good. But there is one pitfall with GNOME
                   5438: packages. Before GNOME 2 had been released, there were already many
                   5439: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5440: packages, the GNOME 2 packages were imported as separate packages, and
                   5441: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5442: whether this was the case here, and indeed it was.</p>
                   5443: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5444: file, adding the dependency is very easy. I just inserted an
                   5445: <code class="literal">.include</code> line before the last line of the package
                   5446: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5447: <pre class="programlisting">
                   5448: [...]
                   5449: .include "../../x11/gtk2/buildlink3.mk"
                   5450: .include "../../mk/bsd.pkg.mk
                   5451: </pre>
                   5452: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5453: was:</p>
1.75      rillig   5454: <pre class="programlisting">
1.299     rillig   5455: [...]
                   5456: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5457: checking for GTK - version &gt;= 1.2.0... no
                   5458: *** Could not run GTK test program, checking why...
                   5459: *** The test program failed to compile or link. See the file config.log for the
                   5460: *** exact error that occured. This usually means GTK was incorrectly installed
                   5461: *** or that you have moved GTK since it was installed. In the latter case, you
                   5462: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5463: configure: error: Test for GTK failed.
                   5464: [...]
1.222     sevan    5465: </pre>
1.299     rillig   5466: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5467: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5468: told me that this package really wanted to have the GNOME 1 version of
                   5469: GTK. If the package had looked for GTK2, it would have looked for
                   5470: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5471: So I changed the <code class="literal">x11/gtk2</code> to
                   5472: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5473: and tried again.</p>
1.119     mishka   5474: <pre class="programlisting">
1.299     rillig   5475: [...]
                   5476: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5477: In file included from xpidl.c:42:
                   5478: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5479: In file included from xpidl.c:42:
                   5480: xpidl.h:132: error: parse error before "IDL_ns"
                   5481: [...]
1.222     sevan    5482: </pre>
1.299     rillig   5483: <p>The package still does not find all of its dependencies. Now the
                   5484: question is: Which package provides the
                   5485: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5486: <pre class="programlisting">
1.299     rillig   5487: <code class="prompt">$</code> echo ../../*/*idl*
                   5488: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5489: <code class="prompt">$</code> echo ../../*/*IDL*
                   5490: ../../net/libIDL
1.222     sevan    5491: </pre>
1.299     rillig   5492: <p>Let's take the one from the second try. So I included the
                   5493: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5494: again. But the error didn't change. After digging through some of the
                   5495: code, I concluded that the build process of the package was broken and
                   5496: couldn't have ever worked, but since the Mozilla source tree is quite
                   5497: large, I didn't want to fix it. So I added the following to the package
                   5498: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5499: <pre class="programlisting">
1.299     rillig   5500: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5501: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5502: </pre>
1.299     rillig   5503: <p>The latter line is needed because the package expects the library
                   5504: <code class="filename">libIDL.so</code>, but only
                   5505: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5506: wrapper to rewrite that on the fly.</p>
                   5507: <p>The next problem was related to a recent change of the FreeType
1.322     leot     5508: 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   5509: which patch files were relevant for this issue and copied them to the
                   5510: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5511: patches so that they applied cleanly and retried again. This time,
                   5512: everything worked.</p>
1.197     wiz      5513: </div>
1.299     rillig   5514: <div class="sect3">
                   5515: <div class="titlepage"><div><div><h4 class="title">
                   5516: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5517: <pre class="programlisting">
1.299     rillig   5518: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5519: [...]
                   5520: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5521: <code class="prompt">$</code> bmake deinstall
                   5522: <code class="prompt">$</code> bmake install
1.222     sevan    5523: </pre>
1.299     rillig   5524: </div>
                   5525: </div>
1.75      rillig   5526: </div>
                   5527: </div>
1.148     asau     5528: <div class="chapter">
1.75      rillig   5529: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5530: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5531: <div class="toc">
                   5532: <p><b>Table of Contents</b></p>
1.210     leot     5533: <dl class="toc">
1.299     rillig   5534: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5535: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5536: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5537: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5538: <dd><dl>
                   5539: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5540: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5541: <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>
                   5542: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   5543: </dl></dd>
                   5544: </dl>
                   5545: </div>
1.299     rillig   5546: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5547:   each of which forms a well-defined part of the pkgsrc system. Using
1.322     leot     5548:   the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   5549:   like pkgsrc requires some discipline to keep the code correct and
                   5550:   understandable.</p>
                   5551: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5552:   programming are variables and shell
                   5553:   commands. Among these shell commands may even be more complex ones
1.322     leot     5554:   like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   5555:   as intended it is necessary to quote all variables correctly when they
                   5556:   are used.</p>
                   5557: <p>This chapter describes some patterns that appear quite often in
                   5558:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5559:   with them.</p>
1.148     asau     5560: <div class="sect1">
1.75      rillig   5561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5562: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5564: <p>When you are creating a file as a
                   5565:     target of a rule, always write the data to a temporary file first
                   5566:     and finally rename that file. Otherwise there might occur an error
                   5567:     in the middle of generating the file, and when the user runs
1.322     leot     5568:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   5569:     regenerated properly. Example:</p>
1.75      rillig   5570: <pre class="programlisting">
1.299     rillig   5571: wrong:
                   5572:         @echo "line 1" &gt; ${.TARGET}
                   5573:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5574:         @false
                   5575: 
                   5576: correct:
                   5577:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5578:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5579:         @false
                   5580:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5581: </pre>
1.299     rillig   5582: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5583:     <code class="filename">wrong</code> will exist, although there was an error
                   5584:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5585:     correct</strong></span> gives an error message twice, as expected.</p>
1.322     leot     5586: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5587:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5588:     happens when it is interrupted, for example by pressing
                   5589:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.322     leot     5590:     when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5591: </li></ul></div>
                   5592: </div>
                   5593: <div class="sect1">
                   5594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5595: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5596: <p><code class="filename">Makefile</code> variables contain strings that
                   5597:     can be processed using the five operators <code class="code">=</code>,
                   5598:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.322     leot     5599:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5600:     page.</p>
                   5601: <p>When a variable's value is parsed from a
                   5602:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5603:     the backslash character <code class="code">\</code> are handled specially. If a
                   5604:     backslash is the last character in a line, that backslash is removed
                   5605:     from the line and the line continues with the next line of the file.</p>
                   5606: <p>The <code class="code">#</code> character starts a comment that reaches
                   5607:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5608:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5609: <p>The evaluation of variables either happens immediately or lazy.
                   5610:     It happens immediately when the variable occurs on the right-hand
                   5611:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5612:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5613:     In the other cases, it is evaluated lazily.</p>
                   5614: <p>Some of the modifiers split the string into words and then
                   5615:     operate on the words, others operate on the string as a whole. When a
                   5616:     string is split into words, double quotes and single quotes are
1.322     leot     5617:     interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5618: <div class="sect2">
                   5619: <div class="titlepage"><div><div><h3 class="title">
                   5620: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5622: <li class="listitem"><p>All variable names starting with an underscore
                   5623:        are reserved for use by the pkgsrc infrastructure. They shall
                   5624:        not be used by packages.</p></li>
                   5625: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5626:        lowercase variable names for the iteration
                   5627:        variables.</p></li>
                   5628: <li class="listitem"><p>All list variables should have a plural name,
                   5629:        such as <code class="varname">PKG_OPTIONS</code> or
                   5630:        <code class="varname">DISTFILES</code>.</p></li>
                   5631: </ul></div>
                   5632: </div>
                   5633: </div>
                   5634: <div class="sect1">
                   5635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5636: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5637: <div class="sect2">
                   5638: <div class="titlepage"><div><div><h3 class="title">
                   5639: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5640: <p>When adding a string that possibly contains whitespace or quotes to
                   5641: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5642: modifier.</p>
                   5643: <p>When adding another list to a list (example 2), it must not be
                   5644: quoted, since its elements are already quoted.</p>
1.75      rillig   5645: <pre class="programlisting">
1.299     rillig   5646: STRING=         foo * bar `date`
                   5647: LIST=           # empty
                   5648: ANOTHER_LIST=   a=b c=d
                   5649: 
                   5650: LIST+=          ${STRING:Q}       # 1
                   5651: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5652: </pre>
1.299     rillig   5653: </div>
                   5654: <div class="sect2">
                   5655: <div class="titlepage"><div><div><h3 class="title">
                   5656: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5657: <p>Echoing a string containing special characters needs special
                   5658: work.</p>
1.75      rillig   5659: <pre class="programlisting">
1.299     rillig   5660: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5661: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5662: 
                   5663: all:
                   5664:         echo ${STRING}                  # 1
                   5665:         echo ${STRING:Q}                # 2
                   5666:         printf '%s\n' ${STRING:Q}''     # 3
                   5667:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5668: </pre>
1.299     rillig   5669: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5670: are just copied.</p>
                   5671: <p>Example 2 quotes the string so that the shell interprets it
                   5672: correctly. But the echo command may additionally interpret strings with a
                   5673: leading dash or those containing backslashes.</p>
1.322     leot     5674: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5675: interprets the format string, but not the next argument. The trailing
                   5676: single quotes handle the case when the string is empty. In that case, the
                   5677: :Q modifier would result in an empty string too, which would then be
1.322     leot     5678: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5679: but other programs may care.</p>
                   5680: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5681: need to be quoted because the quoting has already been done
                   5682: when adding elements to the list.</p>
1.75      rillig   5683: </div>
1.148     asau     5684: <div class="sect2">
1.75      rillig   5685: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5686: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5687: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5688: GNU-style configure script (especially those that call other configure
                   5689: scripts), it must not have leading or trailing whitespace, since
                   5690: otherwise the configure script gets confused. To trim leading and
                   5691: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5692: following example:</p>
1.75      rillig   5693: <pre class="programlisting">
1.299     rillig   5694: CPPFLAGS=               # empty
                   5695: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5696: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5697: 
1.299     rillig   5698: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5699: 
1.299     rillig   5700: all:
                   5701:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5702:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5703: </pre>
                   5704: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5705: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5706: space.</p>
                   5707: </div>
                   5708: <div class="sect2">
                   5709: <div class="titlepage"><div><div><h3 class="title">
                   5710: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5711: <p>When a possibly empty variable is used in a shell program, it may
                   5712: lead to a syntax error.</p>
                   5713: <pre class="programlisting">
                   5714: EGFILES=        # empty
1.87      wiz      5715: 
1.299     rillig   5716: install-examples:   # produces a syntax error in the shell
                   5717:         for egfile in ${EGFILES}; do            \
                   5718:                 echo "Installing $$egfile";     \
                   5719:         done
                   5720: </pre>
                   5721: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.322     leot     5722: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5723: To fix this syntax error, use one of the snippets below.</p>
                   5724: <pre class="programlisting">
                   5725: EMPTY=          # empty
1.87      wiz      5726: 
1.299     rillig   5727: install-examples:
                   5728:         for egfile in ${EGFILES} ""; do         \
                   5729:                 [ -n "$$egfile" ] || continue;  \
                   5730:                 echo "Installing $$egfile";     \
                   5731:         done
                   5732: </pre>
                   5733: <p>In this case, an empty string is appended to the iteration list (to
                   5734: prevent the syntax error) and filtered out later.</p>
                   5735: <pre class="programlisting">
                   5736: EGFILES=        # empty
1.87      wiz      5737: 
1.299     rillig   5738: install-examples:
                   5739: .for egfile in ${EGFILES}
                   5740:         echo "Installing ${egfile}"
                   5741: .endfor
1.100     rillig   5742: </pre>
1.299     rillig   5743: <p>If one of the filenames contains special characters, it should be
                   5744: enclosed in single or double quotes.</p>
                   5745: <p>To have a shell command test whether a make variable is empty, use
                   5746: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5747: </div>
                   5748: </div>
                   5749: </div>
                   5750: <div class="chapter">
                   5751: <div class="titlepage"><div><div><h2 class="title">
                   5752: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5753: <div class="toc">
                   5754: <p><b>Table of Contents</b></p>
                   5755: <dl class="toc">
                   5756: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5757: <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>
                   5758: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5759: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5760: </dl>
1.75      rillig   5761: </div>
1.299     rillig   5762: <p>Many packages have the ability to be built to support different
                   5763: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5764: in pkgsrc that provides generic handling of those options that
                   5765: determine different ways in which the packages can be built.  It's
                   5766: possible for the user to specify exactly which sets of options will be
                   5767: built into a package or to allow a set of global default options
                   5768: apply.</p>
                   5769: <p>There are two broad classes of behaviors that one might want to
                   5770: control via options.  One is whether some particular feature is
                   5771: enabled in a program that will be built anyway, often by including or
                   5772: not including a dependency on some other package.  The other is
                   5773: whether or not an additional program will be built as part of the
                   5774: package.  Generally, it is better to make a split package for such
                   5775: additional programs instead of using options, because it enables
                   5776: binary packages to be built which can then be added separately.  For
                   5777: example, the foo package might have minimal dependencies (those
                   5778: packages without which foo doesn't make sense), and then the foo-gfoo
                   5779: package might include the GTK frontend program gfoo.  This is better
                   5780: than including a gtk option to foo that adds gfoo, because either that
                   5781: option is default, in which case binary users can't get foo without
                   5782: gfoo, or not default, in which case they can't get gfoo.  With split
                   5783: packages, they can install foo without having GTK, and later decide to
                   5784: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5785: source users too, avoiding the need for rebuilds.</p>
                   5786: <p>Plugins with widely varying dependencies should usually be split
                   5787: instead of options.</p>
                   5788: <p>It is often more work to maintain split packages, especially if
                   5789: the upstream package does not support this.  The decision of split
                   5790: vs. option should be made based on the likelihood that users will want
                   5791: or object to the various pieces, the size of the dependencies that are
                   5792: included, and the amount of work.</p>
                   5793: <p>A further consideration is licensing.  Non-free parts, or parts
                   5794: that depend on non-free dependencies (especially plugins) should
                   5795: almost always be split if feasible.</p>
                   5796: <div class="sect1">
                   5797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5798: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5799: <p>Global default options are listed in
                   5800: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5801: that should be built into every package if that option is supported.
                   5802: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5803: </div>
1.148     asau     5804: <div class="sect1">
1.75      rillig   5805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5806: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5807: </h2></div></div></div>
                   5808: <p>The following example shows how
                   5809: <code class="filename">bsd.options.mk</code> should be used
                   5810: by the hypothetical ``wibble'' package, either in the package
                   5811: <code class="filename">Makefile</code>, or in a file,
                   5812: e.g. <code class="filename">options.mk</code>, that is included by the
                   5813: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5814: <pre class="programlisting">
1.299     rillig   5815: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5816: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5817: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5818: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5819: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5820: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5821: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5822: 
                   5823: .include "../../mk/bsd.prefs.mk"
                   5824: 
                   5825: # this package was previously named wibble2
                   5826: .if defined(PKG_OPTIONS.wibble2)
                   5827: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5828: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5829:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5830: .endif
                   5831: 
                   5832: .include "../../mk/bsd.options.mk"
                   5833: 
                   5834: # Package-specific option-handling
1.100     rillig   5835: 
1.299     rillig   5836: ###
                   5837: ### FOO support
                   5838: ###
                   5839: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5840: CONFIGURE_ARGS+=    --enable-foo
                   5841: .endif
1.100     rillig   5842: 
1.299     rillig   5843: ###
                   5844: ### LDAP support
                   5845: ###
                   5846: .if !empty(PKG_OPTIONS:Mldap)
                   5847: .  include "../../databases/openldap-client/buildlink3.mk"
                   5848: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5849: .endif
1.100     rillig   5850: 
1.299     rillig   5851: ###
                   5852: ### database support
                   5853: ###
                   5854: .if !empty(PKG_OPTIONS:Mmysql)
                   5855: .  include "../../mk/mysql.buildlink3.mk"
                   5856: .endif
                   5857: .if !empty(PKG_OPTIONS:Mpgsql)
                   5858: .  include "../../mk/pgsql.buildlink3.mk"
                   5859: .endif
                   5860: </pre>
                   5861: <p>The first section contains the information about which build
                   5862: options are supported by the package, and any default options settings
                   5863: if needed.</p>
                   5864: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5865: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.322     leot     5866: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   5867: options.  It should be set to
                   5868: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5869: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5870: at the point where the options are processed.</p></li>
                   5871: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5872: build options supported by the package.</p></li>
                   5873: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5874: list of names of groups of mutually exclusive options.  The options in
                   5875: each group are listed in
                   5876: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5877: The most specific setting of any option from the group takes
                   5878: precedence over all other options in the group.  Options from the
                   5879: groups will be automatically added to
                   5880: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5881: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5882: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5883: packages will fail if no option from the group is
                   5884: selected.</p></li>
                   5885: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5886: of names of sets of options.  At least one option from each set must
                   5887: be selected.  The options in each set are listed in
                   5888: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5889: Options from the sets will be automatically added to
                   5890: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5891: fail if no option from the set is selected.</p></li>
                   5892: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5893: build options which are enabled by default.</p></li>
                   5894: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5895: of
                   5896: <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>
                   5897: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5898: their option counterparts.  Pairs should be added with
                   5899: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5900: warning will be issued if the user uses a legacy
                   5901: variable.</p></li>
                   5902: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5903: of
                   5904: <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>
                   5905: pairs that map options that have been renamed to their new
                   5906: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5907: the listing of global legacy options.  A warning will be issued if
                   5908: the user uses a legacy option.</p></li>
                   5909: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5910: options implied by deprecated variables used.  This can be used for
                   5911: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5912: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5913: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5914: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5915: a list of warnings about deprecated variables or options used, and
                   5916: what to use instead.</p></li>
                   5917: </ol></div>
                   5918: <p>A package should never modify
                   5919: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5920: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5921: To suggest a default set of options, use
                   5922: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5923: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5924: including <code class="filename">bsd.options.mk</code>.  If none of
                   5925: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5926: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5927: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5928: happen with platform-specific options if none of them is supported on
                   5929: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5930: empty list and the package is otherwise treated as not using the
                   5931: options framework.</p>
                   5932: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5933: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5934: build options, properly filtered to remove unsupported and duplicate
                   5935: options.</p>
                   5936: <p>The remaining sections contain the logic that is specific to
                   5937: each option.  The correct way to check for an option is to check
                   5938: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5939: <pre class="programlisting">
                   5940: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   5941: </pre>
1.75      rillig   5942: </div>
1.299     rillig   5943: <div class="sect1">
                   5944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5945: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5946: <p>Options that enable similar features in different packages (like
                   5947: optional support for a library) should use a common name in all
                   5948: packages that support it (like the name of the library).  If another
                   5949: package already has an option with the same meaning, use the same
                   5950: name.</p>
                   5951: <p>Options that enable features specific to one package, where it's
                   5952: unlikely that another (unrelated) package has the same (or a similar)
                   5953: optional feature, should use a name prefixed with
                   5954: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5955: <p>If a group of related packages share an optional feature
                   5956: specific to that group, prefix it with the name of the
                   5957: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5958: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5959: <p>For new options, add a line to
                   5960: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5961: fields, separated by tab.  The first field is the option name, the
                   5962: second its description.  The description should be a whole sentence
                   5963: (starting with an uppercase letter and ending with a period) that
                   5964: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5965: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5966: </div>
                   5967: <div class="sect1">
                   5968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5969: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5970: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5971: different dependencies based on the options with which the package was
                   5972: built. For querying these options, the file
                   5973: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5974: typical example looks like this:</p>
1.87      wiz      5975: <pre class="programlisting">
1.299     rillig   5976: pkgbase := libpurple
                   5977: .include "../../mk/pkg-build-options.mk"
                   5978: 
                   5979: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5980: ...
                   5981: .endif
1.229     sevan    5982: </pre>
1.299     rillig   5983: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5984: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5985: options of the libpurple package, which can then be queried like
                   5986: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5987: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5988: details.</p>
1.75      rillig   5989: </div>
                   5990: </div>
1.148     asau     5991: <div class="chapter">
1.75      rillig   5992: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5993: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   5994: <div class="toc">
                   5995: <p><b>Table of Contents</b></p>
1.210     leot     5996: <dl class="toc">
1.299     rillig   5997: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   5998: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   5999: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6000: </dl>
                   6001: </div>
1.299     rillig   6002: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6003: by pkgsrc and also for individual packages to define what commands
                   6004: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6005: or for later run-time of an installed packaged (such as
                   6006: <code class="varname">DEPENDS</code>).
                   6007: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6008: package will not be used.</p>
                   6009: <p>When building a package, the replacement tools are
                   6010: made available in a directory (as symlinks or wrapper scripts)
                   6011: that is early in the executable search path. Just like the buildlink
                   6012: system, this helps with consistent builds.</p>
                   6013: <p>A tool may be needed to help build a specific package. For example,
                   6014: perl, GNU make (gmake) or yacc may be needed.</p>
                   6015: <p>Also a tool may be needed, for example, because the native system's supplied
                   6016: tool may be inefficient for building a package with pkgsrc.
                   6017: For example, a package may need GNU awk, bison (instead of
                   6018: yacc) or a better sed.</p>
                   6019: <p>The tools used by a package can be listed by running
                   6020: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6021: <div class="sect1">
1.75      rillig   6022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6023: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6024: <p>The default set of tools used by pkgsrc is defined in
                   6025: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6026: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6027: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6028: These can be seen by running:
                   6029: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6030: <p>If a package needs a specific program to build
                   6031: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6032: to define the tools needed.</p>
1.75      rillig   6033: </div>
1.299     rillig   6034: <div class="sect1">
                   6035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6036: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6037: <p>In the following examples, the :run means that it is needed at
                   6038: run-time (and becomes a DEPENDS).
                   6039: The default is a build dependency which can be set with
                   6040: :build. (So in this example, it is the same as gmake:build
                   6041: and pkg-config:build.)</p>
1.75      rillig   6042: <pre class="programlisting">
1.299     rillig   6043: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6044: </pre>
1.299     rillig   6045: <p>When using the tools framework, a
                   6046: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6047: which contains the full path to the appropriate tool. For example,
                   6048: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6049: on Linux systems.</p>
                   6050: <p>If you always need a pkgsrc version of the
                   6051: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6052: </p>
1.75      rillig   6053: </div>
1.299     rillig   6054: <div class="sect1">
                   6055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6056: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6057: <p>When improving or porting pkgsrc to a new platform, have a look
                   6058: at (or create) the corresponding platform specific make file fragment under
                   6059: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6060: the name of the common tools. For example:</p>
1.75      rillig   6061: <pre class="programlisting">
1.299     rillig   6062: .if exists(/usr/bin/bzcat)
                   6063: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6064: .elif exists(/usr/bin/bzip2)
                   6065: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6066: .endif
                   6067: 
                   6068: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6069: </pre>
1.75      rillig   6070: </div>
                   6071: </div>
1.299     rillig   6072: <div class="chapter">
                   6073: <div class="titlepage"><div><div><h2 class="title">
                   6074: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6075: <div class="toc">
                   6076: <p><b>Table of Contents</b></p>
                   6077: <dl class="toc">
                   6078: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6079: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6080: <dd><dl>
                   6081: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6082: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6083:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6084:       and
                   6085:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6086:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6087: </dl></dd>
                   6088: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6089: <dd><dl>
                   6090: <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>
                   6091: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6092: </dl></dd>
                   6093: </dl>
1.75      rillig   6094: </div>
1.299     rillig   6095: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6096:   are seen by a package's configure and build processes.  This is implemented
                   6097:   in a two step process:</p>
                   6098: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6099: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6100:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6101:       of <code class="varname">WRKDIR</code>.</p></li>
                   6102: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6103:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6104:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6105:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6106:       native compiler on some operating systems look like GCC, so that
                   6107:       packages that expect GCC won't require modifications to build with
                   6108:       those native compilers.</p></li>
                   6109: </ol></div>
                   6110: <p>This normalizes the environment in which a package is built so that the
                   6111:   package may be built consistently despite what other software may be
                   6112:   installed. Please note that the normal system header and library paths,
                   6113:   e.g. <code class="filename">/usr/include</code>,
                   6114:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6115:   designed to insulate the package build from non-system-supplied
                   6116:   software.</p>
1.148     asau     6117: <div class="sect1">
1.75      rillig   6118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6119: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6120: <p>The process of converting packages to use the buildlink3
                   6121:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6122:     The things to keep in mind are:</p>
1.128     wiz      6123: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6124: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6125:        instead of the actual toolchain.  Some packages are tricky,
                   6126:        and the only way to know for sure is the check
                   6127:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6128:        wrappers are being invoked.</p></li>
                   6129: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6130:        the package Makefile, e.g. Java VMs, standalone shells,
                   6131:        etc., because the code to symlink files into
                   6132:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6133:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6134:        </p></li>
                   6135: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6136:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6137:        package's Makefile are added as dependencies for that package.
                   6138:        </p></li>
                   6139: </ol></div>
                   6140: <p>If a dependency on a particular package is required for its libraries and
                   6141:     headers, then we replace:</p>
                   6142: <pre class="programlisting">
                   6143: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6144: </pre>
                   6145: <p>with</p>
                   6146: <pre class="programlisting">
                   6147: .include "../../category/foo/buildlink3.mk"
                   6148: </pre>
                   6149: <p>The buildlink3.mk files usually define the required dependencies.
                   6150:     If you need a newer version of the dependency when using buildlink3.mk
                   6151:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6152: <pre class="programlisting">
1.299     rillig   6153: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6154: .include "../../category/foo/buildlink3.mk"
1.1       grant    6155: </pre>
1.299     rillig   6156: <p>There are several <code class="filename">buildlink3.mk</code>
                   6157:     files in <code class="filename">pkgsrc/mk</code>
                   6158:     that handle special package issues:</p>
                   6159: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6160: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6161:        the native or a pkgsrc Berkeley DB implementation based on
                   6162:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6163:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6164: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6165:        comes with neither Curses nor NCurses, this will take care
1.322     leot     6166:        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   6167: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6168:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6169:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6170:        require a Kerberos 5 implementation.</p></li>
                   6171: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6172:        system-provided Motif installation or adds a dependency on
1.322     leot     6173:        <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   6174:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6175:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6176:        to choose which Motif version will be used.</p></li>
                   6177: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6178:        system-provided GNU readline or editline (libedit) installation,
1.322     leot     6179:        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>,
                   6180:        <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   6181:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6182:        If your package really needs GNU readline library, its Makefile
                   6183:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6184:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6185: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6186:        variables that may be used by packages that use the
                   6187:        Open Sound System (OSS) API.</p></li>
                   6188: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6189:        any of the Postgres versions in the variable
                   6190:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6191:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6192:        the file for more information.</p></li>
                   6193: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6194:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322     leot     6195:        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   6196: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6197:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6198:        library.</p></li>
                   6199: </ul></div>
                   6200: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6201:     files provide a more complete
                   6202:     description of how to use them properly.</p>
1.75      rillig   6203: </div>
1.148     asau     6204: <div class="sect1">
1.75      rillig   6205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6206: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6207: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6208:     included by Makefiles to indicate the need to compile and link
                   6209:     against header files and libraries provided by the package.  A
                   6210:     <code class="filename">buildlink3.mk</code> file should always provide
                   6211:     enough information to add the correct type of dependency
                   6212:     relationship and include any other
                   6213:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6214:     headers and libraries that it needs in turn.</p>
                   6215: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322     leot     6216:     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   6217:     package is highly recommended.  For most packages, the following
                   6218:     command will generate a good starting point for
                   6219:     <code class="filename">buildlink3.mk</code> files:</p>
                   6220: <pre class="screen">
                   6221: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6222: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6223:     </pre>
1.148     asau     6224: <div class="sect2">
1.75      rillig   6225: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6226: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6227: <p>The following real-life example
                   6228:       <code class="filename">buildlink3.mk</code> is taken
                   6229:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6230: <pre class="programlisting">
1.299     rillig   6231: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6232: 
                   6233: BUILDLINK_TREE+=        tiff
                   6234: 
                   6235: .if !defined(TIFF_BUILDLINK3_MK)
                   6236: TIFF_BUILDLINK3_MK:=
                   6237: 
                   6238: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6239: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6240: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6241: 
                   6242: .include "../../devel/zlib/buildlink3.mk"
                   6243: .include "../../graphics/jpeg/buildlink3.mk"
                   6244: .endif # TIFF_BUILDLINK3_MK
                   6245: 
                   6246: BUILDLINK_TREE+=        -tiff
1.1       grant    6247: </pre>
1.299     rillig   6248: <p>The header and footer manipulate
                   6249:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6250:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6251:       the dependency tree.</p>
                   6252: <p>The main section is protected from multiple inclusion
                   6253:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6254:       added.  Several important variables are set in the section:</p>
                   6255: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6256: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6257:          is the dependency version recorded in the installed
1.299     rillig   6258:          package; this should always be set using
                   6259:          <span class="command"><strong>+=</strong></span> to ensure that
                   6260:          we're appending to any pre-existing list of values.  This
1.300     wiz      6261:          variable should be set to the last version of the
1.299     rillig   6262:          package that had an backwards-incompatible API change.
                   6263:          </p></li>
                   6264: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6265:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6266:          pkgsrc directory.</p></li>
                   6267: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6268:          (not shown above) controls whether we use
                   6269:          <code class="varname">BUILD_DEPENDS</code> or
                   6270:          <code class="varname">DEPENDS</code> to add the dependency on
                   6271:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6272:          selected by setting
                   6273:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6274:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6275:          used.</p></li>
                   6276: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6277:            and
                   6278:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6279:            (not shown above) are lists of subdirectories of
                   6280:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6281:            to add to the header and library search paths.  These
                   6282:            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>
                   6283:          respectively.</p></li>
                   6284: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6285:            (not shown above) is the list of preprocessor flags to add
                   6286:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6287:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6288:            should be avoided and instead be handled using
                   6289:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6290:          above.</p></li>
                   6291: </ul></div>
                   6292: <p>The following variables are all optionally defined within
                   6293:       this second section (protected against multiple inclusion) and
                   6294:       control which package files are symlinked into
                   6295:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6296:       transformed during the symlinking:</p>
                   6297: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6298: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6299:            (not shown above) is a shell glob pattern relative to
                   6300:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6301:            to be symlinked into
                   6302:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6303:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6304: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6305:            (not shown above) is a shell pipeline that
                   6306:            outputs to stdout a list of files relative to
                   6307:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6308:            The resulting files are to be symlinked
                   6309:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6310:            this takes the <code class="filename">+CONTENTS</code> of a
                   6311:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6312:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6313: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6314:            (not shown above) is a filter command that filters
                   6315:            <code class="filename">+CONTENTS</code> input into a list of files
                   6316:            relative to
                   6317:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6318:            on stdout.  By default,
                   6319:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6320:            outputs the contents of the <code class="filename">include</code>
                   6321:            and <code class="filename">lib</code> directories in the package
                   6322:            <code class="filename">+CONTENTS</code>.</p></li>
                   6323: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6324:            (not shown above) is a list of sed arguments used to
                   6325:            transform the name of the source filename into a
                   6326:            destination filename, e.g. <span class="command"><strong>-e
                   6327:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6328: </ul></div>
                   6329: <p>This section can additionally include any
                   6330:       <code class="filename">buildlink3.mk</code> needed for
                   6331:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6332:       Including these <code class="filename">buildlink3.mk</code> files
                   6333:       means that the headers and libraries for these
                   6334:       dependencies are also symlinked into
                   6335:       <code class="filename">${BUILDLINK_DIR}</code>
                   6336:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6337:       <code class="filename">buildlink3.mk</code>
                   6338:       file is included. Dependencies are only added for directly
                   6339:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6340: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6341:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6342:       please only add necessary ones, i.e., those whose libraries or
                   6343:       header files are automatically exposed when the package is
                   6344:       use.</p>
                   6345: <p>In particular, if only an executable
                   6346:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6347:       library does not need to be propagated in the
                   6348:       <code class="filename">buildlink3.mk</code> file.</p>
                   6349: <p>The following steps should help you decide if a
                   6350:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6351:       </p>
                   6352: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6353: <li class="listitem"><p>Look at the installed header files: What
                   6354:        headers do they include? The packages providing these files
                   6355:        must be buildlinked.</p></li>
                   6356: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6357:        libraries and look against what other libraries they link.
                   6358:        Some of the packages providing these probably need to be
                   6359:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6360:        some systems pulls in the X libraries, so they will show up in
                   6361:        the <code class="filename">ldd</code> output, while on others (like OS
                   6362:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6363:        used as a hint.</p></li>
                   6364: </ul></div>
                   6365: <p>
                   6366:       </p>
                   6367: </div>
1.148     asau     6368: <div class="sect2">
1.75      rillig   6369: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6370: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6371:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6372:       and
                   6373:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6374:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6375: <p>Both variables set lower bounds for a version of this package.
                   6376:       The two variables differ in that one describes source
1.299     rillig   6377:       compatibility (API) and the other binary compatibility (ABI).
                   6378:       The difference is that a change in the API breaks compilation of
                   6379:       programs while changes in the ABI stop compiled programs from
                   6380:       running.</p>
1.300     wiz      6381: <p>The
                   6382:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6383:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6384:       changed very rarely.  (One possible scenario: If all packages
                   6385:       using this package need a higher version than defined in the
                   6386:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6387:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6388:       could be updated to that higher version.)</p>
                   6389: <p>On the other hand, changes to
1.299     rillig   6390:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6391:       are more common.  The variable will need to be updated every
                   6392:       time the major version of one of its shared libraries is changed,
                   6393:       or any other change where a binary built against the previous
                   6394:       version of the package will not run against the new version any
                   6395:       longer.</p>
                   6396: <p>In such a case, the package's
1.299     rillig   6397:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6398:       must be increased to require the new package version.  Then the
                   6399:       <code class="varname">PKGREVISION</code> of all packages
                   6400:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6401:       to be increased, and if they have
                   6402:       <code class="filename">buildlink3.mk</code> files,
                   6403:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6404:       in their <code class="filename">buildlink3.mk</code> files must be
                   6405:       increased to the new version as well. This is required so that a
                   6406:       package will pull in the versions of the packages that use the
                   6407:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6408:       uniquely identify the packages built against the new ABI. The
1.322     leot     6409:       <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      6410:       help with these updates.</p>
                   6411: <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
                   6412:       about dependencies on other packages, including the
                   6413:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6414: <p>Please take careful consideration before adjusting
                   6415:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6416:       or
                   6417:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6418:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6419:       cause unneeded package deletions and rebuilds.  In many cases,
                   6420:       new versions of packages work just fine with older
                   6421:       dependencies.</p>
1.326     gutterid 6422: <p>Also, it is not needed to set
1.299     rillig   6423:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6424:       when it is identical to
1.326     gutterid 6425:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6426: <p>Note there is also the distinction that users are able to disable
                   6427:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6428:       variable, but there is no equivalent option for API dependencies.</p>
1.75      rillig   6429: </div>
                   6430: </div>
1.148     asau     6431: <div class="sect1">
1.75      rillig   6432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6433: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6434: <p>Some packages in pkgsrc install headers and libraries that
                   6435:       coincide with headers and libraries present in the base system.
                   6436:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6437:       packages should also include a <code class="filename">builtin.mk</code>
                   6438:       file that includes the necessary checks to decide whether using
                   6439:       the built-in software or the pkgsrc software is
                   6440:     appropriate.</p>
                   6441: <p>The only requirements of a builtin.mk file for
                   6442:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6443: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6444: <li class="listitem"><p>It should set
                   6445:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6446:        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>
                   6447:        after it is included.</p></li>
                   6448: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6449:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6450:        which is already set before the
                   6451:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6452: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6453:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6454:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6455: </ol></div>
                   6456: <div class="sect2">
                   6457: <div class="titlepage"><div><div><h3 class="title">
                   6458: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6459: <p>The following is the recommended template for builtin.mk
                   6460:       files:</p>
1.75      rillig   6461: <pre class="programlisting">
1.299     rillig   6462: .if !defined(IS_BUILTIN.foo)
                   6463: #
                   6464: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6465: # genuinely exists in the system or not.
                   6466: #
                   6467: IS_BUILTIN.foo?=        no
1.100     rillig   6468: 
1.299     rillig   6469: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6470: # version can be determined.
                   6471: #
                   6472: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6473: BUILTIN_PKG.foo?=       foo-1.0
                   6474: .  endif
                   6475: .endif  # IS_BUILTIN.foo
1.100     rillig   6476: 
1.299     rillig   6477: .if !defined(USE_BUILTIN.foo)
                   6478: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6479: .  if defined(BUILTIN_PKG.foo)
                   6480: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6481: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6482: USE_BUILTIN.foo!=                                                       \
                   6483:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6484:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6485: .      endif
                   6486: .    endfor
                   6487: .  endif
                   6488: .endif  # USE_BUILTIN.foo
1.100     rillig   6489: 
1.299     rillig   6490: CHECK_BUILTIN.foo?=     no
                   6491: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6492: #
                   6493: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6494: # "yes" or "no".
                   6495: #
                   6496: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6497: </pre>
1.299     rillig   6498: <p>The first section sets
                   6499:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6500:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6501:       in the base system.  This should not be a base system software
                   6502:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6503:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6504:       included as part of the base system.  This variable is only
                   6505:       used internally within the <code class="filename">builtin.mk</code>
                   6506:       file.</p>
                   6507: <p>The second section sets
                   6508:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6509:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6510:       system if it exists (if
                   6511:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6512:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6513:       within the <code class="filename">builtin.mk</code> file.</p>
                   6514: <p>The third section sets
                   6515:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6516:       and is <span class="emphasis"><em>required</em></span> in all
                   6517:       <code class="filename">builtin.mk</code> files.  The code in this
                   6518:       section must make the determination whether the built-in
                   6519:       software is adequate to satisfy the dependencies listed in
                   6520:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6521:       This is typically done by comparing
                   6522:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6523:       against each of the dependencies in
                   6524:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6525:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6526:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6527:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6528:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6529:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6530:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6531:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6532:       that the built-in version of the software is similar enough to
                   6533:       be used as a replacement.</p>
                   6534: <p>The last section is guarded by
                   6535:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6536:       and includes code that uses the value of
                   6537:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6538:       set in the previous section.  This typically includes, e.g.,
                   6539:       adding additional dependency restrictions and listing additional
                   6540:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6541:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6542: </div>
                   6543: <div class="sect2">
                   6544: <div class="titlepage"><div><div><h3 class="title">
                   6545: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6546: <p>When building packages, it's possible to choose whether to set
                   6547:        a global preference for using either the built-in (native)
                   6548:        version or the pkgsrc version of software to satisfy a
                   6549:        dependency.  This is controlled by setting
                   6550:        <code class="varname">PREFER_PKGSRC</code> and
                   6551:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6552:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
                   6553:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6554:        use the pkgsrc versions of software, while
                   6555:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6556:        built-in versions.  Preferences are determined by the most
                   6557:        specific instance of the package in either
                   6558:        <code class="varname">PREFER_PKGSRC</code> or
                   6559:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6560:        in neither or in both variables, then
                   6561:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6562:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6563:        using pkgsrc versions of software for all but the most basic
                   6564:       bits on a NetBSD system, you can set:</p>
1.75      rillig   6565: <pre class="programlisting">
1.299     rillig   6566: PREFER_PKGSRC=  yes
                   6567: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6568: </pre>
                   6569: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6570:       <code class="filename">builtin.mk</code>
                   6571:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6572:       otherwise it is simply ignored in that list.</p>
1.305     bacon    6573: <p><code class="varname">PREFER_PKGSRC</code> and
                   6574:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6575:       to ensure that the bootstrap process does not use inapropriate
                   6576:       native tools as dependencies for core packages.
                   6577: 
                   6578: </p>
                   6579: <pre class="screen">
                   6580: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6581: </pre>
                   6582: <p>
                   6583: 
1.299     rillig   6584:       Switching between settings globally at a later date can introduce
                   6585:       complications with dependency resolution. This is caused by packages
1.305     bacon    6586:       built with the opposite preference being installed alongside each
                   6587:       other.  Hence, any changes to these variables after bootstrap will
                   6588:       necessitate rebuilding all packages depending on one whose preference
                   6589:       has been changed.  This is not trivial and should be avoided.</p>
                   6590: <p>When using pkgsrc on Linux systems, there is high risk of
                   6591:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6592:       command or library not installed by pkgsrc, e.g. those installed by
                   6593:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6594:       upgraded to a version incompatible with the pkgsrc package at any
                   6595:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6596:       cannot prevent this, as it has no control over other package managers.
                   6597:       Another potential problem is that under Redhat Enterprise and related
                   6598:       Linux systems, yum packages are only patched and never upgraded, so
                   6599:       eventually they may become too outdated for use by pkgsrc.  Even
                   6600:       intentionally using foreign dependencies, not considered leakage, can
                   6601:       lead to these problems, so it is generally discouraged.  In order to
                   6602:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6603:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6604:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6605:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6606:       packages, or by setting --prefer-native to "yes".</p>
1.75      rillig   6607: </div>
1.107     rillig   6608: </div>
1.75      rillig   6609: </div>
1.148     asau     6610: <div class="chapter">
1.75      rillig   6611: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6612: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6613: <div class="toc">
                   6614: <p><b>Table of Contents</b></p>
1.210     leot     6615: <dl class="toc">
1.299     rillig   6616: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6617: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6618: <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>
                   6619: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6620: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6621: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6622: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6623: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6624: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6625: </dl>
                   6626: </div>
1.299     rillig   6627: <p>The <code class="filename">PLIST</code> file contains a package's
                   6628:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6629:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6630:   directory it's been installed in) plus some additional statements
1.322     leot     6631:   - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6632:   This chapter addresses some issues that need attention when
                   6633:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6634:   below!).</p>
1.148     asau     6635: <div class="sect1">
1.75      rillig   6636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6637: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6638: <p>Be sure to add a RCS ID line as the first thing in any
                   6639:     <code class="filename">PLIST</code> file you write:</p>
                   6640: <pre class="programlisting">
                   6641: @comment $NetBSD $
                   6642: </pre>
                   6643: <p>An artificial space has been added between NetBSD and $, this is a
                   6644: workaround here to prevent CVS expanding to the filename of the guide. When
                   6645: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6646: </div>
1.148     asau     6647: <div class="sect1">
1.75      rillig   6648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6649: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6650: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6651:     to output a PLIST that matches any new files since the package
                   6652:     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
                   6653:     more information on this target.</p>
1.75      rillig   6654: </div>
1.148     asau     6655: <div class="sect1">
1.75      rillig   6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6657: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6658: </h2></div></div></div>
                   6659: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6660:     of AWK patterns and actions that are used to filter the output of
                   6661:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6662:     scripting you like to it, but be careful with quoting.</p>
                   6663: <p>For example, to get all files inside the
                   6664:     <code class="filename">libdata/foo</code> directory removed from the
                   6665:     resulting PLIST:</p>
1.88      wiz      6666: <pre class="programlisting">
1.299     rillig   6667: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6668: </pre>
1.300     wiz      6669: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6670:     evaluated after the file list and directory list are sorted.
                   6671:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6672:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6673:     list and directory list are sorted.</p>
1.299     rillig   6674: </div>
                   6675: <div class="sect1">
                   6676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6677: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6678: <p>A number of variables are substituted automatically in
                   6679:     PLISTs when a package is installed on a system. This includes the
                   6680:     following variables:</p>
                   6681: <div class="variablelist"><dl class="variablelist">
                   6682: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6683: <dd>
                   6684: <p>Some packages like emacs and perl embed information
                   6685:          about which architecture they were built on into the
                   6686:          pathnames where they install their files. To handle this
                   6687:          case, PLIST will be preprocessed before actually used, and
                   6688:          the symbol
                   6689:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6690:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6691:          same is done if the string
                   6692:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6693:          PLIST somewhere - use this on packages that have GNU
                   6694:          autoconf-created configure scripts.</p>
                   6695: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6696: <h3 class="title">Legacy note</h3>
                   6697: <p>There used to be a symbol
                   6698:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6699:            was replaced by the output of <span class="command"><strong>uname
                   6700:            -m</strong></span>, but that's no longer supported and has
                   6701:            been removed.</p>
                   6702: </div>
                   6703: </dd>
                   6704: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6705: <dd>
                   6706: <p>Some packages want to embed the OS name and version
                   6707:          into some paths.  To do this, use these variables in the
                   6708:          <code class="filename">PLIST</code>:
                   6709:          </p>
                   6710: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6711: <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>
                   6712: <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>
                   6713: <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>
                   6714: </ul></div>
                   6715: </dd>
                   6716: </dl></div>
                   6717: <p>For a list of values which are replaced by
                   6718:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6719: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6720: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6721: <p>If you want to change other variables not listed above, you
                   6722:     can add variables and their expansions to this variable in the
                   6723:     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   6724: <pre class="programlisting">
1.299     rillig   6725: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6726: </pre>
1.299     rillig   6727: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6728:     in the <code class="filename">PLIST</code> with
                   6729:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6730: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6731:     the common case of conditionally including some
                   6732:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6733:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6734:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6735:     to <code class="literal">yes</code> if the entry should be included.
                   6736:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6737:     in the <code class="filename">PLIST</code> with either
                   6738:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6739:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6740:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6741: <pre class="programlisting">
1.299     rillig   6742: PLIST_VARS+=    foo
                   6743: .if <em class="replaceable"><code>condition</code></em>
                   6744: PLIST.foo=      yes
                   6745: .else
1.174     asau     6746: </pre>
1.299     rillig   6747: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6748: <pre class="programlisting">
1.299     rillig   6749: @comment $NetBSD $
                   6750: bin/bar
                   6751: man/man1/bar.1
                   6752: ${PLIST.foo}bin/foo
                   6753: ${PLIST.foo}man/man1/foo.1
                   6754: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6755: </pre>
1.299     rillig   6756: <p>An artificial space has been added between NetBSD and $, this is a
                   6757: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6758: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6759: </div>
1.299     rillig   6760: <div class="sect1">
                   6761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6762: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6763: <p>Man pages should be installed in compressed form if
                   6764:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6765:     and uncompressed otherwise. To handle this in the
                   6766:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6767:     appended/removed automatically for man pages according to
                   6768:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6769:     or not, see above for details. This modification of the
                   6770:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6771:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6772: </div>
1.148     asau     6773: <div class="sect1">
1.75      rillig   6774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6775: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6776: </h2></div></div></div>
                   6777: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6778:     in generating the binary package, set the variable
                   6779:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.322     leot     6780:     The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6781:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6782:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6783: </div>
1.148     asau     6784: <div class="sect1">
1.75      rillig   6785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6786: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6787: <p>Some packages decide to install a different set of files based on
                   6788:     the operating system being used. These differences can be
                   6789:     automatically handled by using the following files:</p>
                   6790: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6791: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6792: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6793: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6794: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6795: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6796: </ul></div>
1.75      rillig   6797: </div>
1.148     asau     6798: <div class="sect1">
1.75      rillig   6799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6800: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6801: <p>Some packages decide to generate hard-to-guess file names
                   6802:     during installation that are hard to wire down.</p>
                   6803: <p>In such cases, you can set the
                   6804:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6805:     terminated (with a semicolon) that will output PLIST entries which
                   6806:     will be appended to the PLIST</p>
                   6807: <p>You can find one example in editors/xemacs:</p>
                   6808: <pre class="programlisting">
                   6809: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6810: </pre>
                   6811: <p>which will append something like
                   6812:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6813:     <code class="filename">PLIST</code>.
                   6814:     </p>
1.75      rillig   6815: </div>
1.148     asau     6816: <div class="sect1">
1.75      rillig   6817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6818: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6819: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6820:     multiple (and unrelated) packages install files.  These
                   6821:     directories were problematic because you had to add special
                   6822:     tricks in the PLIST to conditionally remove them, or have some
                   6823:     centralized package handle them.</p>
                   6824: <p>In pkgsrc, it is now easy: Each package should create
                   6825:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6826:     will remove any directories left empty after uninstalling a
                   6827:     package.</p>
                   6828: <p>If a package needs an empty directory to work, create
                   6829:     the directory during installation as usual, and also add an
                   6830:     entry to the PLIST:
                   6831: 
                   6832: </p>
                   6833: <pre class="programlisting">
                   6834: @pkgdir path/to/empty/directory
                   6835: </pre>
                   6836: <p>
                   6837: 
                   6838:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6839:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6840:     </p>
1.75      rillig   6841: </div>
1.299     rillig   6842: </div>
                   6843: <div class="chapter">
                   6844: <div class="titlepage"><div><div><h2 class="title">
                   6845: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6846: <div class="toc">
                   6847: <p><b>Table of Contents</b></p>
                   6848: <dl class="toc">
                   6849: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6850: <dd><dl>
                   6851: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6852: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6853: </dl></dd>
                   6854: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6855: <dd><dl>
                   6856: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6857: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6858: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6859: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6860: </dl></dd>
                   6861: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6862: <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>
                   6863: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6864: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6865: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6866: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6867: <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>
                   6868: </dl>
                   6869: </div>
                   6870: <p>This chapter describes the framework known as
                   6871: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6873: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6874:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6875: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6876:     provided that packages are correctly designed.</p></li>
                   6877: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6878: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6879: <li class="listitem"><p>Registration of system shells.</p></li>
                   6880: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6881: </ul></div>
                   6882: <p>The following sections inspect each of the above points in detail.</p>
                   6883: <p>You may be thinking that many of the things described here could be
                   6884: easily done with simple code in the package's post-installation target
                   6885: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6886: as the code in them is only executed when building from source.  Machines
                   6887: using binary packages could not benefit from it at all (as the code itself
                   6888: could be unavailable).  Therefore, the only way to achieve any of the items
                   6889: described above is by means of the installation scripts, which are
                   6890: automatically generated by pkginstall.</p>
1.148     asau     6891: <div class="sect1">
1.75      rillig   6892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6893: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6894: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6895: of files and directories that belong to a package.  The names used in it
                   6896: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6897: which means that it cannot register files outside this directory (absolute
                   6898: path names are not allowed).  Despite this restriction, some packages need
                   6899: to install files outside this location; e.g., under
                   6900: <code class="filename">${VARBASE}</code> or
                   6901: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6902: is to create such files during installation time by using
                   6903: installation scripts.</p>
                   6904: <p>The generic installation scripts are shell scripts that can
                   6905: contain arbitrary code.  The list of scripts to execute is taken from
                   6906: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6907: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6908: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6909: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6910: commands, so they have the potential to create and manage files
                   6911: anywhere in the file system.</p>
                   6912: <p>Using these general installation files is not recommended, but
                   6913: may be needed in some special cases.  One reason for avoiding them is
                   6914: that the user has to trust the packager that there is no unwanted or
                   6915: simply erroneous code included in the installation script. Also,
                   6916: previously there were many similar scripts for the same functionality,
                   6917: and fixing a common error involved finding and changing all of
                   6918: them.</p>
                   6919: <p>The pkginstall framework offers another, standardized way.  It
                   6920: provides generic scripts to abstract the manipulation of such files
                   6921: and directories based on variables set in the package's
                   6922: <code class="filename">Makefile</code>.  The rest of this section describes
                   6923: these variables.</p>
                   6924: <div class="sect2">
                   6925: <div class="titlepage"><div><div><h3 class="title">
                   6926: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6927: <p>The following variables can be set to request the creation of
                   6928: directories anywhere in the file system:</p>
                   6929: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6930: <li class="listitem">
                   6931: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6932:     contain a list of directories that should be created and should attempt
                   6933:     to be destroyed by the installation scripts.  The difference between
                   6934:     the two is that the latter prompts the administrator to remove any
                   6935:     directories that may be left after deinstallation (because they were
                   6936:     not empty), while the former does not.  Example:</p>
                   6937: <pre class="programlisting">
                   6938: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6939: </pre>
                   6940: </li>
                   6941: <li class="listitem">
                   6942: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6943:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6944:     which directories should be created and should attempt to be destroyed
                   6945:     by the installation scripts.  Each tuple holds the following values,
                   6946:     separated by spaces: the directory name, its owner, its group and its
                   6947:     numerical mode.  For example:</p>
                   6948: <pre class="programlisting">
                   6949: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6950:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6951: </pre>
                   6952: <p>The difference between the two is exactly the same as their
                   6953:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6954: </li>
                   6955: </ul></div>
1.75      rillig   6956: </div>
1.299     rillig   6957: <div class="sect2">
                   6958: <div class="titlepage"><div><div><h3 class="title">
                   6959: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6960: <p>Creating non-empty files outside the installation prefix is tricky
                   6961: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6962: To overcome this problem, the only solution is to extract the file in the
                   6963: known place (i.e., inside the installation prefix) and copy it to the
                   6964: appropriate location during installation (done by the installation scripts
                   6965: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6966: file</em></span> in the following paragraphs, which describe the variables
                   6967: that can be used to automatically and consistently handle files outside the
                   6968: installation prefix:</p>
                   6969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6970: <li class="listitem">
                   6971: <p><code class="varname">CONF_FILES</code> and
                   6972:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6973:     During installation time, the master file is copied to the target one
                   6974:     if and only if the latter does not exist.  Upon deinstallation, the
                   6975:     target file is removed provided that it was not modified by the
                   6976:     installation.</p>
                   6977: <p>The difference between the two is that the latter prompts the
                   6978:     administrator to remove any files that may be left after
                   6979:     deinstallation (because they were not empty), while the former does
                   6980:     not.</p>
                   6981: </li>
                   6982: <li class="listitem">
                   6983: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6984:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6985:     files as well as their target locations.  For each of them, it also
                   6986:     specifies their owner, their group and their numeric permissions, in
                   6987:     this order.  For example:</p>
1.88      wiz      6988: <pre class="programlisting">
1.299     rillig   6989: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   6990:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   6991: </pre>
1.299     rillig   6992: <p>The difference between the two is exactly the same as their
                   6993:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6994: </li>
                   6995: </ul></div>
                   6996: </div>
1.75      rillig   6997: </div>
1.148     asau     6998: <div class="sect1">
1.75      rillig   6999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7000: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   7001: <p>Configuration files are special in the sense that they are installed
                   7002: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   7003: need special treatment during installation (most of which is automated by
                   7004: pkginstall).  The main concept you must bear in mind is that files marked
                   7005: as configuration files are automatically copied to the right place (somewhere
                   7006: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   7007: and only if</em></span> they didn't exist before.  Similarly, they will not
                   7008: be removed if they have local modifications.  This ensures that
                   7009: administrators never lose any custom changes they may have made.</p>
                   7010: <div class="sect2">
                   7011: <div class="titlepage"><div><div><h3 class="title">
                   7012: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   7013: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7014: specifies where configuration files shall be installed.  Its contents are
                   7015: set based upon the following variables:</p>
                   7016: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7017: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7018:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7019:     be overridden by the user to point to his preferred location (e.g.,
                   7020:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7021:     Packages must not use it directly.</p></li>
                   7022: <li class="listitem">
                   7023: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7024:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7025:     for the package being built shall be installed.  The definition of this
                   7026:     variable only makes sense in the package's
                   7027:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7028: <p>As an example, consider the Apache package,
1.322     leot     7029:     <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   7030:     configuration files under the
                   7031:     <code class="filename">httpd/</code> subdirectory of
                   7032:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7033:     Makefile.</p>
                   7034: </li>
                   7035: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7036:     variable that holds this package's configuration directory (if
                   7037:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7038:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7039:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7040: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7041:     directory where the configuration files for the package identified by
                   7042:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7043: </ul></div>
                   7044: <p>Based on the above variables, pkginstall determines the value of
                   7045: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7046: variable that can be used within a package to refer to its configuration
                   7047: directory.  The algorithm used to set its value is basically the
                   7048: following:</p>
                   7049: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7050: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7051:     its value is used.</p></li>
                   7052: <li class="listitem"><p>If the previous variable is not defined but
                   7053:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7054:     <code class="filename">Makefile</code>, the resulting value is
                   7055:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7056: <li class="listitem"><p>Otherwise, it is set to
                   7057:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7058: </ol></div>
                   7059: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7060: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
                   7061: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7062: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7063: </div>
                   7064: <div class="sect2">
                   7065: <div class="titlepage"><div><div><h3 class="title">
                   7066: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7067: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7068: known place, you need to teach each package where it shall install its
                   7069: files.  In some cases you will have to patch the package Makefiles to
                   7070: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7071: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7072: generated files:</p>
1.75      rillig   7073: <pre class="programlisting">
1.299     rillig   7074: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7075: </pre>
1.299     rillig   7076: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7077: for</em></span> its configuration files, not where they will be originally
                   7078: installed (although the difference is never explicit,
                   7079: unfortunately).</p>
1.75      rillig   7080: </div>
1.299     rillig   7081: <div class="sect2">
                   7082: <div class="titlepage"><div><div><h3 class="title">
                   7083: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7084: <p>As said before, pkginstall automatically handles configuration files.
                   7085: This means that <span class="strong"><strong>the packages themselves must not
                   7086: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7087: directly</strong></span>.  Bad news is that many software installation scripts
                   7088: will, out of the box, mess with the contents of that directory.  So what is
                   7089: the correct procedure to fix this issue?</p>
                   7090: <p>You must teach the package (usually by manually patching it) to
                   7091: install any configuration files under the examples hierarchy,
                   7092: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7093: <code class="filename">PLIST</code> registers them and the administrator always
                   7094: has the original copies available.</p>
                   7095: <p>Once the required configuration files are in place (i.e., under the
                   7096: examples hierarchy), the pkginstall framework can use them as master copies
                   7097: during the package installation to update what is in
                   7098: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7099: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7100: 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 information
                   7101: about their syntax and their purpose.  Here is an example, taken from the
1.322     leot     7102: <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>
1.88      wiz      7103: <pre class="programlisting">
1.299     rillig   7104: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7105: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100     rillig   7106: </pre>
1.299     rillig   7107: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7108: package and has no meaning outside it.</p>
1.75      rillig   7109: </div>
1.299     rillig   7110: <div class="sect2">
                   7111: <div class="titlepage"><div><div><h3 class="title">
                   7112: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7113: <p>The automatic copying of config files can be toggled by setting the
                   7114: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7115: installation.</p>
1.88      wiz      7116: </div>
1.75      rillig   7117: </div>
1.148     asau     7118: <div class="sect1">
1.75      rillig   7119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7120: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7121: <p>System startup scripts are special files because they must be
                   7122: installed in a place known by the underlying OS, usually outside the
                   7123: 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
                   7124: can be used.  However, pkginstall provides a special mechanism to handle
                   7125: these files.</p>
                   7126: <p>In order to provide system startup scripts, the package has
                   7127: to:</p>
                   7128: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7129: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7130:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.322     leot     7131:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/index.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.299     rillig   7132:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   7133: <li class="listitem">
                   7134: <p>Tell pkginstall to handle it, appending the name of the script,
                   7135:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7136:     Continuing the previous example:</p>
                   7137: <pre class="programlisting">
                   7138: RCD_SCRIPTS+=   cupsd
                   7139: </pre>
                   7140: </li>
                   7141: </ol></div>
                   7142: <p>Once this is done, pkginstall will do the following steps for each
                   7143: script in an automated fashion:</p>
                   7144: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7145: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7146:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7147:     variable.</p></li>
                   7148: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7149:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7150:     that this master file must be explicitly registered in the
                   7151:     <code class="filename">PLIST</code>.</p></li>
                   7152: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7153:     from the examples hierarchy into the system-wide startup scripts
                   7154:     directory.</p></li>
                   7155: </ol></div>
                   7156: <div class="sect2">
                   7157: <div class="titlepage"><div><div><h3 class="title">
                   7158: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7159: <p>The automatic copying of config files can be toggled by setting the
                   7160: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7161: installation.  Note that the scripts will be always copied inside the
                   7162: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7163: matter what the value of this variable is.</p>
1.75      rillig   7164: </div>
                   7165: </div>
1.299     rillig   7166: <div class="sect1">
                   7167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7168: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7169: <p>If a package needs to create special users and/or groups during
                   7170: installation, it can do so by using the pkginstall framework.</p>
                   7171: <p>Users can be created by adding entries to the
                   7172: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7173: syntax:</p>
                   7174: <pre class="programlisting">
                   7175: user:group
                   7176: </pre>
                   7177: <p>Further specification of user details may be done by setting
                   7178: per-user variables.
                   7179: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7180: numeric UID for the user.
                   7181: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7182: user's description or comment.
                   7183: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7184: user's home directory, and defaults to
                   7185: <code class="filename">/nonexistent</code> if not specified.
                   7186: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7187: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7188: not specified.</p>
                   7189: <p>Similarly, groups can be created by adding entries to the
                   7190: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7191: <pre class="programlisting">
                   7192: group
                   7193: </pre>
                   7194: <p>The numeric GID of the group may be set by defining
                   7195: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7196: <p>If a package needs to create the users and groups at an earlier
                   7197: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7198: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7199: <code class="literal">pre-install</code> to indicate the phase before which the
                   7200: users and groups are created. In this case, the numeric UIDs and GIDs
                   7201: of the created users and groups are automatically hardcoded into the
                   7202: final installation scripts.</p>
1.75      rillig   7203: </div>
1.148     asau     7204: <div class="sect1">
1.75      rillig   7205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7206: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7207: <p>Packages that install system shells should register them in the shell
                   7208: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7209: administrator.  This must be done from the installation scripts to keep
                   7210: binary packages working on any system.  pkginstall provides an easy way to
                   7211: accomplish this task.</p>
                   7212: <p>When a package provides a shell interpreter, it has to set the
                   7213: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7214: add some hooks to the installation scripts to handle it.  Consider the
1.322     leot     7215: 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   7216: <pre class="programlisting">
                   7217: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7218: </pre>
                   7219: <div class="sect2">
                   7220: <div class="titlepage"><div><div><h3 class="title">
                   7221: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7222: <p>The automatic registration of shell interpreters can be disabled by
                   7223: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7224: environment variable to <code class="literal">NO</code>.</p>
                   7225: </div>
1.75      rillig   7226: </div>
1.148     asau     7227: <div class="sect1">
1.75      rillig   7228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7229: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7230: <p>Packages that install X11 fonts should update the database files
                   7231: that index the fonts within each fonts directory.  This can easily be
                   7232: accomplished within the pkginstall framework.</p>
                   7233: <p>When a package installs X11 fonts, it must list the directories in
                   7234: which fonts are installed in the
                   7235: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7236: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7237: <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
                   7238: installation scripts to run the appropriate commands to update the fonts
                   7239: database files within each of those directories.  For convenience, if the
                   7240: directory path is relative, it is taken to be relative to the package's
1.322     leot     7241: 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   7242: <pre class="programlisting">
1.299     rillig   7243: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7244: </pre>
1.299     rillig   7245: <div class="sect2">
                   7246: <div class="titlepage"><div><div><h3 class="title">
                   7247: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7248: <p>The automatic update of fonts databases can be disabled by
                   7249: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7250: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7251: </div>
                   7252: </div>
                   7253: </div>
1.148     asau     7254: <div class="chapter">
1.75      rillig   7255: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7256: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7257: <div class="toc">
                   7258: <p><b>Table of Contents</b></p>
1.210     leot     7259: <dl class="toc">
1.267     rillig   7260: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7261: <dd><dl>
1.267     rillig   7262: <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>
                   7263: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7264: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7265: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7266: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7267: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7268: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7269: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7270: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7271: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7272: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7273: </dl></dd>
                   7274: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7275: <dd><dl>
                   7276: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7277: <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>
                   7278: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7279: </dl></dd>
                   7280: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7281: <dd><dl>
                   7282: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7283: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7284: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   7285: </dl></dd>
                   7286: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7287: <dd><dl>
                   7288: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7289: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      7290: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
                   7291: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
                   7292: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
                   7293: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267     rillig   7294: </dl></dd>
                   7295: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7296: <dd><dl>
                   7297: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7298: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7299: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7300: <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>
                   7301: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7302: </dl></dd>
                   7303: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7304: <dd><dl>
                   7305: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7306: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7307: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7308: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7309: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      7310: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     rillig   7311: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7312: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318     nia      7313: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   7314: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   7315: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   7316: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   7317: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   7318: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   7319: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87      wiz      7320:     emulation</a></span></dt>
1.318     nia      7321: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   7322: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75      rillig   7323: </dl></dd>
1.267     rillig   7324: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7325: </dl>
                   7326: </div>
1.148     asau     7327: <div class="sect1">
1.75      rillig   7328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7329: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7330: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7331:   different platforms. As a result, it is important to ensure,
                   7332:   where possible, that packages in pkgsrc are portable. This
                   7333:   chapter mentions some particular details you should pay
                   7334:   attention to while working on pkgsrc.</p>
1.148     asau     7335: <div class="sect2">
1.78      rillig   7336: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7337: <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   7338: </h3></div></div></div>
1.78      rillig   7339: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7340:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7341:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7342:     want to use those variables in the preprocessor directives of
1.322     leot     7343:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7344:     <code class="literal">.for</code>), you need to include the file
                   7345:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7346:     loads the user preferences.</p>
1.78      rillig   7347: <p>But note that some variables may not be completely defined
1.219     rillig   7348:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7349:     included, as they may contain references to variables that are
                   7350:     not yet defined. In shell commands (the lines in
                   7351:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7352:     is no problem, since variables are only expanded when they are
                   7353:     used. But in the preprocessor directives mentioned above and in
                   7354:     dependency lines (of the form <code class="literal">target:
                   7355:     dependencies</code>) the variables are expanded at load
                   7356:     time.</p>
1.148     asau     7357: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7358: <h3 class="title">Note</h3>
1.218     rillig   7359: <p>To check whether a variable can be used at load time,
                   7360:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7361: </div>
                   7362: </div>
1.148     asau     7363: <div class="sect2">
1.78      rillig   7364: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7365: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7366: <p>Occasionally, packages require interaction from the user,
                   7367:     and this can be in a number of ways:</p>
1.148     asau     7368: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7369: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7370:        interaction such as entering username/password or accepting a
                   7371:        license on a web page.</p></li>
1.128     wiz      7372: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7373:        passwords.</p></li>
1.128     wiz      7374: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7375: <li class="listitem"><p>help during the build process</p></li>
                   7376: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7377: </ul></div>
1.218     rillig   7378: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7379:     variable to define which stages need interaction. This should be
                   7380:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7381: <pre class="programlisting">
1.100     rillig   7382: INTERACTIVE_STAGE=      configure install
1.222     sevan    7383: </pre>
1.88      wiz      7384: <p>The user can then decide to skip this package by setting the
1.218     rillig   7385:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7386:     are also excluded from bulk builds.</p>
1.75      rillig   7387: </div>
1.148     asau     7388: <div class="sect2">
1.75      rillig   7389: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7390: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7391: <p>Authors of software can choose the licence under which software
                   7392:     can be copied.  The Free Software Foundation has declared some
                   7393:     licenses "Free", and the Open Source Initiative has a definition of
                   7394:     "Open Source".</p>
                   7395: <p>By default, pkgsrc allows packages with Free or Open Source
                   7396:     licenses to be built.  To allow packages with other licenses to be
                   7397:     built as well, the pkgsrc user needs to add these licenses to the
                   7398:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7399:     that this variable only affects which packages may be
                   7400:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7401:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7402: <p>One might want to only install packages with a BSD license,
1.218     rillig   7403:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7404:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7405:     user can override the default by setting the
                   7406:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7407:     of "+=".  The licenses accepted by default are defined in the
                   7408:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7409:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7410: <p>The license tag mechanism is intended to address
1.87      wiz      7411:     copyright-related issues surrounding building, installing and
                   7412:     using a package, and not to address redistribution issues (see
                   7413:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7414:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7415:     Packages with redistribution restrictions should set these
                   7416:     tags.</p>
1.98      wiz      7417: <p>Denoting that a package may be copied according to a
                   7418:     particular license is done by placing the license in
1.87      wiz      7419:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7420:     <code class="varname">LICENSE</code> variable to a string identifying the
1.322     leot     7421:     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      7422: <pre class="programlisting">
1.100     rillig   7423: LICENSE=        xv-license
1.222     sevan    7424: </pre>
1.87      wiz      7425: <p>When trying to build, the user will get a notice that the
1.98      wiz      7426:     package is covered by a license which has not been placed in the
                   7427:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7428: <pre class="programlisting">
1.100     rillig   7429: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7430: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7431: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7432: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7433: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7434: *** Error code 1
1.222     sevan    7435: </pre>
1.110     hubertf  7436: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7437:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7438:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7439:     convey to pkgsrc that it should not in the future fail because of
                   7440:     that license:</p>
1.78      rillig   7441: <pre class="programlisting">
1.100     rillig   7442: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7443: </pre>
                   7444: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7445:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7446:     is deprecated because it does not crisply refer to a particular
                   7447:     license text.  Another problem with such usage is that it does not
                   7448:     enable a user to tell pkgsrc to proceed for a single package
                   7449:     without also telling pkgsrc to proceed for all packages with that
                   7450:     tag.</p>
                   7451: <div class="sect3">
                   7452: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7453: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7454: <p>When adding a package with a new license, the following steps
                   7455:     are required:</p>
                   7456: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7457: <li class="listitem">
1.284     rillig   7458: <p>Check whether the license qualifies as Free or Open Source by
                   7459:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7460:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7461:     Open Source Initiative</a>.  If this is the case, the filename in
                   7462:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7463:     <code class="filename">-license</code> suffix, and the license name should be
                   7464:     added to:</p>
1.154     rodent   7465: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7466: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7467:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7468: <li class="listitem"><p>default_acceptable_licenses in
                   7469:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7470: </ul></div>
                   7471: </li>
1.284     rillig   7472: <li class="listitem"><p>The license text should be added to
                   7473:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7474:     licenses can be seen in this directory.</p></li>
1.154     rodent   7475: </ol></div>
1.222     sevan    7476: </div>
                   7477: <div class="sect3">
                   7478: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7479: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7480: <p>When the license changes (in a way other than formatting),
1.222     sevan    7481:     make sure that the new license has a different name (e.g.,
1.98      wiz      7482:     append the version number if it exists, or the date).  Just
                   7483:     because a user told pkgsrc to build programs under a previous
                   7484:     version of a license does not mean that pkgsrc should build
1.99      rillig   7485:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7486:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7487:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7488:     approved by either of two bodies (FSF or OSI).</p>
                   7489: </div>
1.75      rillig   7490: </div>
1.148     asau     7491: <div class="sect2">
1.75      rillig   7492: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7493: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7494: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7495:     By declaring the restrictions, package tools can
1.98      wiz      7496:     automatically refrain from e.g. placing binary packages on FTP
                   7497:     sites.</p>
1.222     sevan    7498: <p>There are four possible restrictions, which are
1.98      wiz      7499:     the cross product of sources (distfiles) and binaries not being
                   7500:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7501:     language in any license, and because non-Free licenses tend to be
                   7502:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7503:     CD-ROM.
                   7504: 
                   7505:     "FTP" means making the source or binary file available over the
                   7506:     Internet at no charge.
                   7507: 
                   7508:     "CD-ROM" means making the source or binary available on some kind of
                   7509:     media, together with other source and binary packages, which is sold
                   7510:     for a distribution charge.
1.98      wiz      7511:     </p>
                   7512: <p>In order to encode these restrictions, the package system
1.87      wiz      7513:     defines five make variables that can be set to note these
                   7514:     restrictions:</p>
1.148     asau     7515: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7516: <li class="listitem">
1.75      rillig   7517: <p><code class="varname">RESTRICTED</code></p>
                   7518: <p>This variable should be set whenever a restriction
1.87      wiz      7519:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7520:        string containing the reason for the restriction.  It should
                   7521:        be understood that those wanting to understand the restriction
                   7522:        will have to read the license, and perhaps seek advice of
                   7523:        counsel.</p>
1.75      rillig   7524: </li>
1.128     wiz      7525: <li class="listitem">
1.75      rillig   7526: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7527: <p>Binaries may not be placed on CD-ROM containing other
                   7528:        binary packages, for which a distribution charge may be made.
                   7529:        In this case, set this variable to
                   7530:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7531: </li>
1.128     wiz      7532: <li class="listitem">
1.75      rillig   7533: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7534: <p>Binaries may not made available on the Internet without
                   7535:        charge.  In this case, set this variable to
                   7536:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7537:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7538: </li>
1.128     wiz      7539: <li class="listitem">
1.75      rillig   7540: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7541: <p>Distfiles may not be placed on CD-ROM, together with
                   7542:        other distfiles, for which a fee may be charged.  In this
                   7543:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7544:        </p>
1.75      rillig   7545: </li>
1.128     wiz      7546: <li class="listitem">
1.75      rillig   7547: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7548: <p>Distfiles may not made available via FTP at no charge.
                   7549:        In this case, set this variable to
                   7550:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7551:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7552: </li>
                   7553: </ul></div>
1.222     sevan    7554: <p>Please note that packages will be removed from pkgsrc when the
                   7555:     distfiles are not distributable and cannot be obtained for a period
                   7556:     of one full quarter branch. Packages with manual/interactive fetch
                   7557:     must have a maintainer and it is his/her responsibility to ensure
                   7558:     this.</p>
1.75      rillig   7559: </div>
1.148     asau     7560: <div class="sect2">
1.75      rillig   7561: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7562: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7563: <p>Your package may depend on some other package being present,
                   7564:     and there are various ways of expressing this dependency.
                   7565:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7566:     <code class="varname">BUILD_DEPENDS</code>,
                   7567:     <code class="varname">TOOL_DEPENDS</code>, and
                   7568:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7569:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7570:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7571:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7572:     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 7573: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7574:     definition registers that pre-requisite in the binary package so it
                   7575:     will be pulled in when the binary package is later installed, whilst
                   7576:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7577:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7578:     dependency that is only needed for building or testing the resulting
1.299     rillig   7579:     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   7580: <p>This means that if you only need a package present whilst
1.290     gutterid 7581:     you are building or testing, it should be noted as a
                   7582:     <code class="varname">TOOL_DEPENDS</code>,
                   7583:     <code class="varname">BUILD_DEPENDS</code>, or
                   7584:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7585:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7586:     packages, i.e. packages for the architecture where the package
                   7587:     is built;
                   7588:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7589:     packages, i.e., packages for the architecture for which the package
1.269     leot     7590:     is built.</p>
1.290     gutterid 7591: <p>The format for a <code class="varname">DEPENDS</code>,
                   7592:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7593:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7594: <pre class="programlisting">
1.100     rillig   7595: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7596: </pre>
1.128     wiz      7597: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7598:     may include any of the wildcard version numbers recognized by
1.322     leot     7599:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7600: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7601: <li class="listitem">
1.75      rillig   7602: <p>If your package needs another package's binaries or
1.160     wiz      7603:        libraries to build and run, and if that package has a
1.87      wiz      7604:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7605: <pre class="programlisting">
1.100     rillig   7606: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7607: </pre>
1.75      rillig   7608: </li>
1.128     wiz      7609: <li class="listitem">
1.160     wiz      7610: <p>If your package needs another package's binaries or
                   7611:        libraries only for building, and if that package has a
                   7612:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7613: <pre class="programlisting">
                   7614: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7615: </pre>
1.160     wiz      7616: <p>but set
                   7617:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7618:        to make it a build dependency only. This case is rather
                   7619:        rare.</p>
                   7620: </li>
                   7621: <li class="listitem">
1.132     spz      7622: <p>If your package needs binaries from another package to build,
1.269     leot     7623:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7624: <pre class="programlisting">
1.269     leot     7625: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7626: </pre>
1.75      rillig   7627: </li>
1.269     leot     7628: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7629:        files to include, etc. from another package to build,
                   7630:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7631: <li class="listitem"><p>If your package needs a library with which to link and
                   7632:        there is no <code class="filename">buildlink3.mk</code> file
                   7633:        available, create one. Using
                   7634:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7635:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7636: <li class="listitem">
1.132     spz      7637: <p>If your package needs some executable to be able to run
                   7638:        correctly and if there's no
                   7639:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7640:        using the <code class="varname">DEPENDS</code> variable. The
1.322     leot     7641:        <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      7642:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7643:        when it runs, and that is specified:</p>
1.75      rillig   7644: <pre class="programlisting">
1.242     wiz      7645: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7646: </pre>
1.132     spz      7647: </li>
1.290     gutterid 7648: <li class="listitem"><p>If your package includes a test suite that has extra
                   7649:         dependencies only required for this purpose (frequently this
                   7650:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7651:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7652: <li class="listitem">
                   7653: <p>You can use wildcards in package dependencies. Note that
                   7654:        such wildcard dependencies are retained when creating binary
                   7655:        packages. The dependency is checked when installing the binary
                   7656:        package and any package which matches the pattern will be
                   7657:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7658: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7659:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7660:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7661:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7662: <p>Wildcards can also be used to specify that a package
1.87      wiz      7663:        will only build against a certain minimum version of a
                   7664:        pre-requisite:</p>
1.75      rillig   7665: <pre class="programlisting">
1.132     spz      7666: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7667: </pre>
1.132     spz      7668: <p>This means that the package will build using version 6.0
                   7669:        of ImageMagick or newer. Such a dependency may be warranted
                   7670:        if, for example, the command line options of an executable
                   7671:        have changed.</p>
                   7672: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7673:        set
                   7674:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7675:        to the appropriate pattern before including its
                   7676:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7677: <pre class="programlisting">
                   7678: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7679: .include "../../graphics/jpeg/buildlink3.mk"
                   7680: </pre>
1.75      rillig   7681: <p>For security fixes, please update the package
1.267     rillig   7682:        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      7683:        information.</p>
1.75      rillig   7684: </li>
                   7685: </ol></div>
                   7686: <p>If your package needs files from another package to build,
1.87      wiz      7687:     add the relevant distribution files to
                   7688:     <code class="varname">DISTFILES</code>, so they will be extracted
1.322     leot     7689:     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      7690:     (It relies on the jpeg sources being present in source form
                   7691:     during the build.)</p>
1.75      rillig   7692: </div>
1.148     asau     7693: <div class="sect2">
1.75      rillig   7694: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7695: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7696: <p>Your package may conflict with other packages a user might
1.87      wiz      7697:     already have installed on his system, e.g. if your package
1.88      wiz      7698:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7699:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.322     leot     7700: <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>
                   7701:     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     7702:     install the same shared library, thus you set in
                   7703:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7704: <pre class="programlisting">
                   7705: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7706:     </pre>
                   7707: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7708: <pre class="programlisting">
                   7709: CONFLICTS=      libXaw3d-[0-9]*
                   7710:     </pre>
1.322     leot     7711: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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     7712:     that conflict with existing packages and abort. However, in many
                   7713:     situations this is too late in the process. Binary package managers
                   7714:     will not know about the conflict until they attempt to install the
                   7715:     package after already downloading it and all its dependencies.
                   7716:     Users may also waste time building a package and its dependencies
                   7717:     only to find out at the end that it conflicts with another package
                   7718:     they have installed.</p>
                   7719: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7720:     should be added in all cases where it is known that packages conflict
                   7721:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.322     leot     7722:     exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7723:     managers to inform users that packages cannot be installed onto
                   7724:     the target system.</p>
1.75      rillig   7725: </div>
1.148     asau     7726: <div class="sect2">
1.75      rillig   7727: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7728: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7729: <p>There are several reasons why a package might be
1.88      wiz      7730:     instructed to not build under certain circumstances.  If the
1.87      wiz      7731:     package builds and runs on most platforms, the exceptions
1.193     dholland 7732:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7733:     the package builds and runs on a small handful of platforms,
                   7734:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7735:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7736:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7737:     (OS-version-platform) that can use glob-style
                   7738:     wildcards.</p>
                   7739: <p>If a package is not appropriate for some platforms (as
1.225     maya     7740:     opposed to merely broken), a different set of variables should be
1.193     dholland 7741:     used as this affects failure reporting and statistics.
                   7742:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7743:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7744:     the package is appropriate for only a small handful of platforms
                   7745:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7746:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7747:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7748:     (OS-version-platform) that can use glob-style
                   7749:     wildcards.</p>
1.88      wiz      7750: <p>Some packages are tightly bound to a specific version of an
1.322     leot     7751:     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      7752:     backwards compatible with other versions of the OS, and should be
                   7753:     uploaded to a version specific directory on the FTP server.  Mark
                   7754:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7755:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7756:     the package system internals, but may be used in the
                   7757:     future.</p>
1.75      rillig   7758: <p>If the package should be skipped (for example, because it
1.87      wiz      7759:     provides functionality already provided by the system), set
1.88      wiz      7760:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7761:     the package should fail because some preconditions are not met,
                   7762:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7763:     message.</p>
1.75      rillig   7764: </div>
1.148     asau     7765: <div class="sect2">
1.75      rillig   7766: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7767: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7768: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7769:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7770:     be set in the package Makefile. This will be carried into any
                   7771:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7772:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.322     leot     7773:     not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7774:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7775: </div>
1.148     asau     7776: <div class="sect2">
1.75      rillig   7777: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7778: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7779: <p>When a vulnerability is found, this should be noted in
1.320     wiz      7780:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
                   7781:     Entries in that file consist of three parts:</p>
                   7782: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7783: <li class="listitem"><p>package version pattern</p></li>
                   7784: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   7785: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   7786: </ul></div>
                   7787: <p>For the package version pattern please always use `&lt;' to
                   7788:     mark an upper bound (not `&lt;='!). This will avoid possible
                   7789:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   7790:     related to security fixes. Lower bounds can be added too, using
                   7791:     '&gt;' or '&gt;='. For example,
1.321     wiz      7792:     <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      7793:     versions 1.0 (included) to 1.2 (excluded) of
                   7794:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo</code></span>&#8221;</span> as affected by the security
                   7795:     issue.</p>
                   7796: <p>Entries should always be added at the bottom of the file.</p>
                   7797: <p>When fixing packages, please modify the upper bound of the
                   7798:     corresponding entry. To continue the previous example, if a fix
                   7799:     was backported to version 1.1nb2, change the previous pattern to
1.321     wiz      7800:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>&#8221;</span>.</p>
1.320     wiz      7801: <p>To locally test a package version pattern against a
                   7802:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   7803:     pmatch</strong></span> command.</p>
                   7804: <p>The URL should be as permanent as possible and provide as
                   7805:     much information about the issue as possible.  CVE entries are
                   7806:     preferred.</p>
                   7807: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138     wiz      7808:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7809: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7810:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7811:     course not necessary if the problem is fixed by using a newer
                   7812:     release of the software), and the pattern in the
                   7813:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7814: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7815:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7816: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7817:     semi-automatically by a weekly cron job.</p>
1.320     wiz      7818: <p>In case a security issue is disputed, please contact
                   7819:     pkgsrc-security@NetBSD.org.</p>
1.75      rillig   7820: </div>
1.148     asau     7821: <div class="sect2">
1.75      rillig   7822: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7823: <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   7824: <p>When making fixes to an existing package it can be useful
1.87      wiz      7825:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7826:     avoid conflicting with future versions by the original author, a
1.128     wiz      7827:     <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      7828:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7829:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7830:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7831: <pre class="programlisting">
1.100     rillig   7832: DISTNAME=       foo-17.42
                   7833: PKGREVISION=    9
1.222     sevan    7834: </pre>
1.75      rillig   7835: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7836:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7837:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7838:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7839:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7840: <p>When a new release of the package is released, the
1.87      wiz      7841:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7842:     minor release of the above package, things should be like:</p>
1.75      rillig   7843: <pre class="programlisting">
1.100     rillig   7844: DISTNAME=       foo-17.43
1.222     sevan    7845: </pre>
1.87      wiz      7846: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7847:     non-trivial change in the resulting binary package.  Without a
                   7848:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7849:     version installed has no way of knowing that their package is out
                   7850:     of date.  Thus, changes without increasing
                   7851:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7852:     trivial that no reasonable person would want to upgrade", and this
                   7853:     is the rough test for when increasing
                   7854:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7855:     changes that do not merit increasing
                   7856:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7857: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7858: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7859:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7860:       comments in Makefile.</p></li>
                   7861: <li class="listitem"><p>Changing build variables if the resulting binary
                   7862:       package is the same.</p></li>
                   7863: <li class="listitem"><p>Changing
                   7864:       <code class="filename">DESCR</code>.</p></li>
                   7865: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7866:       default options don't change.</p></li>
1.100     rillig   7867: </ul></div>
1.87      wiz      7868: <p>Examples of changes that do merit an increase to
                   7869:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7871: <li class="listitem"><p>Security fixes</p></li>
                   7872: <li class="listitem"><p>Changes or additions to a patch
                   7873:       file</p></li>
                   7874: <li class="listitem"><p>Changes to the
                   7875:       <code class="filename">PLIST</code></p></li>
                   7876: <li class="listitem"><p>A dependency is changed or
                   7877:       renamed.</p></li>
1.100     rillig   7878: </ul></div>
1.78      rillig   7879: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7880:     changes.</p>
1.75      rillig   7881: </div>
1.148     asau     7882: <div class="sect2">
1.79      rillig   7883: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7884: <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   7885: <p>When you want to replace the same text in multiple files, or
                   7886: multiple times in the same file, it is cumbersome to maintain a patch
                   7887: file for this. This is where the SUBST framework steps in. It provides an
                   7888: easy-to-use interface for replacing text in files. It just needs the
                   7889: following information:</p>
                   7890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7891: <li class="listitem"><p>In which phase of the package build cycle should the
                   7892: replacement happen?</p></li>
                   7893: <li class="listitem"><p>In which files should the replacement
1.287     rillig   7894: happen?</p></li>
1.295     rillig   7895: <li class="listitem"><p>Which text should be replaced with
                   7896: what?</p></li>
1.287     rillig   7897: </ul></div>
                   7898: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   7899: variables. A minimal example is:</p>
                   7900: <pre class="programlisting">
                   7901: SUBST_CLASSES+=         paths
                   7902: SUBST_STAGE.paths=      pre-configure
                   7903: SUBST_FILES.paths=      src/*.c
                   7904: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7905: </pre>
                   7906: <p>Translated into English, it means: In the pre-configure stage (that
                   7907: is, after applying the patches from the patches/ directory and before
                   7908: running the configure script and the portability check), replace the text
                   7909: <code class="literal">/usr/local</code> with the content of the variable
                   7910: <code class="varname">PREFIX</code>.</p>
                   7911: <p>Each SUBST block starts by appending an identifier to
                   7912: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7913: identifier can be chosen freely by the package. If there should ever be
                   7914: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7915: early, so don't worry about name collisions.</p>
                   7916: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7917: SUBST block are parameterized using this identifier. In the remainder of
                   7918: this section, these parameterized variables are written as
                   7919: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7920: <pre class="programlisting">
                   7921: SUBST_CLASSES+=         paths
                   7922: SUBST_STAGE.paths=      pre-configure
                   7923: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7924: SUBST_FILES.paths=      src/*.c
                   7925: SUBST_FILES.paths+=     scripts/*.sh
                   7926: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7927: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7928: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7929: </pre>
                   7930: <p>To get a complete picture about the SUBST substitutions, run
                   7931: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7932: expected, run pkglint on the package, which detects several typical
                   7933: mistakes surrounding the SUBST blocks. For any questions that might
                   7934: remain after this, have a look at
                   7935: <code class="filename">mk/subst.mk</code>.</p>
                   7936: <div class="sect3">
                   7937: <div class="titlepage"><div><div><h4 class="title">
                   7938: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7939: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7940: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7941: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7942: popular stages are, in chronological order:</p>
                   7943: <div class="variablelist"><dl class="variablelist">
                   7944: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7945: <dd>
                   7946: <p>The substitutions are applied immediately after the
                   7947: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7948: package will leave no traces of the original files.</p>
                   7949: <p>When the substitution applies to files for which there is also a
                   7950: patch in the <code class="filename">patches/</code> directory, this means that the
                   7951: patches will be computed based on the result of the substitution. When
                   7952: these patches are sent to the upstream maintainer later, to be fixed in
                   7953: the upstream package, these patches may no longer match what the upstream
                   7954: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7955: often a better choice.</p>
                   7956: </dd>
                   7957: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7958: <dd>
                   7959: <p>The substitutions are applied after the patches from the
                   7960: <code class="filename">patches/</code> directory. This makes it possible to run
                   7961: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322     leot     7962: 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   7963: <p>When updating the patches, it is helpful to explicitly separate the
                   7964: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7965: configure</strong></span>, and to only edit the patches between these commands.
                   7966: Otherwise the substitutions from the SUBST block will end up in the patch
                   7967: file. When this happens in really obvious ways, pkglint will complain
                   7968: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7969: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7970: can only detect these really obvious
                   7971: cases.</p>
                   7972: </dd>
                   7973: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7974: <dd><p>This stage should only be used if the package defines a
                   7975: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7976: happen after that. Typical examples are packages that use the
                   7977: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7978: script from
                   7979: <code class="filename">configure.ac</code>.</p></dd>
                   7980: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7981: <dd><p>This stage is used to fix up any mistakes by the
                   7982: configure stage.</p></dd>
                   7983: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7984: <dd><p>This stage should only be used for substitutions that are
                   7985: clearly related to building the package, not for fixing the
                   7986: configuration. Substitutions for pathnames (such as replacing
                   7987: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   7988: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   7989: actual username) belong in pre-configure or post-configure
                   7990: instead.</p></dd>
                   7991: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   7992: <dd>
                   7993: <p>Just as with pre-build, this stage should only be used
                   7994: for substitutions that are clearly related to building the package, not
                   7995: for fixing the configuration. Substitutions for pathnames (such as
                   7996: replacing <code class="filename">/usr/local</code> with
                   7997: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   7998: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   7999: pre-configure or post-configure instead.</p>
                   8000: <p>A typical use is to update pkg-config files to include the rpath
                   8001: compiler options.</p>
                   8002: </dd>
                   8003: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8004: <dd><p>In general, the install phase should be as simple as
                   8005: possible. As with the pre-build and post-build stages, it should not be
                   8006: used to fix pathnames or user names, these belong in pre-configure
                   8007: instead. There are only few legitimate use cases for applying
                   8008: substitutions in this stage.</p></dd>
                   8009: </dl></div>
                   8010: </div>
                   8011: <div class="sect3">
                   8012: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   8013: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   8014: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8015: filename patterns. These patterns are relative to
                   8016: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8017: A typical example is:</p>
                   8018: <pre class="programlisting">
                   8019: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8020: </pre>
                   8021: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8022: implementation checks that each filename pattern that is mentioned here
                   8023: has an effect. For example, if none of the
                   8024: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8025: and substituted, that filename pattern is redundant and should be left
1.296     rillig   8026: out. By default, the SUBST framework will complain with an error message.
                   8027: If the text to be substituted occurs in some of the files from a single
                   8028: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   8029: framework will only print an INFO message for those files.</p>
                   8030: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   8031: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   8032: <p>Another popular way of choosing the files for the substitutions is
                   8033: via a shell command, like this:</p>
                   8034: <pre class="programlisting">
1.296     rillig   8035: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8036: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8037: </pre>
                   8038: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8039: freely chosen and independent of the SUBST framework.</p>
                   8040: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8041: lists each file individually. Thereby chances are higher that there are
                   8042: filename patterns in which no substitution happens. Since the SUBST
                   8043: framework cannot know whether the filename patterns in
                   8044: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8045: Makefile (where any redundant filename pattern would be suspicious) or
                   8046: been generated by a shell command (in which redundant filename patterns
                   8047: are more likely and to be expected), it will complain about these
                   8048: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8049: command to generate the list of filename patterns often need to set
                   8050: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8051: </div>
                   8052: <div class="sect3">
                   8053: <div class="titlepage"><div><div><h4 class="title">
                   8054: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8055: <p>In most cases, the substitutions are given using one or more
1.322     leot     8056: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8057: <pre class="programlisting">
                   8058: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8059: </pre>
                   8060: <p>Each of the sed commands needs to be preceded by the
                   8061: <code class="literal">-e</code> option and should be specified on a line of its
                   8062: own, to avoid hiding short sed commands at the end of a line.</p>
                   8063: <p>Since the sed commands often contain shell metacharacters as the
                   8064: separator (the <code class="literal">|</code> in the above example), it is common
                   8065: to enclose them in single quotes.</p>
                   8066: <p>A common substitution is to replace placeholders of the form
                   8067: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8068: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8069: <pre class="programlisting">
                   8070: SUBST_VARS.path=        PREFIX
                   8071: </pre>
                   8072: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8073: scripts during the do-configure stage, but in some cases these need to be
                   8074: overridden. The same pattern is also used when a package defines patches
                   8075: that replace previously hard-coded paths like
                   8076: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8077: placeholder first, which then gets substituted by the actual
                   8078: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8079: cases, it works equally well to just use the SUBST framework to directly
                   8080: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8081: thereby omitting the intermediate patch file.</p>
1.295     rillig   8082: <p>If the above is not flexible enough, it is possible to not use sed
                   8083: at all for the substitution but to specify an entirely different command,
                   8084: like this:</p>
1.87      wiz      8085: <pre class="programlisting">
1.295     rillig   8086: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8087: </pre>
                   8088: <p>This is used for the few remaining packages in which the
                   8089: distributed files use Windows-style line endings that need to be
                   8090: converted to UNIX-style line endings.</p>
                   8091: </div>
                   8092: <div class="sect3">
                   8093: <div class="titlepage"><div><div><h4 class="title">
                   8094: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8095: <p>When a SUBST block is applied during a package build, a message is
                   8096: logged. The default message is fine for most purposes but can be
                   8097: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8098: message.</p>
                   8099: </div>
1.79      rillig   8100: </div>
1.75      rillig   8101: </div>
1.148     asau     8102: <div class="sect1">
1.75      rillig   8103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8104: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8105: <div class="sect2">
1.75      rillig   8106: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8107: <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   8108: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8109:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8110:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8111:     with the name of each file to download as an argument, expecting
                   8112:     it to output the URL of the directory from which to download
1.322     leot     8113:     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      8114:     example of this usage.</p>
1.75      rillig   8115: <p>If the download can't be automated, because the user must
1.87      wiz      8116:     submit personal information to apply for a password, or must pay
                   8117:     for the source, or whatever, you can set
                   8118:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8119:     displayed to the user before aborting the build. Example:</p>
                   8120: <pre class="programlisting">
1.100     rillig   8121: FETCH_MESSAGE=  "Please download the files"
                   8122: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8123: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8124: </pre>
1.75      rillig   8125: </div>
1.148     asau     8126: <div class="sect2">
1.75      rillig   8127: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8128: <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   8129: <p>Sometimes authors of a software package make some
1.87      wiz      8130:     modifications after the software was released, and they put up a
                   8131:     new distfile without changing the package's version number. If a
                   8132:     package is already in pkgsrc at that time, the checksum will
                   8133:     no longer match. The contents of the new distfile should be
                   8134:     compared against the old one before changing anything, to make
                   8135:     sure the distfile was really updated on purpose, and that
                   8136:     no trojan horse or so crept in.
1.97      rillig   8137:     Please mention that the distfiles were compared and what was found
1.159     rodent   8138:     in your commit message.</p>
1.220     wiz      8139: <p>Then, the correct way to work around this is to set
                   8140:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8141:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8142:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8143:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8144:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8145:     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      8146:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8147:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8148:     be appended, like
                   8149:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8150: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8151:     name does not contain a version and the distfile is apt to change. In
                   8152:     cases where the likelihood of this is very small,
                   8153:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8154:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8155:     distfile name changes, even if a package is being moved or
                   8156:     renamed.</p>
1.159     rodent   8157: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8158:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8159:     path in the filenames.
1.159     rodent   8160:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8161:     Furthermore, a mail to the package's authors seems appropriate
                   8162:     telling them that changing distfiles after releases without
                   8163:     changing the file names is not good practice.</p>
1.75      rillig   8164: </div>
1.199     tnn      8165: <div class="sect2">
                   8166: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8167: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8168: <p>Helper methods exist for packages hosted on github.com which
                   8169:     will often have distfile names that clash with other packages, for
                   8170:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8171:     from below:</p>
1.199     tnn      8172: <div class="sect3">
                   8173: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8174: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8175: <p>If your distfile URL looks similar to
1.303     bacon    8176:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8177:       then you are packaging a tagged release.</p>
1.199     tnn      8178: <pre class="programlisting">
1.303     bacon    8179: DISTNAME=       example-1.0
1.200     tnn      8180: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8181: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8182: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8183: EXTRACT_SUFX=   .zip
                   8184: </pre>
                   8185: </div>
                   8186: <div class="sect3">
                   8187: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8188: <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>
                   8189: <p>If your distfile looks similar to
                   8190:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8191:       release, then set the package version to 0.0.0.N, where N is the number
                   8192:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8193:       This will (almost) ensure that the first tagged release will have a
                   8194:       version greater than this one so that package upgrades will function
                   8195:       properly.</p>
                   8196: <pre class="programlisting">
                   8197: DISTNAME=       example-0.0.0.347
                   8198: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8199: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8200: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8201: </pre>
                   8202: </div>
                   8203: <div class="sect3">
                   8204: <div class="titlepage"><div><div><h4 class="title">
                   8205: <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>
                   8206: <p>If your distfile looks similar to
                   8207:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8208:       then include the last release version and the commit count since that
                   8209:       release in the package version and set GITHUB_TAG to the commit hash.
                   8210:       The latest release and commit count are shown in the output of
                   8211:       "git describe --tags":
                   8212:       </p>
                   8213: <pre class="screen">
                   8214: # git clone https://github.com/username/example
                   8215: # cd example
                   8216: # git describe --tags
                   8217: 1.2.3-5-g988881a
                   8218: </pre>
1.199     tnn      8219: <pre class="programlisting">
1.303     bacon    8220: DISTNAME=       example-1.2.3.5
                   8221: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8222: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8223: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8224: </pre>
1.199     tnn      8225: </div>
                   8226: <div class="sect3">
                   8227: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8228: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8229: <p>If your distfile URL looks similar to
1.303     bacon    8230:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8231:       then you are packaging a release.</p>
1.199     tnn      8232: <pre class="programlisting">
                   8233: DISTNAME=       offensive-1.6
1.200     tnn      8234: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8235: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8236: GITHUB_PROJECT= example
1.200     tnn      8237: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8238: EXTRACT_SUFX=   .zip
1.222     sevan    8239: </pre>
1.199     tnn      8240: </div>
                   8241: </div>
1.75      rillig   8242: </div>
1.148     asau     8243: <div class="sect1">
1.75      rillig   8244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8245: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8246: <div class="sect2">
1.75      rillig   8247: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8248: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8249: <p>pkgsrc supports many different machines, with different
1.87      wiz      8250:     object formats like a.out and ELF, and varying abilities to do
                   8251:     shared library and dynamic loading at all. To accompany this,
                   8252:     varying commands and options have to be passed to the
                   8253:     compiler, linker, etc. to get the Right Thing, which can be
                   8254:     pretty annoying especially if you don't have all the machines
                   8255:     at your hand to test things.  The
1.322     leot     8256:     <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      8257:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8258:     both static and dynamic libraries from a set of source files,
                   8259:     thus being platform-independent.</p>
                   8260: <p>Here's how to use libtool in a package in seven simple
                   8261:     steps:</p>
1.128     wiz      8262: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8263: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8264:        Makefile.</p></li>
1.128     wiz      8265: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8266:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8267:        add it to the definition of <code class="varname">CC</code>, if only
                   8268:        libraries are being built in a given Makefile. This one command
                   8269:        will build both PIC and non-PIC library objects, so you need not
                   8270:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8271: <li class="listitem">
1.75      rillig   8272: <p>For the linking of the library, remove any
1.128     wiz      8273:        <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
                   8274:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8275: <pre class="programlisting">
1.100     rillig   8276: ${LIBTOOL} --mode=link \
                   8277:     ${CC} -o ${.TARGET:.a=.la} \
                   8278:         ${OBJS:.o=.lo} \
                   8279:         -rpath ${PREFIX}/lib \
                   8280:         -version-info major:minor
1.222     sevan    8281: </pre>
1.75      rillig   8282: <p>Note that the library is changed to have a
1.87      wiz      8283:        <code class="filename">.la</code> extension, and the objects are
                   8284:        changed to have a <code class="filename">.lo</code>
                   8285:        extension. Change <code class="varname">OBJS</code> as
                   8286:        necessary. This automatically creates all of the
                   8287:        <code class="filename">.a</code>,
                   8288:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8289:        necessary) in the build directory. Be sure to include
1.128     wiz      8290:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8291:        minor are zero, as libtool will otherwise strip off the
                   8292:        shared library version.</p>
1.75      rillig   8293: <p>From the libtool manual:</p>
                   8294: <pre class="programlisting">
1.100     rillig   8295: So, libtool library versions are described by three integers:
1.69      rillig   8296: 
1.100     rillig   8297: CURRENT
                   8298: The most recent interface number that this library implements.
1.69      rillig   8299: 
1.100     rillig   8300: REVISION
                   8301: The implementation number of the CURRENT interface.
1.69      rillig   8302: 
1.100     rillig   8303: AGE
                   8304: The difference between the newest and oldest interfaces that
                   8305: this library implements.  In other words, the library implements
                   8306: all the interface numbers in the range from number `CURRENT -
                   8307: AGE' to `CURRENT'.
1.1       grant    8308: 
1.100     rillig   8309: If two libraries have identical CURRENT and AGE numbers, then the
                   8310: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8311: </pre>
1.128     wiz      8312: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8313:        different results for a.out and ELF (excluding symlinks)
                   8314:        in only one case. An ELF library of the form
1.128     wiz      8315:        <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      8316:        will have a symlink of
1.128     wiz      8317:        <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      8318:        on an a.out platform. This is handled
                   8319:        automatically.</p>
1.128     wiz      8320: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8321:        directory of the library being built.</p>
1.76      rillig   8322: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8323:        <code class="filename">.la</code> file, the other files will be
                   8324:        added automatically.</p>
1.75      rillig   8325: </li>
1.128     wiz      8326: <li class="listitem">
1.76      rillig   8327: <p>When linking shared object (<code class="filename">.so</code>)
1.322     leot     8328:        files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8329:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8330:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8331:        tacked on.</p>
1.76      rillig   8332: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8333:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8334: </li>
1.128     wiz      8335: <li class="listitem">
1.75      rillig   8336: <p>When linking programs that depend on these libraries
1.87      wiz      8337:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.322     leot     8338:        the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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      8339:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8340:        libraries (static or shared), but please be aware that
                   8341:        libtool will not allow you to specify a relative path in
1.128     wiz      8342:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8343:        expects you to change that argument to be the
                   8344:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8345: <pre class="programlisting">
1.100     rillig   8346: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8347: </pre>
1.75      rillig   8348: <p>should be changed to:</p>
                   8349: <pre class="programlisting">
1.100     rillig   8350: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8351: </pre>
1.75      rillig   8352: <p>and it will do the right thing with the libraries.</p>
                   8353: </li>
1.128     wiz      8354: <li class="listitem">
1.322     leot     8355: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8356:        or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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      8357:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8358:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8359: <pre class="programlisting">
1.126     jakllsch 8360: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8361: </pre>
1.76      rillig   8362: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8363:        shared library, any needed symlinks, and run
1.322     leot     8364:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8365: </li>
1.128     wiz      8366: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8367:        the <code class="filename">.la</code>
                   8368:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8369: </ol></div>
                   8370: </div>
1.148     asau     8371: <div class="sect2">
1.75      rillig   8372: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8373: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8374: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8375:     package Makefile. This will override the package's own libtool
                   8376:     in most cases.  For older libtool using packages,  libtool is
                   8377:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8378:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8379:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8380: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8381:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8382:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8383:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8384:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8385: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8386:     libraries built and installed, then use
                   8387:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8388: <p>If your package makes use of the platform-independent library
1.87      wiz      8389:     for loading dynamic shared objects, that comes with libtool
                   8390:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8391: <p>Some packages use libtool incorrectly so that the package
                   8392:     may not work or build in some circumstances. Some of the more
                   8393:     common errors are:</p>
1.148     asau     8394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8395: <li class="listitem">
1.75      rillig   8396: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8397:        executable or library. This in itself isn't a problem if one of two things
                   8398:        has been done:</p>
1.128     wiz      8399: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8400: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8401:            <code class="filename">libfoo.la</code>, not
                   8402:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8403: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8404: </ol></div>
                   8405: </li>
1.128     wiz      8406: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8407:        The function lt_dlinit() should be called and the macro
                   8408:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8409:        executables.</p></li>
1.75      rillig   8410: </ul></div>
                   8411: </div>
1.148     asau     8412: <div class="sect2">
1.75      rillig   8413: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8414: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8415: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8416:     to regenerate the configure script and Makefile.in makefile
                   8417:     templates, then they should be executed in a pre-configure
                   8418:     target.</p>
1.75      rillig   8419: <p>For packages that need only autoconf:</p>
                   8420: <pre class="programlisting">
1.100     rillig   8421: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8422: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8423: ...
1.1       grant    8424: 
1.100     rillig   8425: pre-configure:
                   8426:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8427: 
1.100     rillig   8428: ...
1.222     sevan    8429: </pre>
1.75      rillig   8430: <p>and for packages that need automake and autoconf:</p>
                   8431: <pre class="programlisting">
1.100     rillig   8432: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8433: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8434: ...
                   8435: 
                   8436: pre-configure:
                   8437:         set -e; cd ${WRKSRC}; \
                   8438:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8439: 
1.100     rillig   8440: ...
1.222     sevan    8441: </pre>
1.75      rillig   8442: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8443:     require GNU Make.</p>
1.75      rillig   8444: <p>There are times when the configure process makes
1.87      wiz      8445:     additional changes to the generated files, which then causes
                   8446:     the build process to try to re-execute the automake sequence.
                   8447:     This is prevented by touching various files in the configure
                   8448:     stage. If this causes problems with your package you can set
                   8449:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8450:     Makefile.</p>
1.75      rillig   8451: </div>
                   8452: </div>
1.148     asau     8453: <div class="sect1">
1.75      rillig   8454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8455: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8456: <div class="sect2">
1.87      wiz      8457: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8458: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8459: <p>Compilers for the C, C++, and Fortran languages comes with
                   8460:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8461:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8462:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8463: <p>To declare which language's compiler a package needs, set
                   8464:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327     wiz      8465:     currently are:
                   8466:     </p>
                   8467: <pre class="programlisting">
                   8468:        c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
                   8469:        c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
                   8470:        fortran77, java, objc, obj-c++, and ada.
                   8471:     </pre>
                   8472: <p>
                   8473:     (and any combination).  The default is
1.128     wiz      8474:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8475:     written in C++, usually need a C compiler for the configure
                   8476:     phase.</p>
                   8477: </div>
1.148     asau     8478: <div class="sect2">
1.87      wiz      8479: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8480: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8481: <p>If a program is written in Java, use the Java framework in
                   8482:     pkgsrc.  The package must include
                   8483:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8484:     provides the following variables:</p>
1.148     asau     8485: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8486: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8487:       dependency on the JDK is added.  If
1.128     wiz      8488:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8489:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8490:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8491:       JDK.</p></li>
1.128     wiz      8492: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8493:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8494:       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
                   8495:       <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
                   8496:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8497:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8498:       above. This variable is not set by default.</p></li>
1.130     wiz      8499: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8500:       automatically set to the runtime location of the used Java
                   8501:       implementation dependency. It may be used to set
                   8502:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8503:       needs this variable to be defined.
                   8504:       </p></li>
1.87      wiz      8505: </ul></div>
                   8506: </div>
1.148     asau     8507: <div class="sect2">
1.87      wiz      8508: <div class="titlepage"><div><div><h3 class="title">
1.320     wiz      8509: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
                   8510: <p>If a program is written in Go and has any dependencies on
                   8511:     other Go modules, have the package include
                   8512:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8513: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8514: <li class="listitem"><p>Generate a list of those dependencies with
                   8515:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8516:       go-modules.mk</strong></span>.</p></li>
                   8517: <li class="listitem">
                   8518: <p>Prepend </p>
                   8519: <pre class="programlisting">.include
                   8520:       "go-modules.mk"</pre>
                   8521: <p> to any other
                   8522:       </p>
                   8523: <pre class="programlisting">.include</pre>
                   8524: <p>s.</p>
                   8525: </li>
                   8526: <li class="listitem"><p>Incorporate these modules in
                   8527:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8528:       makesum</strong></span>.</p></li>
                   8529: </ol></div>
                   8530: </div>
                   8531: <div class="sect2">
                   8532: <div class="titlepage"><div><div><h3 class="title">
                   8533: <a name="perl-scripts"></a>21.4.4. Packages containing Perl scripts</h3></div></div></div>
1.318     nia      8534: <p>If your package contains interpreted Perl scripts, add
1.128     wiz      8535:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8536:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8537:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8538:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8539:     that you want adjusted. Every occurrence of
                   8540:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325     gutterid 8541:     replaced with the full path to the Perl executable.</p>
                   8542: <p>If a particular version of Perl is needed, set the
1.87      wiz      8543:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8544:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.318     nia      8545: <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 8546:     about handling Perl modules.</p>
                   8547: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8548:     for the language now known as Raku.</p>
1.87      wiz      8549: </div>
1.148     asau     8550: <div class="sect2">
1.87      wiz      8551: <div class="titlepage"><div><div><h3 class="title">
1.320     wiz      8552: <a name="shell-scripts"></a>21.4.5. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8553: <p><code class="varname">REPLACE_SH</code>,
                   8554:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8555:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309     gutterid 8556:     hash bangs in files. Please use the appropriate one, preferring
1.147     wiz      8557:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8558:     Each should contain a list of scripts, relative to
                   8559:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8560:     occurrence of the matching shell in a she-bang line will be
                   8561:     replaced with the full path to the shell executable.
1.147     wiz      8562:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8563:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8564: </div>
1.148     asau     8565: <div class="sect2">
1.147     wiz      8566: <div class="titlepage"><div><div><h3 class="title">
1.320     wiz      8567: <a name="other-programming-languages"></a>21.4.6. Other programming languages</h3></div></div></div>
1.325     gutterid 8568: <p>There are further similar REPLACE variables available, e.g.,
                   8569:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8570:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326     gutterid 8571:     noted above, have their actions defined centrally in
1.325     gutterid 8572:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326     gutterid 8573:     languages define the actions of these variables within their own
                   8574:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
                   8575:     actioned in <code class="filename">lang/php/phpversion.mk</code>, and
                   8576:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325     gutterid 8577:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8578:     consult the mk files found within their specific directories (the
1.331     gutterid 8579:     naming convention varies), or check the list found in
                   8580:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325     gutterid 8581: <p>Currently, special handling for other languages varies
1.87      wiz      8582:     in pkgsrc.  If a compiler package provides a
                   8583:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8584:     just add a (build) dependency on the appropriate compiler
                   8585:     package.</p>
                   8586: </div>
                   8587: </div>
1.148     asau     8588: <div class="sect1">
1.87      wiz      8589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8590: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8591: <p>The most common failures when building a package are that
                   8592:        some platforms do not provide certain header files, functions or
                   8593:        libraries, or they provide the functions in a library that the
                   8594:        original package author didn't know. To work around this, you
                   8595:        can rewrite the source code in most cases so that it does not
                   8596:        use the missing functions or provides a replacement function.</p>
1.148     asau     8597: <div class="sect2">
1.77      rillig   8598: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8599: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8600: <p>If a package already comes with a GNU configure script, the
                   8601:        preferred way to fix the build failure is to change the
                   8602:        configure script, not the code. In the other cases, you can
                   8603:        utilize the C preprocessor, which defines certain macros
                   8604:        depending on the operating system and hardware architecture it
                   8605:        compiles for. These macros can be queried using for example
                   8606:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8607:        system, hardware architecture and compiler has its own macro.
                   8608:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8609:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8610:        are all defined, you know that you are using NetBSD on an i386
                   8611:        compatible CPU, and your compiler is GCC.</p>
                   8612: <p>The list of the following macros for hardware and
                   8613:        operating system depends on the compiler that is used. For
                   8614:        example, if you want to conditionally compile code on Solaris,
                   8615:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8616:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8617: <div class="sect3">
1.75      rillig   8618: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8619: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8620: <p>To distinguish between 4.4 BSD-derived systems and the
                   8621:         rest of the world, you should use the following code.</p>
                   8622: <pre class="programlisting">
1.100     rillig   8623: #include &lt;sys/param.h&gt;
                   8624: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8625: /* BSD-specific code goes here */
                   8626: #else
                   8627: /* non-BSD-specific code goes here */
                   8628: #endif
1.75      rillig   8629: </pre>
1.77      rillig   8630: <p>If this distinction is not fine enough, you can also test
                   8631:        for the following macros.</p>
1.75      rillig   8632: <pre class="programlisting">
1.151     obache   8633: Cygwin      __CYGWIN__
                   8634: DragonFly   __DragonFly__
1.100     rillig   8635: FreeBSD     __FreeBSD__
1.151     obache   8636: Haiku       __HAIKU__
1.100     rillig   8637: Interix     __INTERIX
                   8638: IRIX        __sgi (TODO: get a definite source for this)
                   8639: Linux       linux, __linux, __linux__
1.193     dholland 8640: Mac OS X    __APPLE__
1.151     obache   8641: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8642: Minix3      __minix
1.100     rillig   8643: NetBSD      __NetBSD__
                   8644: OpenBSD     __OpenBSD__
                   8645: Solaris     sun, __sun
1.75      rillig   8646: </pre>
                   8647: </div>
1.148     asau     8648: <div class="sect3">
1.75      rillig   8649: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8650: <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   8651: <pre class="programlisting">
1.100     rillig   8652: i386        i386, __i386, __i386__
                   8653: MIPS        __mips
                   8654: SPARC       sparc, __sparc
1.75      rillig   8655: </pre>
                   8656: </div>
1.148     asau     8657: <div class="sect3">
1.75      rillig   8658: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8659: <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   8660: <pre class="programlisting">
1.100     rillig   8661: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8662: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8663: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8664: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8665: </pre>
                   8666: </div>
                   8667: </div>
1.148     asau     8668: <div class="sect2">
1.78      rillig   8669: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8670: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8671: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8672:         combinations of compiler version and architecture and almost
                   8673:         always relation to optimisation being enabled.  Common symptoms
                   8674:         are gcc internal errors or never finishing compiling a
1.78      rillig   8675:        file.</p>
                   8676: <p>Typically, a workaround involves testing the
                   8677:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8678:         optimisation for that combination of file,
1.198     tnn      8679:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8680: <p>This used to be a big problem in the past, but is rarely
                   8681:        needed now as compiler technology has matured. If you still need
                   8682:        to add a compiler specific workaround, please do so in the file
                   8683:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8684:        compiler version as detailed as possible.</p>
1.78      rillig   8685: </div>
1.148     asau     8686: <div class="sect2">
1.78      rillig   8687: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8688: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8689: <p>Compilation sometimes fails with an error message like this:</p>
                   8690: <pre class="programlisting">
                   8691: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8692:     fatal error: pango/pango.h: No such file or directory
                   8693: </pre>
                   8694: <p>The proper way to fix this problem depends on the type of the
                   8695: header, which is described in the following sections.</p>
                   8696: <div class="sect3">
                   8697: <div class="titlepage"><div><div><h4 class="title">
                   8698: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8699: <p>If the header name looks like it comes from a different package,
                   8700: that other package should be included via the buildlink3
                   8701: framework.</p>
                   8702: <p>First, look whether the header is somewhere in the buildlink3
                   8703: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8704: the missing Pango header:</p>
                   8705: <pre class="programlisting">
                   8706: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8707: </pre>
                   8708: <p>In the case of Pango, the output is:</p>
                   8709: <pre class="programlisting">
                   8710: work/.buildlink/include/pango-1.0/pango/pango.h
                   8711: </pre>
                   8712: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8713: in the <code class="filename">.buildlink</code> directory, it would have been
                   8714: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8715: path component though, which means that the compiler command line must
                   8716: contain an option of the form
                   8717: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8718: most cases this option is generated by the configure script, which can be examined using:</p>
                   8719: <pre class="programlisting">
                   8720: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8721: -I/usr/pkg/include/pango-1.0
                   8722: -I/usr/pkg/include/pango-1.0
                   8723: -I/usr/pkg/include/pango-1.0
                   8724: -I/usr/pkg/include/pango-1.0
                   8725: -I/usr/pkg/include/pango-1.0
                   8726: </pre>
                   8727: <p>This looks good. These options are transformed by the buildlink
                   8728: wrapper to refer to the correct path inside
                   8729: <code class="filename">work/.buildlink</code>.</p>
                   8730: <p>Since the compilation fails though, examine the compiler command
                   8731: lines in <code class="filename">work/.work.log</code> to see whether the
                   8732: <code class="literal">-I</code> option is included in the particular command
                   8733: line.</p>
                   8734: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8735: build-env</strong></span>, which sets up an interactive, realistic environment
                   8736: including all the pkgsrc wrapper commands and environment variables. From
                   8737: there, try to compile some simple example programs that use the
                   8738: header.</p>
                   8739: </div>
                   8740: <div class="sect3">
                   8741: <div class="titlepage"><div><div><h4 class="title">
                   8742: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8743: <p>If the name of the header seems to come from the package itself,
                   8744: and if the build is run with parallel jobs, the package may have some
                   8745: undeclared dependencies between the <code class="filename">.c</code> and the
                   8746: <code class="filename">.h</code> files, and a C file is compiled before its
                   8747: required header is generated.</p>
                   8748: <p>To see whether the build runs with parallel jobs, run
                   8749: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8750: like this:</p>
                   8751: <pre class="programlisting">
                   8752:   usr   MAKE_JOBS=              7
                   8753:   pkg   MAKE_JOBS_SAFE          # undefined
                   8754:   def   _MAKE_JOBS_N=           7
                   8755: </pre>
                   8756: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8757: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8758: package could have disabled parallel builds by setting
                   8759: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8760: in this case it hasn't.</p>
                   8761: <p>To see whether the build failure is caused by parallel builds,
                   8762: first save the exact error message and a bit of context, maybe you need
                   8763: it later for reporting a bug. Next, run:</p>
                   8764: <pre class="programlisting">
                   8765: MAKE_JOBS_SAFE=no bmake clean build
                   8766: </pre>
                   8767: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8768: report</a> against the pkgsrc package, including the exact error
                   8769: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8770: </div>
1.288     rillig   8771: <div class="sect3">
                   8772: <div class="titlepage"><div><div><h4 class="title">
                   8773: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8774: <p>Pkgsrc does not work reliably if any of
                   8775: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8776: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8777: bootstrap program prevents installing pkgsrc in symlink-based
                   8778: directories. Existing pkgsrc installations are not checked for symlinks
                   8779: though.</p>
                   8780: <p>The "No such file or directory" error messages are a typical
                   8781: symptom of symlinks, and it's quite difficult to find out that this is
                   8782: the actual cause.</p>
                   8783: </div>
                   8784: <div class="sect3">
                   8785: <div class="titlepage"><div><div><h4 class="title">
                   8786: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8787: <p>When building a hierarchy of packages, it may happen that one
                   8788: package is built and then pkgsrc is updated. This situation can provoke
                   8789: various hard to diagnose build errors. To clean up the situation:</p>
                   8790: <pre class="programlisting">
                   8791: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8792: </pre>
                   8793: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8794: this command in the wrong directory.)</p>
                   8795: <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
                   8796: that directory as well.</p>
                   8797: </div>
                   8798: <div class="sect3">
                   8799: <div class="titlepage"><div><div><h4 class="title">
                   8800: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8801: <p>On platforms other than BSD, third-party packages are installed in
                   8802: <code class="filename">/usr/include</code>, together with the base system. This
                   8803: means that pkgsrc cannot distinguish between headers provided by the base
                   8804: system (which it needs) and headers from third-party packages (which are
                   8805: often included in pkgsrc as well). This can lead to subtle version
                   8806: mismatches.</p>
                   8807: <p>In pkgsrc installations that have been active for several years, it
                   8808: may happen that some files are manually deleted. To exclude this unlikely
                   8809: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8810: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8811: check/fix dependencies.</p>
                   8812: <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>
                   8813: for contact information. Be prepared to describe what you have tried so
                   8814: far and what any error messages were.</p>
                   8815: </div>
1.287     rillig   8816: </div>
                   8817: <div class="sect2">
                   8818: <div class="titlepage"><div><div><h3 class="title">
                   8819: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8820: </h3></div></div></div>
1.92      rillig   8821: <p>This error message often means that a package did not
1.78      rillig   8822:        link to a shared library it needs. The following functions are
                   8823:        known to cause this error message over and over.</p>
                   8824: <div class="informaltable">
1.216     tnn      8825: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8826: <colgroup>
                   8827: <col>
                   8828: <col>
                   8829: <col>
                   8830: </colgroup>
                   8831: <thead><tr>
                   8832: <th>Function</th>
                   8833: <th>Library</th>
                   8834: <th>Affected platforms</th>
                   8835: </tr></thead>
                   8836: <tbody>
                   8837: <tr>
                   8838: <td>accept, bind, connect</td>
                   8839: <td>-lsocket</td>
                   8840: <td>Solaris</td>
                   8841: </tr>
                   8842: <tr>
                   8843: <td>crypt</td>
                   8844: <td>-lcrypt</td>
                   8845: <td>DragonFly, NetBSD</td>
                   8846: </tr>
                   8847: <tr>
                   8848: <td>dlopen, dlsym</td>
                   8849: <td>-ldl</td>
                   8850: <td>Linux</td>
                   8851: </tr>
                   8852: <tr>
                   8853: <td>gethost*</td>
                   8854: <td>-lnsl</td>
                   8855: <td>Solaris</td>
                   8856: </tr>
                   8857: <tr>
                   8858: <td>inet_aton</td>
                   8859: <td>-lresolv</td>
                   8860: <td>Solaris</td>
                   8861: </tr>
                   8862: <tr>
                   8863: <td>nanosleep, sem_*, timer_*</td>
                   8864: <td>-lrt</td>
                   8865: <td>Solaris</td>
                   8866: </tr>
                   8867: <tr>
                   8868: <td>openpty</td>
                   8869: <td>-lutil</td>
                   8870: <td>Linux</td>
                   8871: </tr>
                   8872: </tbody>
                   8873: </table>
                   8874: </div>
                   8875: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8876:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8877:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8878:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8879:     bmake</strong></span>.</p>
1.148     asau     8880: <div class="sect3">
1.92      rillig   8881: <div class="titlepage"><div><div><h4 class="title">
1.287     rillig   8882: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8883: <p>When you are using the SunPro compiler, there is another
                   8884: possibility. That compiler cannot handle the following code:</p>
                   8885: <pre class="programlisting">
1.100     rillig   8886: extern int extern_func(int);
1.93      rillig   8887: 
1.100     rillig   8888: static inline int
                   8889: inline_func(int x)
                   8890: {
1.92      rillig   8891:         return extern_func(x);
1.100     rillig   8892: }
1.93      rillig   8893: 
1.100     rillig   8894: int main(void)
                   8895: {
1.92      rillig   8896:         return 0;
1.100     rillig   8897: }
1.92      rillig   8898: </pre>
                   8899: <p>It generates the code for <code class="function">inline_func</code> even if
                   8900: that function is never used. This code then refers to
                   8901: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8902: solve this problem you can try to tell the package to disable inlining
                   8903: of functions.</p>
                   8904: </div>
1.87      wiz      8905: </div>
1.148     asau     8906: <div class="sect2">
1.87      wiz      8907: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8908: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8909: <p>Sometimes packages fail to build because the compiler runs
                   8910:     into an operating system specific soft limit.  With the
                   8911:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8912:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8913:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8914:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8915:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8916:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8917:     segment size or maximum stack size of a process, respectively, to
                   8918:     their hard limits.</p>
1.78      rillig   8919: </div>
1.75      rillig   8920: </div>
1.148     asau     8921: <div class="sect1">
1.75      rillig   8922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8923: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8924: <div class="sect2">
1.75      rillig   8925: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8926: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8927: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8928:     with some operating systems cannot create more than one
                   8929:     directory at a time. As such, you should call
                   8930:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8931: <pre class="programlisting">
1.100     rillig   8932: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8933: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8934: </pre>
1.128     wiz      8935: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8936:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8937:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8938:     automatically do the right thing.</p>
1.75      rillig   8939: </div>
1.148     asau     8940: <div class="sect2">
1.75      rillig   8941: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8942: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8943: <p>In general, documentation should be installed into
1.87      wiz      8944:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8945:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8946:     includes the version number of the package).</p>
1.84      wiz      8947: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8948:     directory where HTML documentation is installed with the
1.128     wiz      8949:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8950:     is needed because otherwise the documentation ends up in
                   8951:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8952:     places.</p>
                   8953: <p>An exception to the above is that library API documentation
1.322     leot     8954:     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      8955:     browsers (devhelp) should be left at their default location, which
                   8956:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8957:     documentation can be recognized from files ending in
                   8958:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8959:     (It is also acceptable to install such files in
                   8960:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8961:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8962:     <code class="filename">.devhelp*</code> file must be directly in that
                   8963:     directory then, no additional subdirectory level is allowed in
                   8964:     this case. This is usually achieved by using
1.128     wiz      8965:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8966:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8967:     though.)</p>
1.75      rillig   8968: </div>
1.148     asau     8969: <div class="sect2">
1.75      rillig   8970: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8971: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8972: <p>Certain packages, most of them in the games category, install
1.87      wiz      8973:     a score file that allows all users on the system to record their
                   8974:     highscores.  In order for this to work, the binaries need to be
                   8975:     installed setgid and the score files owned by the appropriate
1.142     wiz      8976:     group and/or owner (traditionally the "games" user/group).  Set
                   8977:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8978:     following variables, documented in more detail in
                   8979:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8980:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8981:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8982:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8983:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8984:     <code class="varname">GAMEDATA_PERMS</code> and
                   8985:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8986: <p>An example that illustrates some of the variables described above is
                   8987:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8988:     used to properly set directory permissions of the directory where the
                   8989:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8990:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8991:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8992:     binary:</p>
                   8993: <pre class="programlisting">
1.223     rillig   8994: USE_GAMESGROUP=         yes
1.210     leot     8995: 
1.223     rillig   8996: BUILD_DEFS+=            VARBASE
1.210     leot     8997: 
1.223     rillig   8998: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8999: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9000: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    9001: </pre>
1.210     leot     9002: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9003:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9004:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9005:     needed to be accessed by setgid games and
                   9006:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 9007: <p>A package should therefore never hard code file ownership or
1.210     leot     9008:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9009:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9010:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9011:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   9012: </div>
1.148     asau     9013: <div class="sect2">
1.75      rillig   9014: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9015: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9016: <p><code class="varname">DESTDIR</code> support means that a package
                   9017:     installs into a staging directory, not the final location of the
                   9018:     files. Then a binary package is created which can be used for
                   9019:     installation as usual. There are two ways: Either the package must
1.128     wiz      9020:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   9021:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     9022: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9023: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     9024:       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>.
                   9025:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      9026:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   9027:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9028:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9029:       the inclusion.</p></li>
1.128     wiz      9030: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9031:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9032: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9033:       automatically. Many manual rules and pre/post-install often are
                   9034:       incorrect; fix them.</p></li>
1.128     wiz      9035: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9036:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9037: <li class="listitem"><p>In general, packages should support
1.103     wiz      9038:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9039:       DESTDIR.</p></li>
                   9040: </ul></div>
                   9041: </div>
1.148     asau     9042: <div class="sect2">
1.103     wiz      9043: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9044: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9045: <p>Your package may also contain scripts with hardcoded paths to
1.318     nia      9046:       other interpreters besides (or as well as) Perl.  To correct the
1.87      wiz      9047:       full pathname to the script interpreter, you need to set the
                   9048:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9049:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9050: <pre class="programlisting">
1.100     rillig   9051: REPLACE_INTERPRETER+=   tcl
                   9052: REPLACE.tcl.old=        .*/bin/tclsh
                   9053: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9054: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9055: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    9056: </pre>
1.148     asau     9057: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9058: <h3 class="title">Note</h3>
                   9059: <p>Before March 2006, these variables were called
1.87      wiz      9060:     <code class="varname">_REPLACE.*</code> and
                   9061:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   9062: </div>
                   9063: </div>
1.148     asau     9064: <div class="sect2">
1.75      rillig   9065: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9066: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75      rillig   9067: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9068:     the Makefile fragment
                   9069:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9070:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9071:     configuration for such modules as well as various hooks to tune
                   9072:     this configuration.  See comments in this file for
                   9073:     details.</p>
1.75      rillig   9074: <p>Perl5 modules will install into different places depending
1.87      wiz      9075:     on the version of perl used during the build process.  To
                   9076:     address this, pkgsrc will append lines to the
                   9077:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9078:     the installed <code class="filename">.packlist</code> file generated by
                   9079:     most perl5 modules.  This is invoked by defining
                   9080:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9081:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9082:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9083:     e.g.:</p>
1.75      rillig   9084: <pre class="programlisting">
1.153     wiz      9085: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9086: </pre>
1.153     wiz      9087: <p>The perl5 config variables
                   9088:     <code class="varname">installarchlib</code>,
                   9089:     <code class="varname">installscript</code>,
                   9090:     <code class="varname">installvendorbin</code>,
                   9091:     <code class="varname">installvendorscript</code>,
                   9092:     <code class="varname">installvendorarch</code>,
                   9093:     <code class="varname">installvendorlib</code>,
                   9094:     <code class="varname">installvendorman1dir</code>, and
                   9095:     <code class="varname">installvendorman3dir</code> represent those
                   9096:     locations in which components of perl5 modules may be installed,
                   9097:     provided as variable with uppercase and prefixed with
                   9098:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9099:     and may be used by perl5 packages that don't have a packlist.
                   9100:     These variables are also substituted for in the
                   9101:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9102:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9103: </div>
1.148     asau     9104: <div class="sect2">
1.75      rillig   9105: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9106: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9107: <p>Some packages install info files or use the
1.128     wiz      9108:     <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      9109:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9110:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9111:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9112:     handle registration of the info files in the Info directory
1.128     wiz      9113:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9114:     files registration is either provided by the system, or by a
                   9115:     special purpose package automatically added as dependency if
                   9116:     needed.</p>
1.75      rillig   9117: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9118:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9119:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9120:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9121: <p>The info files for the package should be listed in the
1.87      wiz      9122:     package <code class="filename">PLIST</code>; however any split info files
                   9123:     need not be listed.</p>
1.128     wiz      9124: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9125:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9126:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9127:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9128:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9129:     variable in the package <code class="filename">Makefile</code>. By
                   9130:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9131:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9132:     does not match the required minimum, a build dependency on the
1.322     leot     9133:     <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      9134:     be added automatically.</p>
1.75      rillig   9135: <p>The build and installation process of the software provided
1.87      wiz      9136:     by the package should not use the
1.110     hubertf  9137:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9138:     info files is the task of the package
                   9139:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9140:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9141: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9142:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9143:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9144:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9145: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9146:     no effect except the logging of a message. The script overriding
1.110     hubertf  9147:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9148:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9149:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9150: </div>
1.148     asau     9151: <div class="sect2">
1.75      rillig   9152: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9153: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9154: <p>All packages that install manual pages should install them
1.87      wiz      9155:     into the same directory, so that there is one common place to look
                   9156:     for them. In pkgsrc, this place is
                   9157:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9158:     should be used in packages. The default for
                   9159:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9160:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9161:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9162: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9163: <h3 class="title">Note</h3>
1.87      wiz      9164: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9165:     is far from complete.</p>
1.75      rillig   9166: </div>
1.81      rillig   9167: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9168:     <code class="filename">man/</code> as the top level directory for the man
                   9169:     page file entries, and the pkgsrc framework will convert as
                   9170:     needed. In all other places, the correct
                   9171:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9172: <p>Packages that are
                   9173:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9174:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9175:     <code class="filename">./configure</code>
                   9176:     --mandir switch to set where the man pages should be installed.
                   9177:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9178:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9179: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9180:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9181:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9182:     Or if the <code class="filename">./configure</code> script uses
                   9183:     a non-standard use of --mandir, you can set
                   9184:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9185: <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      9186:     information on installation of compressed manual pages.</p>
1.75      rillig   9187: </div>
1.148     asau     9188: <div class="sect2">
1.75      rillig   9189: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9190: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9191: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9192:     the fonts database in the directory where they get installed at
                   9193:     installation and deinstallation time.  This can be automatically
                   9194:     done by using the pkginstall framework.</p>
1.75      rillig   9195: <p>You can list the directories where fonts are installed in the
1.87      wiz      9196:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9197:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9198:     <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      9199:     Also make sure that the database file
                   9200:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9201: <p>Note that you should not create new directories for fonts;
1.87      wiz      9202:     instead use the standard ones to avoid that the user needs to
                   9203:     manually configure his X server to find them.</p>
1.75      rillig   9204: </div>
1.148     asau     9205: <div class="sect2">
1.75      rillig   9206: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9207: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9208: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9209:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9210:     etc.), you need to take some extra steps:</p>
1.128     wiz      9211: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9212: <li class="listitem"><p>Include
1.87      wiz      9213:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9214:        your <code class="filename">Makefile</code>, which takes care of
                   9215:        registering those files in system-wide catalogs at
                   9216:        installation and deinstallation time.</p></li>
1.128     wiz      9217: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9218:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9219: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9220:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9221: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9222:        to be added to the SGML catalog.  These come in groups of
                   9223:        three strings; see xmlcatmgr(1) for more information
                   9224:        (specifically, arguments recognized by the 'add' action).
                   9225:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9226: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9227:        to be added to the XML catalog.  These come in groups of three
                   9228:        strings; see xmlcatmgr(1) for more information (specifically,
                   9229:        arguments recognized by the 'add' action).  Note that you will
                   9230:        normally not use this variable.</p></li>
1.75      rillig   9231: </ol></div>
                   9232: </div>
1.148     asau     9233: <div class="sect2">
1.75      rillig   9234: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9235: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9236: <p>If a package provides extensions to the MIME database by
1.87      wiz      9237:     installing <code class="filename">.xml</code> files inside
                   9238:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9239:     need to take some extra steps to ensure that the database is kept
                   9240:     consistent with respect to these new files:</p>
1.128     wiz      9241: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9242: <li class="listitem"><p>Include
1.87      wiz      9243:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9244:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9245:        this same directory, which is reserved for inclusion from
                   9246:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9247:        care of rebuilding the MIME database at installation and
                   9248:        deinstallation time, and disallows any access to it directly
                   9249:        from the package.</p></li>
1.128     wiz      9250: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9251:        <code class="filename">share/mime</code> directory,
                   9252:        <span class="emphasis"><em>except</em></span> for files saved under
                   9253:        <code class="filename">share/mime/packages</code>.  The former are
                   9254:        handled automatically by
                   9255:        the update-mime-database program, but the latter are
                   9256:        package-dependent and must be removed by the package that
                   9257:        installed them in the first place.</p></li>
1.128     wiz      9258: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9259:        from the PLIST.  They will be handled by the shared-mime-info
                   9260:        package.</p></li>
1.75      rillig   9261: </ol></div>
                   9262: </div>
1.148     asau     9263: <div class="sect2">
1.75      rillig   9264: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9265: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93      rillig   9266: <p>If a package uses intltool during its build, add
                   9267:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9268:     which forces it to use the intltool package provided by pkgsrc,
                   9269:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9270: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9271:     latest available version; this way, the package benefits of any
                   9272:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9273: </div>
1.148     asau     9274: <div class="sect2">
1.75      rillig   9275: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9276: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9277: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9278:     the startup directory by default, but you can enable it, by adding
                   9279:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9280:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9281:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9282:     it will automatically remove the scripts when the package is
                   9283:     deinstalled.</p>
1.75      rillig   9284: </div>
1.148     asau     9285: <div class="sect2">
1.75      rillig   9286: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9287: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9288: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9289:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9290:     updated.</p>
1.148     asau     9291: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9292: <h3 class="title">Note</h3>
1.125     wiz      9293: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9294:     packages should install files
1.125     wiz      9295:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9296:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9297: </div>
1.128     wiz      9298: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9299: <li class="listitem"><p>Include
1.125     wiz      9300:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9301:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9302:       database at installation and deinstallation time.</p></li>
1.128     wiz      9303: <li class="listitem">
1.75      rillig   9304: <p>If your package installs files into a texmf
1.87      wiz      9305:       tree other than the one
1.125     wiz      9306:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9307:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9308:       trees that need database update.</p>
1.75      rillig   9309: <p>If your package also installs font map files that need
1.110     hubertf  9310:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9311:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9312:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9313:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9314:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9315:       be run automatically at installation/deinstallation to
                   9316:       enable/disable font map files for TeX output
                   9317:       drivers.</p>
1.75      rillig   9318: </li>
1.128     wiz      9319: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9320:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9321:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9322: </ol></div>
                   9323: </div>
1.148     asau     9324: <div class="sect2">
1.85      jmmv     9325: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9326: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87      wiz      9327:     emulation</h3></div></div></div>
                   9328: <p>There are some packages that provide libraries and
                   9329:     executables for running binaries from a one operating system
                   9330:     on a different one (if the latter supports it).  One example
                   9331:     is running Linux binaries on NetBSD.</p>
1.322     leot     9332: <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      9333:     helps in extracting and packaging Linux rpm packages.</p>
                   9334: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9335:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9336:     if all libraries for each installed executable can be found by
                   9337:     the dynamic linker.  Since the standard dynamic linker is run,
                   9338:     this fails for emulation packages, because the libraries used
                   9339:     by the emulation are not in the standard directories.</p>
                   9340: </div>
1.299     rillig   9341: <div class="sect2">
                   9342: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9343: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299     rillig   9344: <p>If a package installs images under the
                   9345:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9346:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9347:     database, you need to take some extra steps to make sure that the
                   9348:     shared theme directory is handled appropriately and that the cache
                   9349:     database is rebuilt:</p>
                   9350: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9351: <li class="listitem"><p>Include
                   9352:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9353: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9354:        entry that refers to the theme cache.</p></li>
                   9355: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9356:          directories from the <code class="filename">share/icons/hicolor</code>
                   9357:          hierarchy because they will be handled automatically.</p></li>
                   9358: </ol></div>
                   9359: <p>The best way to verify that the PLIST is correct with
                   9360:       respect to the last two points is to regenerate it using
                   9361:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9362: </div>
                   9363: <div class="sect2">
                   9364: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9365: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299     rillig   9366: <p>If a package installs <code class="filename">.desktop</code> files
                   9367:       under <code class="filename">share/applications</code> and these include
                   9368:       MIME information (MimeType key), you need to take extra steps to
                   9369:       ensure that they are registered into the MIME database:</p>
                   9370: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9371: <li class="listitem"><p>Include
                   9372:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9373: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9374:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9375:          It will be handled automatically.</p></li>
                   9376: </ol></div>
                   9377: <p>The best way to verify that the PLIST is correct with
                   9378:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9379:       print-PLIST</strong></span>.</p>
                   9380: </div>
                   9381: </div>
                   9382: <div class="sect1">
                   9383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9384: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9385: <p>In some cases one does not have the time to solve a problem
                   9386:   immediately. In this case, one can plainly mark a package as broken.  For
                   9387:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9388:   reason why the package is broken (similar to the
                   9389:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9390:   the package will immediately be shown this message, and the build
                   9391:   will not be even tried.</p>
                   9392: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9393:   intervals.</p>
                   9394: </div>
                   9395: </div>
                   9396: <div class="chapter">
                   9397: <div class="titlepage"><div><div><h2 class="title">
                   9398: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9399: <div class="toc">
                   9400: <p><b>Table of Contents</b></p>
                   9401: <dl class="toc">
                   9402: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9403: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9404: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9405: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9406: </dl>
                   9407: </div>
                   9408: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9409: site</a>:</p>
                   9410: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9411:   environment, an intuitive and attractive desktop for users, and the
                   9412:   GNOME development platform, an extensive framework for building
                   9413:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9414: <p>pkgsrc provides a seamless way to automatically build and install
                   9415: a complete GNOME environment <span class="emphasis"><em>under many different
                   9416: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9417: the most advanced build and packaging systems for GNOME due to its
                   9418: included technologies buildlink3, the wrappers and tools framework and
                   9419: automatic configuration file management.  Lots of efforts are put into
                   9420: achieving a completely clean deinstallation of installed software
                   9421: components.</p>
                   9422: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9423: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9424: under this operating system.</p>
1.299     rillig   9425: <p>This chapter is aimed at pkgsrc developers and other people
                   9426: interested in helping our GNOME porting and packaging efforts.  It
                   9427: provides instructions on how to manage the existing packages and some
                   9428: important information regarding their internals.</p>
                   9429: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9430: <h3 class="title">We need your help!</h3>
                   9431: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9432:   and GNOME and are willing to learn new exciting stuff, please jump
                   9433:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9434:   work</a> list!  There is still a long way to go to get a
                   9435:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9436:   achieve it!</p>
                   9437: </div>
                   9438: <div class="sect1">
                   9439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9440: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9441: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     9443: <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   9444:     the core GNOME desktop environment.  It only includes the necessary
                   9445:     bits to get it to boot correctly, although it may lack important
                   9446:     functionality for daily operation.  The idea behind this package is
                   9447:     to let end users build their own configurations on top of this one,
                   9448:     first installing this meta package to achieve a functional setup and
                   9449:     then adding individual applications.</p></li>
1.322     leot     9450: <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   9451:     complete installation of the GNOME platform and desktop as defined
                   9452:     by the GNOME project; this is based on the components distributed in
                   9453:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9454:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9455:     official FTP server.  Developer-only tools found in those
                   9456:     directories are not installed unless required by some other
                   9457:     component to work properly.  Similarly, packages from the bindings
                   9458:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9459:     in unless required as a dependency for an end-user component.  This
1.322     leot     9460:     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>
                   9461: <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   9462:     Installs all the tools required to build a GNOME component when
                   9463:     fetched from the CVS repository.  These are required to let the
                   9464:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9465: </ul></div>
                   9466: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9467: sorted in a way that eases updates: a package may depend on other
                   9468: packages listed before it but not on any listed after it.  It is very
                   9469: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9470: change it to alphabetical sorting!</em></span></p>
                   9471: </div>
                   9472: <div class="sect1">
                   9473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9474: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9475: <p>Almost all GNOME applications are written in C and use a common
                   9476: set of tools as their build system.  Things get different with the new
                   9477: bindings to other languages (such as Python), but the following will
                   9478: give you a general idea on the minimum required tools:</p>
                   9479: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9480: <li class="listitem">
                   9481: <p>Almost all GNOME applications use the GNU Autotools as their
                   9482:     build system.  As a general rule you will need to tell this to your
                   9483:     package:</p>
                   9484: <pre class="programlisting">
                   9485: GNU_CONFIGURE=yes
                   9486: USE_LIBTOOL=yes
                   9487: USE_TOOLS+=gmake
                   9488: </pre>
                   9489: </li>
                   9490: <li class="listitem">
                   9491: <p>If the package uses pkg-config to detect dependencies, add this
                   9492:     tool to the list of required utilities:</p>
                   9493: <pre class="programlisting">
                   9494: USE_TOOLS+=pkg-config
                   9495: </pre>
1.322     leot     9496: <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   9497:     the end of the build process to ensure that you did not miss to
                   9498:     specify any dependency in your package and that the version
                   9499:     requirements are all correct.</p>
                   9500: </li>
                   9501: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9502:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9503:     to handle dependencies and to force the package to use the latest
                   9504:     available version.</p></li>
                   9505: <li class="listitem">
                   9506: <p>If the package uses gtk-doc (a documentation generation
                   9507:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9508:     tool is rather big and the distfile should come with pregenerated
                   9509:     documentation anyway; if it does not, it is a bug that you ought to
                   9510:     report.  For such packages you should disable gtk-doc (unless it is
                   9511:     the default):</p>
                   9512: <pre class="programlisting">
                   9513: CONFIGURE_ARGS+=--disable-gtk-doc
                   9514: </pre>
                   9515: <p>The default location of installed HTML files
                   9516:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9517:     and should not be changed unless the package insists on installing
                   9518:     them somewhere else.  Otherwise programs as
                   9519:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9520:     do that with an entry similar to:</p>
                   9521: <pre class="programlisting">
                   9522: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9523: </pre>
                   9524: </li>
                   9525: </ul></div>
                   9526: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9527: files under the installation prefix to maintain databases.  In this
                   9528: context, shared means that those exact same directories and files are
                   9529: used among several different packages, leading to conflicts in the
                   9530: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9531: handle the most common cases, so you have to forget about using
                   9532: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9533: omitting shared files from them.  If you find yourself doing those,
                   9534: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9535: <p>The following table lists the common situations that result in
                   9536: using shared directories or files.  For each of them, the appropriate
                   9537: solution is given.  After applying the solution be sure to
                   9538: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9539: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9540: <div class="table">
                   9541: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9542: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9543: <colgroup>
                   9544: <col>
                   9545: <col>
                   9546: </colgroup>
                   9547: <thead><tr>
                   9548: <th>If the package...</th>
                   9549: <th>Then...</th>
                   9550: </tr></thead>
                   9551: <tbody>
                   9552: <tr>
                   9553: <td>Installs icons under the
                   9554:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9555:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318     nia      9556: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, &#8220;Packages installing hicolor icons&#8221;</a>.</td>
1.299     rillig   9557: </tr>
                   9558: <tr>
                   9559: <td>Installs files under
                   9560:         <code class="filename">share/mime/packages</code>.</td>
1.318     nia      9561: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.299     rillig   9562: </tr>
                   9563: <tr>
                   9564: <td>Installs <code class="filename">.desktop</code> files under
                   9565:         <code class="filename">share/applications</code> and these include MIME
                   9566:         information.</td>
1.318     nia      9567: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.299     rillig   9568: </tr>
                   9569: </tbody>
                   9570: </table></div>
1.75      rillig   9571: </div>
1.299     rillig   9572: <br class="table-break">
1.75      rillig   9573: </div>
1.148     asau     9574: <div class="sect1">
1.87      wiz      9575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9576: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9577: <p>When seeing GNOME as a whole, there are two kinds of
                   9578: updates:</p>
                   9579: <div class="variablelist"><dl class="variablelist">
                   9580: <dt><span class="term">Major update</span></dt>
                   9581: <dd>
                   9582: <p>Given that there is still a very long way for GNOME 3 (if it
                   9583:       ever appears), we consider a major update one that goes from a
                   9584:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9585:       where <code class="literal">Y</code> is even and greater than
                   9586:       <code class="literal">X</code>.  These are hard to achieve because they
                   9587:       introduce lots of changes in the components' code and almost all
                   9588:       GNOME distfiles are updated to newer versions.  Some of them can
                   9589:       even break API and ABI compatibility with the previous major
                   9590:       version series.  As a result, the update needs to be done all at
                   9591:       once to minimize breakage.</p>
                   9592: <p>A major update typically consists of around 80 package
                   9593:       updates and the addition of some new ones.</p>
                   9594: </dd>
                   9595: <dt><span class="term">Minor update</span></dt>
                   9596: <dd>
                   9597: <p>We consider a minor update one that goes from a
                   9598:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9599:       one where <code class="literal">Y</code> is greater than
                   9600:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9601:       not update all GNOME components, can be done in an incremental way
                   9602:       and do not break API nor ABI compatibility.</p>
                   9603: <p>A minor update typically consists of around 50 package
                   9604:       updates, although the numbers here may vary a lot.</p>
                   9605: </dd>
                   9606: </dl></div>
                   9607: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9608: release (either major or minor), the following steps should be
                   9609: followed:</p>
                   9610: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9611: <li class="listitem">
1.299     rillig   9612: <p>Get a list of all the tarballs that form the new release by
                   9613:     using the following commands.  These will leave the full list of the
                   9614:     components' distfiles into the <code class="filename">list.txt</code>
                   9615:     file:</p>
                   9616: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9617:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9618:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9619: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9620:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9621:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9622: </li>
1.299     rillig   9623: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9624:     bump their version to the release you are updating them to.  The
                   9625:     three meta packages should be always consistent with versioning.
                   9626:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9627:     in them.</p></li>
1.128     wiz      9628: <li class="listitem">
1.299     rillig   9629: <p>For each meta package, update all its
                   9630:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9631:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9632:     newer version (even if found in the FTP) because the meta packages
                   9633:     are supposed to list the exact versions that form a specific GNOME
                   9634:     release.  Exceptions are permitted here if a newer version solves a
                   9635:     serious issue in the overall desktop experience; these typically
                   9636:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9637:     from the developers.</p>
                   9638: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9639:     should be updated to the latest version available (if found in
                   9640:     pkgsrc).  This is the case, for example, of the dependencies on the
1.322     leot     9641:     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   9642: </li>
1.128     wiz      9643: <li class="listitem">
1.299     rillig   9644: <p>Generate a patch from the modified meta packages and extract the
                   9645:     list of "new" lines.  This will provide you an outline on what
                   9646:     packages need to be updated in pkgsrc and in what order:</p>
                   9647: <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   9648: </li>
1.299     rillig   9649: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9650:     installed packages and start over from scratch at this point.</p></li>
                   9651: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9652:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9653:     it in order.  For major desktop updates none of these should be
                   9654:     committed until the entire set is completed because there are chances
                   9655:     of breaking not-yet-updated packages.</p></li>
                   9656: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9657:     the tree one by one with appropriate log messages.  At the end,
                   9658:     commit the three meta package updates and all the corresponding
                   9659:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9660:     <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>
                   9661: </ol></div>
                   9662: </div>
                   9663: <div class="sect1">
                   9664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9665: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9666: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9667: packages.  Please, it is very important that you always, always,
                   9668: <span class="strong"><strong>always</strong></span> feed back any portability
                   9669: 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
                   9670: their attention on portability issues and to ensure that future versions
                   9671: can be built out-of-the box on NetBSD.  The less custom patches in
                   9672: pkgsrc, the easier further updates are.  Those developers in charge of
                   9673: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 9674: <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
                   9675: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   9676: of them do.  Do not be short on your reports: always provide detailed
                   9677: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 9678: maximum portability and, if at all possible, provide a patch against the
                   9679: main Git branch.  The more verbose you are, the higher chances of your
                   9680: patch being accepted.</p>
1.299     rillig   9681: <p>Also, please avoid using preprocessor magic to fix portability
                   9682: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9683: GNOME to their operating system, the official GNOME sources are now
                   9684: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9685: and similar macros.  This hurts portability.  Please see our patching
                   9686: 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
                   9687: details.</p>
                   9688: </div>
1.75      rillig   9689: </div>
1.148     asau     9690: <div class="chapter">
1.75      rillig   9691: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9692: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9693: <div class="toc">
                   9694: <p><b>Table of Contents</b></p>
1.210     leot     9695: <dl class="toc">
1.267     rillig   9696: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9697: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9698: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9699: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9700: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9701: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9702: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9703: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9704: </dl>
                   9705: </div>
1.148     asau     9706: <div class="sect1">
1.75      rillig   9707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9708: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9709: <p>Our policy is that we accept binaries only from pkgsrc
                   9710:        developers to guarantee that the packages don't contain any
                   9711:        trojan horses etc. This is not to annoy anyone but rather to
                   9712:        protect our users! You're still free to put up your home-made
                   9713:        binary packages and tell the world where to get them. NetBSD
                   9714:        developers doing bulk builds and wanting to upload them please
1.267     rillig   9715:        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     9716: builds)</i></a>.</p>
1.75      rillig   9717: </div>
1.148     asau     9718: <div class="sect1">
1.75      rillig   9719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9720: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333     nia      9721: <p>Firstly, you can import new packages into
                   9722:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
                   9723:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   9724:        for details.</p>
                   9725: <p>Next, check that your package is complete, compiles and
1.299     rillig   9726:        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      9727:        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>
                   9728:        tool and fix any errors that appear.</p>
                   9729: <p>Finally, send a report to the pkgsrc bug tracking system,
1.322     leot     9730:        either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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      9731:        that, go to the web page
1.289     leot     9732:        <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      9733:        which contains some instructions and a link to a form where you
                   9734:        can submit packages.  The
1.322     leot     9735:        <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      9736:        also available as a substitute for either of the above two tools.
                   9737:        </p>
1.87      wiz      9738: <p>In the form of the problem report, the category should be
1.128     wiz      9739:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9740:        and version number, and the description field should contain a
                   9741:        short description of your package (contents of the COMMENT
1.333     nia      9742:        variable or DESCR file are OK).</p>
1.75      rillig   9743: </div>
1.148     asau     9744: <div class="sect1">
1.75      rillig   9745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9746: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9747: <p>Please note all package additions, updates, moves, and
1.93      rillig   9748:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9749:        important to keep this file up to date and conforming to the
                   9750:        existing format, because it will be used by scripts to
1.289     leot     9751:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9752:        sites. Additionally, check the
1.76      rillig   9753:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9754:        for the package you updated or removed, in case it was mentioned
                   9755:        there.</p>
                   9756: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9757:        bumped, the change should appear in
1.93      rillig   9758:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9759:        related or otherwise relevant. Mass bumps that result from a
                   9760:        dependency being updated should not be mentioned. In all other
                   9761:        cases it's the developer's decision.</p>
                   9762: <p>There is a make target that helps in creating proper
1.110     hubertf  9763:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9764:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9765:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9766:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9767:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9768:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9769:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9770:   For new packages, or package moves or removals, set the
                   9771:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9772:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9773:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9774:   not the same as your NetBSD login name. The target also automatically
                   9775:   removes possibly existing entries for the package in the
                   9776:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9777:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9778:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9779:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9780:   makes the cvs commands use the main repository.
                   9781:   </p>
1.75      rillig   9782: </div>
1.148     asau     9783: <div class="sect1">
1.75      rillig   9784: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9785: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9786: <p>For several years, there have been mirrors of pkgsrc in
                   9787:   fossil, git, and hg. Standard practise when using these tools is to
                   9788:   make the first line of a commit message function as a summary that
                   9789:   can be read without the rest, such as is commonly done with "git log
                   9790:   --oneline". For this reason, we have the following guidelines for
                   9791:   pkgsrc commit messages:</p>
                   9792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9793: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9794:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9795:     package, include the name of the package. For updates, include the
                   9796:     version to which it is updated.</p></li>
                   9797: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9798: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9799:     package, reason for a change) and any relevant PRs. Wrap this
                   9800:     section.</p></li>
                   9801: </ul></div>
                   9802: <p>Here is an example:
                   9803:   </p>
                   9804: <pre class="programlisting">
                   9805:   libxslt: update to 1.0.30
                   9806: 
                   9807:   Changes since 1.0.29:
                   9808:   ...
                   9809:   </pre>
                   9810: <p>
                   9811:   </p>
                   9812: <p>Here is another example:
                   9813:   </p>
                   9814: <pre class="programlisting">
                   9815:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9816: 
                   9817:   (rationale)
                   9818:   </pre>
                   9819: <p>
                   9820:   </p>
                   9821: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9822:   allowed on the pkgsrc repository to change commit messages.</p>
                   9823: </div>
                   9824: <div class="sect1">
                   9825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9826: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9827: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9828:   access to the pkgsrc repository.</p>
                   9829: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9830: Start by adding the directory and then files in the directory. Don't
                   9831: forget to add the new package to the category's
                   9832: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9833: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9834: <pre class="programlisting">
                   9835: <code class="prompt">$</code> cd .../pkgsrc/category
                   9836: <code class="prompt">$</code> cvs add pkgname
                   9837: <code class="prompt">$</code> cd pkgname
                   9838: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9839: <code class="prompt">$</code> cvs add patches/p*
                   9840: <code class="prompt">$</code> cvs status | less
1.141     wiz      9841: <code class="prompt">$</code> cvs commit
1.140     wiz      9842: <code class="prompt">$</code> cd ..
                   9843: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9844: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9845: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9846: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9847: </pre>
1.87      wiz      9848: <p>The commit message of the initial import should include part of the
1.76      rillig   9849:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9850:   what the package is/does.</p>
1.140     wiz      9851: <p>Also mention the new package in
                   9852: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9853: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9854: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9855: </div>
1.148     asau     9856: <div class="sect1">
1.75      rillig   9857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9858: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9859: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9860:   changes between old and new versions into the commit log when updating
1.87      wiz      9861:   a package. There are various reasons for this:</p>
1.148     asau     9862: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9863: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9864:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9865: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9866:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9867: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9868:   repository is very useful for people who read the pkgsrc-changes mailing
                   9869:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9870:   the package.</p></li>
1.75      rillig   9871: </ul></div>
1.87      wiz      9872: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9873:   has been released, it should not automatically be upgraded in the CVS
                   9874:   repository.  We prefer to be conservative in the packages that are
                   9875:   included in pkgsrc - development or beta packages are not really the
                   9876:   best thing for most places in which pkgsrc is used. Please use your
                   9877:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9878:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9879: </div>
1.148     asau     9880: <div class="sect1">
1.75      rillig   9881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9882: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9883: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9884: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9885:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9886: <p>
1.290     gutterid 9887:   Also, when renaming a package, please add
1.282     leot     9888:   the package name and version pattern(s) of the previous package
                   9889:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9890:   This may be repeated for multiple renames.
                   9891:   The new package would be an exact replacement.
1.282     leot     9892:   Example:
1.122     reed     9893: </p>
1.282     leot     9894: <pre class="programlisting">
                   9895: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9896: SUPERSEDES+=    optcomp-[0-9]*
                   9897: </pre>
1.128     wiz      9898: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9899:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9900:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9901:   not be an exact replacement but is a suggestion for the replaced
                   9902:   functionality.</p>
                   9903: </div>
1.148     asau     9904: <div class="sect1">
1.122     reed     9905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9906: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9907: <p>It is preferred that packages are not renamed or moved, but if needed
                   9908:   please follow these steps.
                   9909: </p>
1.128     wiz      9910: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9911: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9912: <li class="listitem">
1.75      rillig   9913: <p>Remove all CVS dirs.</p>
1.87      wiz      9914: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9915: <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      9916: <p>and use that for further work.</p>
1.75      rillig   9917: </li>
1.128     wiz      9918: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9919: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9920: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9921: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9922: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9923: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9924: for doing an update using pkgsrc building; for example, it can
1.322     leot     9925: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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     9926: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9927: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9928: it may have multiple matches, so the tool should also check on the
                   9929: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9930: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9931: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9932: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9933: place.</p></li>
1.128     wiz      9934: <li class="listitem">
1.75      rillig   9935: <p>Check if any package depends on it:
                   9936: </p>
                   9937: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9938: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9939: </li>
1.128     wiz      9940: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9941: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9942: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9943: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9944: <li class="listitem">
1.75      rillig   9945: <p>Commit the changed and removed files:</p>
                   9946: <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      9947: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9948: </li>
                   9949: </ol></div>
                   9950: </div>
                   9951: </div>
1.148     asau     9952: <div class="chapter">
1.75      rillig   9953: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9954: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9955: <p>This section contains the answers to questions that may
                   9956:        arise when you are writing a package. If you don't find your
                   9957:        question answered here, first have a look in the other chapters,
                   9958:        and if you still don't have the answer, ask on the
                   9959:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9960: <div class="qandaset">
1.289     leot     9961: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   9962: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9963:        MAKEFLAGS, .MAKEFLAGS and
                   9964:        MAKE_FLAGS?</a>
                   9965: </dt>
1.267     rillig   9966: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9967:        MAKE, GMAKE and
                   9968:        MAKE_PROGRAM?</a>
                   9969: </dt>
1.267     rillig   9970: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9971:        CC, PKG_CC and
                   9972:        PKGSRC_COMPILER?</a>
                   9973: </dt>
1.267     rillig   9974: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9975:        BUILDLINK_LDFLAGS,
                   9976:        BUILDLINK_LDADD and
                   9977:        BUILDLINK_LIBS?</a>
                   9978: </dt>
1.267     rillig   9979: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9980:        VARNAME=BUILDLINK_PREFIX.foo
                   9981:        say it's empty?</a>
                   9982: </dt>
1.267     rillig   9983: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9984:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9985:        don't understand the := inside
                   9986:        it.</a>
                   9987: </dt>
1.267     rillig   9988: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9989:        developers?</a>
                   9990: </dt>
1.267     rillig   9991: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9992:        documentation?</a>
                   9993: </dt>
1.289     leot     9994: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   9995: What shall I do?</a>
1.92      rillig   9996: </dt>
1.75      rillig   9997: </dl>
1.148     asau     9998: <table border="0" style="width: 100%;">
                   9999: <colgroup>
1.75      rillig   10000: <col align="left" width="1%">
1.128     wiz      10001: <col>
1.148     asau     10002: </colgroup>
1.75      rillig   10003: <tbody>
1.148     asau     10004: <tr class="question">
1.75      rillig   10005: <td align="left" valign="top">
1.289     leot     10006: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   10007: </td>
                   10008: <td align="left" valign="top"><p>What is the difference between
                   10009:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10010:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10011: </tr>
                   10012: <tr class="answer">
1.91      rillig   10013: <td align="left" valign="top"></td>
1.75      rillig   10014: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.322     leot     10015:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   10016:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   10017:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   10018:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   10019: </tr>
1.148     asau     10020: <tr class="question">
1.75      rillig   10021: <td align="left" valign="top">
1.289     leot     10022: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   10023: </td>
                   10024: <td align="left" valign="top"><p>What is the difference between
                   10025:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10026:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10027: </tr>
                   10028: <tr class="answer">
1.91      rillig   10029: <td align="left" valign="top"></td>
1.75      rillig   10030: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.322     leot     10031:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   10032:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   10033:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   10034:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   10035:        Make program that is used for building the
                   10036:        package.</p></td>
                   10037: </tr>
1.148     asau     10038: <tr class="question">
1.75      rillig   10039: <td align="left" valign="top">
1.289     leot     10040: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   10041: </td>
                   10042: <td align="left" valign="top"><p>What is the difference between
                   10043:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10044:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10045: </tr>
                   10046: <tr class="answer">
1.91      rillig   10047: <td align="left" valign="top"></td>
1.75      rillig   10048: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   10049:        compiler, which can be configured by the pkgsrc user.
                   10050:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   10051:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   10052:        path to a compiler, but the type of compiler that should be
1.76      rillig   10053:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   10054:        information about the latter variable.</p></td>
                   10055: </tr>
1.148     asau     10056: <tr class="question">
1.75      rillig   10057: <td align="left" valign="top">
1.289     leot     10058: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75      rillig   10059: </td>
                   10060: <td align="left" valign="top"><p>What is the difference between
                   10061:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   10062:        <code class="varname">BUILDLINK_LDADD</code> and
                   10063:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   10064: </tr>
                   10065: <tr class="answer">
1.91      rillig   10066: <td align="left" valign="top"></td>
1.75      rillig   10067: <td align="left" valign="top"><p>[FIXME]</p></td>
                   10068: </tr>
1.148     asau     10069: <tr class="question">
1.75      rillig   10070: <td align="left" valign="top">
1.289     leot     10071: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75      rillig   10072: </td>
1.110     hubertf  10073: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10074:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10075:        say it's empty?</p></td>
                   10076: </tr>
                   10077: <tr class="answer">
1.91      rillig   10078: <td align="left" valign="top"></td>
1.75      rillig   10079: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10080:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10081:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10082:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10083:        command.</p></td>
                   10084: </tr>
1.148     asau     10085: <tr class="question">
1.78      rillig   10086: <td align="left" valign="top">
1.289     leot     10087: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78      rillig   10088: </td>
                   10089: <td align="left" valign="top"><p>What does
1.220     wiz      10090:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10091:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10092:        it.</p></td>
                   10093: </tr>
                   10094: <tr class="answer">
1.91      rillig   10095: <td align="left" valign="top"></td>
1.220     wiz      10096: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   10097:        assignment operator, although it looks like it.
1.78      rillig   10098:        Instead, it is a degenerate form of
1.220     wiz      10099:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.322     leot     10100:        which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10101:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10102:        case of <code class="varname">MASTER_SITE_*</code>,
                   10103:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10104:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10105:        <code class="code">package/</code>. That's where the
                   10106:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10107:        together.</p></td>
                   10108: </tr>
1.148     asau     10109: <tr class="question">
1.78      rillig   10110: <td align="left" valign="top">
1.289     leot     10111: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78      rillig   10112: </td>
                   10113: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10114:        developers?</p></td>
                   10115: </tr>
                   10116: <tr class="answer">
1.91      rillig   10117: <td align="left" valign="top"></td>
1.148     asau     10118: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10119: <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   10120: <dd><p>This is a list for technical discussions related
                   10121:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10122:        pkgsrc infrastructure, proposed new features, questions related
                   10123:        to porting pkgsrc to a new platform, advice for maintaining a
                   10124:        package, patches that affect many packages, help requests moved
                   10125:        from pkgsrc-users when an infrastructure bug is found,
                   10126:        etc.</p></dd>
1.289     leot     10127: <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   10128: <dd><p>All bug reports in category "pkg" sent with
1.322     leot     10129:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/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   10130:        directly; use one of the other mailing
                   10131:        lists.</p></dd>
                   10132: </dl></div></td>
                   10133: </tr>
1.148     asau     10134: <tr class="question">
1.80      rillig   10135: <td align="left" valign="top">
1.289     leot     10136: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80      rillig   10137: </td>
                   10138: <td align="left" valign="top"><p>Where is the pkgsrc
                   10139:        documentation?</p></td>
                   10140: </tr>
                   10141: <tr class="answer">
1.91      rillig   10142: <td align="left" valign="top"></td>
1.80      rillig   10143: <td align="left" valign="top">
                   10144: <p>There are many places where you can find
                   10145:        documentation about pkgsrc:</p>
1.148     asau     10146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10147: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10148:        of chapters that explain large parts of pkgsrc, but some
                   10149:        chapters tend to be outdated. Which ones they are is hard to
                   10150:        say.</p></li>
1.289     leot     10151: <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   10152:        about certain features, announcements of new parts of the pkgsrc
                   10153:        infrastructure and sometimes even announcements that a certain
                   10154:        feature has been marked as obsolete. The benefit here is that
                   10155:        each message has a date appended to it.</p></li>
1.128     wiz      10156: <li class="listitem"><p>Many of the files in the
1.80      rillig   10157:        <code class="filename">mk/</code> directory start with a comment that
                   10158:        describes the purpose of the file and how it can be used by the
1.92      rillig   10159:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10160:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10161:        help</strong></span>.</p></li>
1.128     wiz      10162: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10163:        information, but they tend to be highly abbreviated, especially
                   10164:        for actions that occur often. Some contain a detailed
                   10165:        description of what has changed, but they are geared towards the
                   10166:        other pkgsrc developers, not towards an average pkgsrc user.
                   10167:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10168:        don't know what has been before, these messages may not be worth
                   10169:        too much to you.</p></li>
1.128     wiz      10170: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10171:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10172:        mind of the developer who wrote the code. To get this
1.110     hubertf  10173:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10174:        to see who has written it and ask on the
                   10175:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10176:        find your questions later (see above). To be sure that the
                   10177:        developer in charge reads the mail, you may CC him or
                   10178:        her.</p></li>
                   10179: </ul></div>
1.299     rillig   10180: </td>
                   10181: </tr>
                   10182: <tr class="question">
                   10183: <td align="left" valign="top">
                   10184: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
                   10185: </td>
                   10186: <td align="left" valign="top"><p>I have a little time to kill. 
                   10187: What shall I do?</p></td>
                   10188: </tr>
                   10189: <tr class="answer">
                   10190: <td align="left" valign="top"></td>
                   10191: <td align="left" valign="top">
                   10192: <p>This is not really an FAQ yet, but here's the answer
                   10193: anyway.</p>
1.148     asau     10194: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10195: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322     leot     10196:     <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   10197:     will tell you about newer versions of installed packages that are
                   10198:     available, but not yet updated in pkgsrc.</p></li>
                   10199: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10200:     &mdash; it contains a list of suggested new packages and a list of
                   10201:     cleanups and enhancements for pkgsrc that would be nice to
                   10202:     have.</p></li>
                   10203: <li class="listitem"><p>Review packages for which review was requested on
                   10204:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10205:     mailing list.</p></li>
1.85      jmmv     10206: </ul></div>
1.299     rillig   10207: </td>
1.85      jmmv     10208: </tr>
                   10209: </tbody>
1.299     rillig   10210: </table>
1.85      jmmv     10211: </div>
                   10212: </div>
1.75      rillig   10213: </div>
1.148     asau     10214: <div class="part">
1.75      rillig   10215: <div class="titlepage"><div><div><h1 class="title">
                   10216: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10217: <div class="partintro">
1.75      rillig   10218: <div></div>
                   10219: <p>This part of the guide deals with everything
                   10220:        from the infrastructure that is behind the interfaces described
                   10221:        in the developer's guide. A casual package maintainer should not
                   10222:        need anything from this part.</p>
                   10223: <div class="toc">
                   10224: <p><b>Table of Contents</b></p>
1.210     leot     10225: <dl class="toc">
1.299     rillig   10226: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10227: <dd><dl>
1.299     rillig   10228: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10229: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10230: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75      rillig   10231: <dd><dl>
1.299     rillig   10232: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10233: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75      rillig   10234: </dl></dd>
1.299     rillig   10235: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10236: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10237: <dd><dl>
1.299     rillig   10238: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10239: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10240: </dl></dd>
1.299     rillig   10241: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10242: <dd><dl>
1.299     rillig   10243: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10244: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10245: </dl></dd>
                   10246: </dl></dd>
1.299     rillig   10247: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig   10248: <dd><dl>
1.299     rillig   10249: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10250: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10251: <dd><dl>
1.299     rillig   10252: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10253: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10254: </dl></dd>
                   10255: </dl></dd>
1.299     rillig   10256: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10257: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   10258: </dl>
                   10259: </div>
                   10260: </div>
1.148     asau     10261: <div class="chapter">
1.75      rillig   10262: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10263: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10264: <div class="toc">
                   10265: <p><b>Table of Contents</b></p>
1.210     leot     10266: <dl class="toc">
1.299     rillig   10267: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10268: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10269: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig   10270: <dd><dl>
1.299     rillig   10271: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10272: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig   10273: </dl></dd>
1.299     rillig   10274: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10275: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10276: <dd><dl>
1.299     rillig   10277: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10278: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10279: </dl></dd>
1.299     rillig   10280: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10281: <dd><dl>
1.299     rillig   10282: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10283: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10284: </dl></dd>
                   10285: </dl>
                   10286: </div>
                   10287: <p>The pkgsrc infrastructure consists of many small Makefile
                   10288:        fragments. Each such fragment needs a properly specified
                   10289:        interface. This chapter explains how such an interface looks
                   10290:        like.</p>
1.148     asau     10291: <div class="sect1">
1.75      rillig   10292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10293: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10294: <p>Whenever a variable is defined in the pkgsrc
                   10295:        infrastructure, the location and the way of definition provide
                   10296:        much information about the intended use of that variable.
                   10297:        Additionally, more documentation may be found in a header
                   10298:        comment or in this pkgsrc guide.</p>
                   10299: <p>A special file is
                   10300:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10301:        variables that are intended to be user-defined. They are either
                   10302:        defined using the <code class="literal">?=</code> operator or they are
                   10303:        left undefined because defining them to anything would
1.128     wiz      10304:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10305:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10306:        file.</p>
                   10307: <p>Outside this file, the following conventions apply:
                   10308:        Variables that are defined using the <code class="literal">?=</code>
                   10309:        operator may be overridden by a package.</p>
                   10310: <p>Variables that are defined using the <code class="literal">=</code>
                   10311:        operator may be used read-only at run-time.</p>
                   10312: <p>Variables whose name starts with an underscore must not be
                   10313:        accessed outside the pkgsrc infrastructure at all. They may
                   10314:        change without further notice.</p>
1.148     asau     10315: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10316: <h3 class="title">Note</h3>
                   10317: <p>These conventions are currently not applied
                   10318:        consistently to the complete pkgsrc
                   10319:        infrastructure.</p>
                   10320: </div>
                   10321: </div>
1.148     asau     10322: <div class="sect1">
1.81      rillig   10323: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10324: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10325: <p>All variables that contain lists of things should default
                   10326:        to being empty. Two examples that do not follow this rule are
                   10327:        <code class="varname">USE_LANGUAGES</code> and
                   10328:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10329:        modified using the <code class="literal">+=</code> operator in package
                   10330:        <code class="filename">Makefile</code>s (or other files included by
                   10331:        them), since there is no guarantee whether the variable is
                   10332:        already set or not, and what its value is. In the case of
1.128     wiz      10333:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10334:        the default value and just define it as in the following
                   10335:        example.</p>
                   10336: <pre class="programlisting">
1.100     rillig   10337: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10338: </pre>
                   10339: <p>Because of the selection of this default value, the same
                   10340:        value appears in many package Makefiles. Similarly for
                   10341:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10342:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10343:        doesn't stand out. Nevertheless it is mentioned in many
                   10344:        files.</p>
                   10345: </div>
1.148     asau     10346: <div class="sect1">
1.81      rillig   10347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10348: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148     asau     10349: <div class="sect2">
1.75      rillig   10350: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10351: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75      rillig   10352: <p>Variable evaluation takes place either at load time or at
                   10353:        runtime, depending on the context in which they occur. The
                   10354:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10355: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10356: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10357:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10358: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10359:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10360: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10361: </ul></div>
                   10362: <p>A special exception are references to the iteration
                   10363:        variables of <code class="literal">.for</code> loops, which are expanded
                   10364:        inline, no matter in which context they appear.</p>
                   10365: <p>As the values of variables may change during load time,
                   10366:        care must be taken not to evaluate them by accident. Typical
                   10367:        examples for variables that should not be evaluated at load time
                   10368:        are <code class="varname">DEPENDS</code> and
                   10369:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10370:        clear, here is an example:</p>
                   10371: <pre class="programlisting">
1.100     rillig   10372: CONFIGURE_ARGS=         # none
                   10373: CFLAGS=                 -O
                   10374: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10375: 
1.100     rillig   10376: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10377: 
1.100     rillig   10378: CFLAGS+=                -Wall
1.222     sevan    10379: </pre>
1.75      rillig   10380: <p>This code shows how the use of the <code class="literal">:=</code>
                   10381:        operator can quickly lead to unexpected results. The first
                   10382:        paragraph is fairly common code. The second paragraph evaluates
                   10383:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10384:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10385:        <code class="literal">-Wall</code> is appended to the
                   10386:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10387:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10388:        paragraphs from above typically occur in completely unrelated
                   10389:        files.</p>
                   10390: </div>
1.148     asau     10391: <div class="sect2">
1.75      rillig   10392: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10393: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75      rillig   10394: <p>After all the files have been loaded, the values of the
                   10395:        variables cannot be changed anymore. Variables that are used in
                   10396:        the shell commands are expanded at this point.</p>
                   10397: </div>
                   10398: </div>
1.148     asau     10399: <div class="sect1">
1.75      rillig   10400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10401: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10402: <p>There are many ways in which the definition and use of a
1.218     rillig   10403:        variable can be restricted in order to detect bugs and violations
                   10404:        of the (mostly unwritten) policies. A package can be checked with
                   10405:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10406:        rules.</p>
1.78      rillig   10407: </div>
1.148     asau     10408: <div class="sect1">
1.78      rillig   10409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10410: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10411: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10412:        of the following classes. Cases where a file falls into more
                   10413:        than one class should be avoided as it often leads to subtle
                   10414:        bugs.</p>
1.148     asau     10415: <div class="sect2">
1.75      rillig   10416: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10417: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10418: <p>In a traditional imperative programming language some of
1.76      rillig   10419:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10420:        procedures. They take some input parameters and&mdash;after
                   10421:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10422:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10423:        care must be taken not to use parameter names that have already
                   10424:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10425:        bad choice for a parameter name.</p>
                   10426: <p>Procedures are completely evaluated at preprocessing time.
                   10427:        That is, when calling a procedure all input parameters must be
                   10428:        completely resolvable. For example,
                   10429:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10430:        parameter since it is very likely that further text will be
                   10431:        added after calling the procedure, which would effectively apply
                   10432:        the procedure to only a part of the variable. Also, references
1.218     rillig   10433:        to other variables will be modified after calling the
1.75      rillig   10434:        procedure.</p>
                   10435: <p>A procedure can declare its output parameters either as
                   10436:        suitable for use in preprocessing directives or as only
                   10437:        available at runtime. The latter alternative is for variables
                   10438:        that contain references to other runtime variables.</p>
                   10439: <p>Procedures shall be written such that it is possible to
                   10440:        call the procedure more than once. That is, the file must not
                   10441:        contain multiple-inclusion guards.</p>
                   10442: <p>Examples for procedures are
1.76      rillig   10443:        <code class="filename">mk/bsd.options.mk</code> and
                   10444:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10445:        that the parameters are evaluated at load time, they should be
                   10446:        assigned using the <code class="literal">:=</code> operator, which should
                   10447:        be used only for this purpose.</p>
                   10448: </div>
1.148     asau     10449: <div class="sect2">
1.75      rillig   10450: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10451: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10452: <p>Action files take some input parameters and may define
                   10453:        runtime variables. They shall not define loadtime variables.
                   10454:        There are action files that are included implicitly by the
                   10455:        pkgsrc infrastructure, while other must be included
                   10456:        explicitly.</p>
                   10457: <p>An example for action files is
1.76      rillig   10458:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10459: </div>
                   10460: </div>
1.148     asau     10461: <div class="sect1">
1.81      rillig   10462: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10463: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10464: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10465:        a set of variable definitions, and include the file
                   10466:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10467:        Before that, they may also include various other
                   10468:        <code class="filename">*.mk</code> files if they need to query the
                   10469:        availability of certain features like the type of compiler or
                   10470:        the X11 implementation. Due to the heavy use of preprocessor
                   10471:        directives like <code class="literal">.if</code> and
                   10472:        <code class="literal">.for</code>, the order in which the files are loaded
                   10473:        matters.</p>
                   10474: <p>This section describes at which point the various files
                   10475:        are loaded and gives reasons for that order.</p>
1.148     asau     10476: <div class="sect2">
1.81      rillig   10477: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10478: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10479: </h3></div></div></div>
                   10480: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10481:        is to define some essential variables like
                   10482:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10483:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10484: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10485:        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   10486:        After that, those variables
1.81      rillig   10487:        that have not been overridden by the user are loaded from
                   10488:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10489: <p>After the user settings, the system settings and platform
                   10490:        settings are loaded, which may override the user
                   10491:        settings.</p>
                   10492: <p>Then, the tool definitions are loaded. The tool wrappers
                   10493:        are not yet in effect. This only happens when building a
                   10494:        package, so the proper variables must be used instead of the
                   10495:        direct tool names.</p>
                   10496: <p>As the last steps, some essential variables from the
                   10497:        wrapper and the package system flavor are loaded, as well as the
                   10498:        variables that have been cached in earlier phases of a package
                   10499:        build.</p>
                   10500: </div>
1.148     asau     10501: <div class="sect2">
1.81      rillig   10502: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10503: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10504: </h3></div></div></div>
1.81      rillig   10505: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10506: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10507:        loaded, which fill default values for those variables that have
1.93      rillig   10508:        not been defined by the package. These variables may later
1.81      rillig   10509:        be used even in unrelated files.</p>
                   10510: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10511:        provides the target <code class="literal">error-check</code> that is added
                   10512:        as a special dependency to all other targets that use
                   10513:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10514:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10515: <p>Then, the package-specific hacks from
                   10516:        <code class="filename">hacks.mk</code> are included.</p>
                   10517: <p>Then, various other files follow. Most of them don't have
                   10518:        any dependencies on what they need to have included before or
                   10519:        after them, though some do.</p>
                   10520: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10521:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10522:        restricts the use of these variables to all the files that have
                   10523:        been included before. Appearances in later files will be
                   10524:        silently ignored.</p>
                   10525: <p>Then, the files for the main targets are included, in the
                   10526:        order of later execution, though the actual order should not
                   10527:        matter.</p>
                   10528: <p>At last, some more files are included that don't set any
                   10529:        interesting variables but rather just define make targets to be
                   10530:        executed.</p>
                   10531: </div>
                   10532: </div>
1.75      rillig   10533: </div>
1.148     asau     10534: <div class="chapter">
1.75      rillig   10535: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10536: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75      rillig   10537: <div class="toc">
                   10538: <p><b>Table of Contents</b></p>
1.210     leot     10539: <dl class="toc">
1.299     rillig   10540: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10541: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10542: <dd><dl>
1.299     rillig   10543: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10544: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10545: </dl></dd>
                   10546: </dl>
                   10547: </div>
                   10548: <p>The pkgsrc infrastructure consists of a large codebase,
                   10549:        and there are many corners where every little bit of a file is
                   10550:        well thought out, making pkgsrc likely to fail as soon as
                   10551:        anything is changed near those parts. To prevent most changes
                   10552:        from breaking anything, a suite of regression tests should go
                   10553:        along with every important part of the pkgsrc infrastructure.
                   10554:        This chapter describes how regression tests work in pkgsrc and
                   10555:        how you can add new tests.</p>
1.148     asau     10556: <div class="sect1">
1.75      rillig   10557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10558: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322     leot     10559: <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  10560:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10561:        can simply run that command, which will run all tests in the
1.283     rillig   10562:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10563: </div>
1.148     asau     10564: <div class="sect1">
1.75      rillig   10565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10566: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10567: <p>Every directory in the <code class="filename">regress/</code>
                   10568:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10569:        is considered a regression test. This file is a shell program
1.110     hubertf  10570:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10571:        The following functions can be overridden to suit your
                   10572:        needs.</p>
1.148     asau     10573: <div class="sect2">
1.75      rillig   10574: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10575: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10576: <p>These functions do not take any parameters. Although they
                   10577:        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     10578:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10579:        question</a> for details.</p>
1.148     asau     10580: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10581: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10582: <dd><p>This function prepares the environment for the
                   10583:        test. By default it does nothing.</p></dd>
1.218     rillig   10584: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10585: <dd>
                   10586: <p>This function runs the actual test. By default,
1.75      rillig   10587:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10588:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10589:        error messages into the file
1.218     rillig   10590:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10591: <p>When defining this function, make sure that all output that
                   10592:        needs to be checked is written to the correct output file.
                   10593:        Example:</p>
                   10594: <pre class="programlisting">
                   10595: do_test() {
1.223     rillig   10596:         echo "Example output"
1.218     rillig   10597: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10598: </pre>
                   10599: </dd>
                   10600: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10601: <dd>
                   10602: <p>This function is run after the test and is
1.75      rillig   10603:        typically used to compare the actual output from the one that is
                   10604:        expected. It can make use of the various helper functions from
1.218     rillig   10605:        the next section. Example:</p>
                   10606: <pre class="programlisting">
                   10607: check_result() {
1.223     rillig   10608:         exit_status 0
                   10609:         output_require "Example"
                   10610:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10611:         output_prohibit "no such file or directory"
1.283     rillig   10612:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10613: }
                   10614: </pre>
                   10615: </dd>
                   10616: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10617: <dd><p>This function cleans everything up after the
                   10618:        test has been run. By default it does nothing.</p></dd>
                   10619: </dl></div>
                   10620: </div>
1.148     asau     10621: <div class="sect2">
1.75      rillig   10622: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10623: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148     asau     10624: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10625: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10626: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10627: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10628: <dd><p>This function compares the exitcode of the
1.218     rillig   10629:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10630:        If they differ, the test will fail.</p></dd>
1.218     rillig   10631: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10632: <dd>
                   10633: <p>This function checks for each of its parameters
                   10634:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10635:        extended regular expression. If it does not, the test will
1.218     rillig   10636:        fail. Example:</p>
                   10637: <pre class="programlisting">
1.219     rillig   10638: output_require "looks fine"
                   10639: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10640: </pre>
                   10641: </dd>
1.292     leot     10642: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10643: <dd><p>This function checks for each of its parameters
1.110     hubertf  10644:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10645:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10646:        If any of the regular expressions matches, the test will
                   10647:        fail.</p></dd>
                   10648: </dl></div>
                   10649: </div>
                   10650: </div>
                   10651: </div>
1.148     asau     10652: <div class="chapter">
1.75      rillig   10653: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10654: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10655: <div class="toc">
                   10656: <p><b>Table of Contents</b></p>
1.299     rillig   10657: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   10658: </div>
                   10659: <p>The pkgsrc system has already been ported to many
                   10660:        operating systems, hardware architectures and compilers. This
                   10661:        chapter explains the necessary steps to make pkgsrc even more
                   10662:        portable.</p>
1.148     asau     10663: <div class="sect1">
1.75      rillig   10664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10665: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10666: <p>To port pkgsrc to a new operating system (called
                   10667:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10668:        following files:</p>
1.148     asau     10669: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10670: <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   10671: <dd><p>This file contains some basic definitions, for
                   10672:        example the name of the C
                   10673:        compiler.</p></dd>
1.76      rillig   10674: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10675: <dd><p>Insert code that defines the variables
                   10676:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327     wiz      10677:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75      rillig   10678:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10679:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10680:        appear in this file.</p></dd>
1.93      rillig   10681: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10682: <dd><p>This file contains the platform-specific
                   10683:        definitions that are used by pkgsrc. Start by copying one of the
                   10684:        other files and edit it to your
                   10685:        needs.</p></dd>
1.93      rillig   10686: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10687: <dd><p>This file defines the paths to all the tools
                   10688:        that are needed by one or the other package in pkgsrc, as well
                   10689:        as by pkgsrc itself. Find out where these tools are on your
                   10690:        platform and add them.</p></dd>
                   10691: </dl></div>
                   10692: <p>Now, you should be able to build some basic packages, like
1.322     leot     10693:        <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   10694: </div>
                   10695: </div>
                   10696: </div>
1.148     asau     10697: <div class="appendix">
                   10698: <div class="titlepage"><div><div><h1 class="title">
                   10699: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10700: <div class="toc">
                   10701: <p><b>Table of Contents</b></p>
1.210     leot     10702: <dl class="toc">
1.75      rillig   10703: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10704: <dd><dl>
                   10705: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10706: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10707: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10708: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10709: </dl></dd>
                   10710: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10711: </dl>
                   10712: </div>
                   10713: <p>We checked to find a piece of software that wasn't in the packages
                   10714:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10715:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10716:     present in the tree is beyond us, but it's useful for the purposes of
                   10717:     this exercise.</p>
1.148     asau     10718: <div class="sect1">
1.75      rillig   10719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10720: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10721: <div class="sect2">
1.75      rillig   10722: <div class="titlepage"><div><div><h3 class="title">
                   10723: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10724: <pre class="programlisting">
1.100     rillig   10725: # $NetBSD$
                   10726: #
1.1       grant    10727: 
1.100     rillig   10728: DISTNAME=       bison-1.25
                   10729: CATEGORIES=     devel
1.286     rillig   10730: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10731: 
1.136     dholland 10732: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10733: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10734: COMMENT=        GNU yacc clone
1.1       grant    10735: 
1.100     rillig   10736: GNU_CONFIGURE=  yes
1.152     wiz      10737: INFO_FILES=     yes
1.1       grant    10738: 
1.100     rillig   10739: .include "../../mk/bsd.pkg.mk"
1.1       grant    10740: </pre>
1.75      rillig   10741: </div>
1.148     asau     10742: <div class="sect2">
1.75      rillig   10743: <div class="titlepage"><div><div><h3 class="title">
                   10744: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10745: <pre class="programlisting">
1.100     rillig   10746: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.322     leot     10747: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10748: of the NetBSD source tree is beyond me.
1.1       grant    10749: </pre>
1.75      rillig   10750: </div>
1.148     asau     10751: <div class="sect2">
1.75      rillig   10752: <div class="titlepage"><div><div><h3 class="title">
                   10753: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10754: <pre class="programlisting">
1.100     rillig   10755: @comment $NetBSD$
                   10756: bin/bison
                   10757: man/man1/bison.1.gz
                   10758: share/bison.simple
                   10759: share/bison.hairy
1.1       grant    10760: </pre>
1.75      rillig   10761: </div>
1.148     asau     10762: <div class="sect2">
1.75      rillig   10763: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10764: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10765: <p>The NetBSD package system comes with
1.322     leot     10766:         <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   10767:        which helps to check the contents of these
                   10768:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10769:        directory of the package you wish to examine and run
1.110     hubertf  10770:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10771: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10772: ERROR: Makefile: Each package must define its LICENSE.
                   10773: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10774: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10775: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10776: 1 error, 2 warnings and 1 note found.
                   10777: (Run "pkglint -e" to show explanations.)
                   10778: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10779: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10780: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10781:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10782:        -Wall</strong></span> for a very thorough check.</p>
                   10783: </div>
                   10784: </div>
1.148     asau     10785: <div class="sect1">
1.75      rillig   10786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10787: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10788: <p>Create the directory where the package lives,
                   10789:       plus any auxiliary directories:</p>
                   10790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10791: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10792: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10793: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10794: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   10795:       <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   10796:       then continue with fetching the distfile:</p>
                   10797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10798: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10799: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10800: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10801: ftp: Error retrieving file: 500 Internal error
                   10802: 
                   10803: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10804: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10805: ftp: Error retrieving file: 500 Internal error
                   10806: 
                   10807: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10808: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10809: Successfully retrieved file.</pre>
                   10810: <p>Generate the checksum of the distfile into
1.76      rillig   10811:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10812: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10813: <p>Now compile:</p>
                   10814: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10815: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10816: ===&gt;  Extracting for bison-1.25
                   10817: ===&gt;  Patching for bison-1.25
                   10818: ===&gt;   Ignoring empty patch directory
                   10819: ===&gt;  Configuring for bison-1.25
                   10820: creating cache ./config.cache
                   10821: checking for gcc... cc
                   10822: checking whether we are using GNU C... yes
                   10823: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10824: checking how to run the C preprocessor... cc -E
                   10825: checking for minix/config.h... no
                   10826: checking for POSIXized ISC... no
                   10827: checking whether cross-compiling... no
                   10828: checking for ANSI C header files... yes
                   10829: checking for string.h... yes
                   10830: checking for stdlib.h... yes
                   10831: checking for memory.h... yes
                   10832: checking for working const... yes
                   10833: checking for working alloca.h... no
                   10834: checking for alloca... yes
                   10835: checking for strerror... yes
                   10836: updating cache ./config.cache
                   10837: creating ./config.status
                   10838: creating Makefile
                   10839: ===&gt;  Building for bison-1.25
                   10840: 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
                   10841: 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
                   10842: 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
                   10843: 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
                   10844: 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   10845: 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    10846: 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
                   10847: 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
                   10848: 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
                   10849: 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
                   10850: 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
                   10851: 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
                   10852: 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
                   10853: 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
                   10854: 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
                   10855: 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
                   10856: 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
                   10857: 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
                   10858: 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
                   10859: 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
                   10860: 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
                   10861: 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
                   10862: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10863: rm -f bison.s1
1.75      rillig   10864: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10865: <p>Everything seems OK, so install the files:</p>
                   10866: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10867: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10868: ===&gt;  Installing for bison-1.25
                   10869: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10870: rm -f /usr/pkg/bin/bison
                   10871: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10872: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10873: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10874: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10875: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10876: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10877: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10878: ===&gt;  Registering installation for bison-1.25</pre>
                   10879: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10880:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10881:       binary package, do this now:</p>
                   10882: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10883: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10884: ===&gt;  Building package for bison-1.25
                   10885: Creating package bison-1.25.tgz
                   10886: Registering depends:.
1.75      rillig   10887: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10888: <p>Now that you don't need the source and object files
                   10889:       any more, clean up:</p>
                   10890: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10891: ===&gt;  Cleaning for bison-1.25</pre>
                   10892: </div>
                   10893: </div>
1.148     asau     10894: <div class="appendix">
                   10895: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     10896: <a name="hardening"></a>Appendix B. Security hardening</h1></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.322     leot     10900: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   10901: <dd><dl>
                   10902: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   10903: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   10904: </dl></dd>
                   10905: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   10906: <dd><dl>
                   10907: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   10908: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   10909: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   10910: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   10911: </dl></dd>
                   10912: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   10913: <dd><dl>
                   10914: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   10915: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   10916: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   10917: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   10918: </dl></dd>
1.75      rillig   10919: </dl>
                   10920: </div>
1.322     leot     10921: <p>
                   10922: A number of mechanisms are available in pkgsrc to improve the security of the
                   10923: resulting system. This page describes the mechanisms, and gives hints
                   10924: about detecting and fixing problems.
                   10925: </p>
                   10926: <p>
                   10927: Mechanisms can be enabled individually in
                   10928: <code class="filename">mk.conf</code>, and are
                   10929: individually described below.
                   10930: </p>
                   10931: <p>
                   10932: Typically, a feature will cause some programs to fail to build or work
                   10933: when first enabled. This can be due to latent problems in the
                   10934: program, and can be due to other reasons. After enough testing to
                   10935: have confidence that user problems will be quite rare, individual
                   10936: mechanisms will be enabled by default.
                   10937: </p>
                   10938: <p>
                   10939: For each mechanism, see the Caveats section below for an explanation
                   10940: of what might go wrong at compile time and at run time, and how to
                   10941: notice and address these problems.
                   10942: </p>
1.148     asau     10943: <div class="sect1">
1.75      rillig   10944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     10945: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
                   10946: <div class="sect2">
                   10947: <div class="titlepage"><div><div><h3 class="title">
                   10948: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
                   10949: <div class="sect3">
                   10950: <div class="titlepage"><div><div><h4 class="title">
                   10951: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
                   10952: <p>
                   10953: This allows substitute wrappers to be used for some commonly used
                   10954: library functions that do not have built-in bounds checking - but
                   10955: could in some cases.
                   10956: </p>
                   10957: <p>
                   10958: Two mitigation levels are available:
                   10959: </p>
                   10960: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10961: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   10962: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   10963: </ul></div>
                   10964: <p>
                   10965: "strong" has been enabled by default since pkgsrc-2017Q3.
                   10966: </p>
                   10967: </div>
                   10968: <div class="sect3">
                   10969: <div class="titlepage"><div><div><h4 class="title">
                   10970: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
                   10971: <p>
                   10972: This enables a stack-smashing protection mitigation. It is done by adding a
                   10973: guard variable to functions with vulnerable objects. The guards are initialized
                   10974: when a function is entered and then checked when the function exits. The guard
                   10975: check will fail and the program forcibly exited if the variable was modified in
                   10976: the meantime. This can happen in case of buffer overflows or memory corruption,
                   10977: and therefore exposing these bugs.
                   10978: </p>
                   10979: <p>
                   10980: Different mitigation levels are available:
                   10981: </p>
                   10982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10983: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   10984: by the compiler;</p></li>
                   10985: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   10986: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   10987: two settings above.</p></li>
                   10988: </ul></div>
                   10989: <p>
                   10990: This mitigation is supported by both GCC and clang. It may be supported in
                   10991: additional compilers, possibly under a different name. It is particularly useful
                   10992: for unsafe programming languages, such as C/C++.
                   10993: </p>
                   10994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10995: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   10996: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   10997: </ul></div>
                   10998: <p>More details can be found here:</p>
                   10999: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11000: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11001: </p></li></ul></div>
                   11002: </div>
                   11003: <div class="sect3">
                   11004: <div class="titlepage"><div><div><h4 class="title">
                   11005: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
                   11006: <p>
                   11007: This requests the creation of PIE (Position Independent Executables) for all
                   11008: executables. The PIE mechanism is normally used for shared libraries, so that
                   11009: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11010: useful security properties; however, it is necessary to fully leverage some,
                   11011: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11012: (ASLR), which causes different addresses to be used each time a program is run.
                   11013: This makes it more difficult for an attacker to guess addresses and thus makes
                   11014: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11015: program, instead of the stack and heap only.
                   11016: </p>
                   11017: <p>
                   11018: PIE executables will only be built for toolchains that are known to support PIE.
                   11019: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11020: </p>
                   11021: <p>
                   11022: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11023: </p>
1.75      rillig   11024: </div>
1.325     gutterid 11025: <div class="sect3">
                   11026: <div class="titlepage"><div><div><h4 class="title">
1.334   ! nia      11027: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322     leot     11028: <p>
                   11029: This also makes the exploitation of some security vulnerabilities more
                   11030: difficult in some cases.
                   11031: </p>
                   11032: <p>Two different mitigation levels are available:</p>
                   11033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11034: <li class="listitem"><p>
1.334   ! nia      11035: partial (the default): the ELF sections are reordered so that internal data sections
1.322     leot     11036: precede the program's own data sections, and non-PLT GOT is read-only;
                   11037: </p></li>
                   11038: <li class="listitem"><p>
                   11039: full: in addition to partial RELRO, every relocation is performed immediately
1.333     nia      11040: when starting the program, allowing the entire GOT to be read-only.  This
                   11041: can greatly slow down startup of large programs.
1.322     leot     11042: </p></li>
                   11043: </ul></div>
                   11044: <p>
                   11045: This is currently supported by GCC. Many software distributions now enable this
1.325     gutterid 11046: feature by default, at the "partial" level. However, it cannot yet be enforced
                   11047: globally in pkgsrc through cwrappers.
1.322     leot     11048: </p>
                   11049: <p>
                   11050: More details can be found here:
                   11051: </p>
                   11052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11053: <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>
                   11054: </p></li></ul></div>
1.75      rillig   11055: </div>
1.334   ! nia      11056: </div>
        !          11057: <div class="sect2">
        !          11058: <div class="titlepage"><div><div><h3 class="title">
        !          11059: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
        !          11060: <div class="sect3">
        !          11061: <div class="titlepage"><div><div><h4 class="title">
        !          11062: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
        !          11063: <p>
        !          11064: With this option, pkgsrc will try to build packages reproducibly. This allows
        !          11065: packages built from the same tree and with the same options, to produce
        !          11066: identical results bit by bit. This option should be combined with ASLR and
        !          11067: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
        !          11068: attackers attempting to exploit security vulnerabilities.
        !          11069: </p>
        !          11070: <p>
        !          11071: More details can be found here:
        !          11072: </p>
        !          11073: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
        !          11074: <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>
        !          11075: </p></li></ul></div>
        !          11076: <p>
        !          11077: More work likely needs to be done before pkgsrc is fully reproducible.
        !          11078: </p>
        !          11079: </div>
1.322     leot     11080: <div class="sect3">
                   11081: <div class="titlepage"><div><div><h4 class="title">
1.334   ! nia      11082: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322     leot     11083: <p>
                   11084: This uses <code class="literal">-fstack-check</code> with GCC for
                   11085: another stack protection mitigation.
                   11086: </p>
                   11087: <p>
                   11088: It asks the compiler to generate code verifying that it does not corrupt the
                   11089: stack. According to GCC's manual page, this is really only useful for
                   11090: multi-threaded programs.
                   11091: </p>
1.76      rillig   11092: </div>
                   11093: </div>
                   11094: </div>
1.148     asau     11095: <div class="sect1">
1.76      rillig   11096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11097: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
                   11098: <div class="sect2">
                   11099: <div class="titlepage"><div><div><h3 class="title">
                   11100: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
                   11101: <div class="sect3">
                   11102: <div class="titlepage"><div><div><h4 class="title">
                   11103: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
                   11104: <p>
                   11105: A number of packages may fail to build with this option enabled. The
                   11106: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11107: compilation flag when building libraries or executables (or ideally
                   11108: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11109: <code class="varname">CFLAGS</code> already, but requires the package to
                   11110: actually support it.
                   11111: </p>
                   11112: <div class="sect4">
                   11113: <div class="titlepage"><div><div><h5 class="title">
                   11114: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
                   11115: <p>
                   11116: These instructions are meant as a reference only; they likely need to be adapted
                   11117: for many packages individually.
                   11118: </p>
                   11119: <p>
                   11120: For packages using <code class="filename">Makefiles</code>:
                   11121: </p>
                   11122: <pre class="programlisting">
                   11123: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11124: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11125: </pre>
                   11126: <p>
                   11127: For packages using <code class="filename">Imakefiles</code>:
                   11128: </p>
                   11129: <pre class="programlisting">
                   11130: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11131: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11132: </pre>
                   11133: </div>
                   11134: </div>
                   11135: <div class="sect3">
                   11136: <div class="titlepage"><div><div><h4 class="title">
                   11137: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
                   11138: <p>
                   11139: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11140: scenarios are essentially possible. This is nearly always due to a bug in
                   11141: the program being exposed due to ASLR.
                   11142: </p>
                   11143: </div>
                   11144: <div class="sect3">
                   11145: <div class="titlepage"><div><div><h4 class="title">
                   11146: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
                   11147: <p>
                   11148: Ideally, packages should be fixed for compatibility with MKPIE.
                   11149: However, in some cases this is very difficult, due to complex build systems,
                   11150: packages using non-standard toolchains, or programming languages with odd
                   11151: bootstrapping mechanisms.
                   11152: </p>
                   11153: <p>
                   11154: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11155: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11156: <code class="filename">bsd.prefs.mk</code> is included.
                   11157: </p>
                   11158: </div>
                   11159: </div>
                   11160: <div class="sect2">
                   11161: <div class="titlepage"><div><div><h3 class="title">
                   11162: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
                   11163: <div class="sect3">
                   11164: <div class="titlepage"><div><div><h4 class="title">
                   11165: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
                   11166: <p>
                   11167: This feature makes use of pre-processing directives to look for hardened,
                   11168: alternative implementations of essential library calls. Some programs may fail
                   11169: to build as a result; this usually happens for those trying too hard to be
                   11170: portable, or otherwise abusing definitions in the standard library.
                   11171: </p>
                   11172: </div>
                   11173: <div class="sect3">
                   11174: <div class="titlepage"><div><div><h4 class="title">
                   11175: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
                   11176: <p>
                   11177: This feature may cause some programs to crash, usually indicating an
                   11178: actual bug in the program. The fix will typically involve patching the
                   11179: original program's source code.
                   11180: </p>
                   11181: </div>
                   11182: <div class="sect3">
                   11183: <div class="titlepage"><div><div><h4 class="title">
                   11184: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
                   11185: <p>
                   11186: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11187: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11188: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11189: optimization level. This cannot easily be applied globally, as some packages
                   11190: may require specific optimization levels.
                   11191: </p>
                   11192: </div>
                   11193: <div class="sect3">
                   11194: <div class="titlepage"><div><div><h4 class="title">
                   11195: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
                   11196: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11197: <h3 class="title">Note</h3>
                   11198: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11199: the program!  This is a very bad idea and will expose you to security
                   11200: vulnerabilities.
                   11201: </p>
                   11202: </div>
                   11203: <p>
                   11204: To disable FORTIFY on a per-package basis, set the following
                   11205: in the package's <code class="filename">Makefile</code>
                   11206: before <code class="filename">bsd.prefs.mk</code> is included:
                   11207: </p>
                   11208: <pre class="programlisting">
                   11209: FORTIFY_SUPPORTED=     no
                   11210: </pre>
                   11211: </div>
                   11212: </div>
                   11213: <div class="sect2">
                   11214: <div class="titlepage"><div><div><h3 class="title">
                   11215: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
                   11216: <div class="sect3">
                   11217: <div class="titlepage"><div><div><h4 class="title">
                   11218: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
                   11219: <p>
                   11220: For better protection, full RELRO requires every symbol to be resolved when the
                   11221: program starts, rather than simply when required at run-time. This will have
                   11222: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11223: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11224: background are affected only when started. Programs loading plug-ins at
                   11225: run-time are affected when loading the plug-ins.
                   11226: </p>
                   11227: <p>
                   11228: The impact is not expected to be noticeable on modern hardware, except in some
                   11229: cases for big programs.
                   11230: </p>
                   11231: </div>
                   11232: <div class="sect3">
                   11233: <div class="titlepage"><div><div><h4 class="title">
                   11234: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
                   11235: <p>
                   11236: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11237: RELRO: for instance, with an initialization routine listing any other plug-in
                   11238: required. With full RELRO, the missing symbols are resolved before the
                   11239: initialization routine can run, and the dynamic loader will not be able to find
                   11240: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11241: drivers. Partial RELRO can be applied instead in this case.
                   11242: </p>
                   11243: </div>
                   11244: <div class="sect3">
                   11245: <div class="titlepage"><div><div><h4 class="title">
                   11246: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
                   11247: <p>
                   11248: To disable RELRO on a per-package basis, set the following
                   11249: in the package's <code class="filename">Makefile</code>
                   11250: before <code class="filename">bsd.prefs.mk</code> is included:
                   11251: </p>
                   11252: <pre class="programlisting">
                   11253: RELRO_SUPPORTED=       no
                   11254: </pre>
1.324     nia      11255: <p>
                   11256: It is also possible to at most enable partial RELRO, by
                   11257: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11258: </p>
1.322     leot     11259: </div>
                   11260: </div>
                   11261: <div class="sect2">
                   11262: <div class="titlepage"><div><div><h3 class="title">
                   11263: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
                   11264: <div class="sect3">
                   11265: <div class="titlepage"><div><div><h4 class="title">
                   11266: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
                   11267: <p>
                   11268: The stack-smashing protection provided by this option does not work for some
                   11269: programs. The most common situation in which this happens is when the program
                   11270: allocates variables on the stack, with the size determined at run-time.
                   11271: </p>
                   11272: </div>
                   11273: <div class="sect3">
                   11274: <div class="titlepage"><div><div><h4 class="title">
                   11275: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
                   11276: <p>
                   11277: Again, this feature may cause some programs to crash via a
                   11278: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11279: </p>
                   11280: <p>
                   11281: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11282: messages are sent and - by default -
                   11283: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11284: </p>
                   11285: <pre class="programlisting">
                   11286: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11287: </pre>
                   11288: <p>
                   11289: (where <code class="literal">hostname</code> is the hostname(1) and
                   11290: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11291: </p>
                   11292: <p>
                   11293: Patching the original program is then required.
                   11294: </p>
                   11295: <p>
                   11296: Rebuilding the package via:
                   11297: </p>
                   11298: <pre class="programlisting">
                   11299: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11300: </pre>
                   11301: <p>
                   11302: and inspecting the backtrace of the coredump via the debugger
                   11303: should point out the problematic call by inspecting the frame
                   11304: calling the _chk() (SSP) function.
                   11305: </p>
                   11306: </div>
                   11307: <div class="sect3">
                   11308: <div class="titlepage"><div><div><h4 class="title">
                   11309: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
                   11310: <p>
                   11311: The compiler emits extra code when using this feature: a check for buffer
                   11312: overflows is performed when entering and exiting functions, requiring an extra
                   11313: variable on the stack. The level of protection can otherwise be adjusted to
                   11314: affect only those functions considered more sensitive by the compiler (with
                   11315: -fstack-protector instead of -fstack-protector-all).
                   11316: </p>
                   11317: <p>
                   11318: The impact is not expected to be noticeable on modern hardware. However,
                   11319: programs with a hard requirement to run at the fastest possible speed should
                   11320: avoid using this feature, or using libraries built with this feature.
                   11321: </p>
                   11322: </div>
                   11323: <div class="sect3">
                   11324: <div class="titlepage"><div><div><h4 class="title">
                   11325: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
                   11326: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11327: <h3 class="title">Note</h3>
                   11328: <p>SSP should not be disabled to work around runtime crashes in
                   11329: the program!  This is a very bad idea and will expose you to security
                   11330: vulnerabilities.</p>
                   11331: </div>
                   11332: <p>
                   11333: To disable SSP on a per-package basis, set the following
                   11334: in the package's <code class="filename">Makefile</code>
                   11335: before <code class="filename">bsd.prefs.mk</code> is included:
                   11336: </p>
                   11337: <pre class="programlisting">
                   11338: SSP_SUPPORTED= no
                   11339: </pre>
                   11340: </div>
                   11341: </div>
                   11342: </div>
                   11343: <div class="sect1">
                   11344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11345: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
                   11346: <p>
                   11347: The illusion of security is worse than having no security at all. This section
                   11348: lists a number of ways to ensure the security features requested are actually
                   11349: effective.
                   11350: </p>
                   11351: <p>
                   11352: These instructions were obtained and tested on a system derived from NetBSD 7
                   11353: (amd64). YMMV.
                   11354: </p>
                   11355: <div class="sect2">
                   11356: <div class="titlepage"><div><div><h3 class="title">
                   11357: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
                   11358: <p>
                   11359: The ELF executable type in use changes for binaries built as PIE; without:
                   11360: </p>
                   11361: <pre class="programlisting">
                   11362: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11363: /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
                   11364: </pre>
                   11365: <p>as opposed to the following binary, built as PIE:</p>
                   11366: <pre class="programlisting">
                   11367: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11368: /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
                   11369: </pre>
                   11370: <p>
                   11371: The latter result is then what is expected.
                   11372: </p>
                   11373: </div>
                   11374: <div class="sect2">
                   11375: <div class="titlepage"><div><div><h3 class="title">
                   11376: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
                   11377: <p>
                   11378: The following command should list a section called RELRO:
                   11379: </p>
                   11380: <pre class="programlisting">
                   11381: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11382: 
                   11383: /path/to/bin/ary:     file format elf64-x86-64
                   11384: 
                   11385: Program Header:
                   11386: [...]
                   11387:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11388: </pre>
                   11389: <p>
                   11390: This check is now performed automatically if
                   11391: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11392: </p>
                   11393: </div>
                   11394: <div class="sect2">
                   11395: <div class="titlepage"><div><div><h3 class="title">
                   11396: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
                   11397: <p>
                   11398: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11399: the <code class="varname">BIND_NOW</code> flag:
                   11400: </p>
                   11401: <pre class="programlisting">
                   11402: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11403: 
                   11404: /path/to/bin/ary:     file format elf64-x86-64
                   11405: 
                   11406: Dynamic Section:
                   11407: [...]
                   11408:   BIND_NOW             0x0000000000000000
                   11409: </pre>
                   11410: <p>
                   11411: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11412: </p>
                   11413: <p>
                   11414: This check is now performed automatically (where supported) if
                   11415: <code class="varname">PKG_DEVELOPER</code> is set.
                   11416: </p>
                   11417: </div>
                   11418: <div class="sect2">
                   11419: <div class="titlepage"><div><div><h3 class="title">
                   11420: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323     nia      11421: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11422: <h3 class="title">Note</h3>
                   11423: <p>
                   11424: Checking for SSP using this method only works where the operating system
                   11425: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11426: on recent NetBSD/FreeBSD/Linux versions.
                   11427: </p>
                   11428: </div>
1.322     leot     11429: <p>
                   11430: Building objects, binaries and libraries with SSP will affect the presence of
                   11431: additional symbols in the resulting file:
                   11432: </p>
                   11433: <pre class="programlisting">
                   11434: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11435: [...]
                   11436:                  U __stack_chk_fail
                   11437: 0000000000600ea0 B __stack_chk_guard
                   11438: </pre>
                   11439: <p>
                   11440: This is an indicator that the program was indeed built with support for SSP.
                   11441: </p>
                   11442: <p>
                   11443: This check is now performed automatically (where supported) if
                   11444: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11445: </p>
                   11446: </div>
                   11447: </div>
                   11448: </div>
                   11449: <div class="appendix">
                   11450: <div class="titlepage"><div><div><h1 class="title">
                   11451: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
                   11452: <div class="toc">
                   11453: <p><b>Table of Contents</b></p>
                   11454: <dl class="toc">
                   11455: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11456: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11457: </dl>
                   11458: </div>
                   11459: <div class="sect1">
                   11460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11461: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
                   11462: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11463: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11464: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11465: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11466: =&gt; [172219 bytes]
                   11467: Connected to ftp.plig.net.
                   11468: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11469: 331 Guest login ok, send your complete e-mail address as password.
                   11470: 230-You are user #5 of 500 simultaneous users allowed.
                   11471: 230-
                   11472: 230-  ___ _             _ _
                   11473: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11474: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11475: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11476: 230-         |_|   |_|     |___|         |___|
                   11477: 230-
                   11478: 230-** Welcome to ftp.plig.org **
                   11479: 230-
                   11480: 230-Please note that all transfers from this FTP site are logged. If you
                   11481: 230-do not like this, please disconnect now.
                   11482: 230-
                   11483: 230-This archive is available via
                   11484: 230-
                   11485: 230-HTTP:  http://ftp.plig.org/
                   11486: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11487: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11488: 230-
                   11489: 230-Please email comments, bug reports and requests for packages to be
                   11490: 230-mirrored to ftp-admin@plig.org.
                   11491: 230-
                   11492: 230-
                   11493: 230 Logged in anonymously.
                   11494: Remote system type is UNIX.
                   11495: Using binary mode to transfer files.
                   11496: 200 Type okay.
                   11497: 250 "/pub" is new cwd.
                   11498: 250-"/pub/figlet" is new cwd.
                   11499: 250-
                   11500: 250-Welcome to the figlet archive at ftp.figlet.org
                   11501: 250-
                   11502: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11503: 250-
                   11504: 250-The official FIGlet web page is:
                   11505: 250-   http://www.figlet.org/
                   11506: 250-
                   11507: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11508: 250-contribute a font or something else, you can email us.
                   11509: 250
                   11510: 250 "/pub/figlet/program" is new cwd.
                   11511: 250 "/pub/figlet/program/unix" is new cwd.
                   11512: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11513: 502 Unimplemented command.
                   11514: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11515: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11516: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11517: 226 Transfer completed.
                   11518: 172219 bytes received in 00:02 (75.99 KB/s)
                   11519: 221 Goodbye.
                   11520: =&gt; Checksum OK for figlet221.tar.gz.
                   11521: ===&gt; Extracting for figlet-2.2.1nb2
                   11522: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11523: ===&gt; Patching for figlet-2.2.1nb2
                   11524: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11525: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11526: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11527: ===&gt; Configuring for figlet-2.2.1nb2
                   11528: ===&gt; Building for figlet-2.2.1nb2
                   11529: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11530: chmod a+x figlet
                   11531: gcc -O2 -o chkfont chkfont.c
                   11532: =&gt; Unwrapping files-to-be-installed.
                   11533: <code class="prompt">#</code>
                   11534: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11535: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11536: ===&gt; Installing for figlet-2.2.1nb2
                   11537: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11538: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11539: mkdir -p /usr/pkg/share/figlet
                   11540: cp figlet /usr/pkg/bin
                   11541: cp chkfont /usr/pkg/bin
                   11542: chmod 555 figlist showfigfonts
                   11543: cp figlist /usr/pkg/bin
                   11544: cp showfigfonts /usr/pkg/bin
                   11545: cp fonts/*.flf /usr/pkg/share/figlet
                   11546: cp fonts/*.flc /usr/pkg/share/figlet
                   11547: cp figlet.6 /usr/pkg/man/man6
                   11548: ===&gt; Registering installation for figlet-2.2.1nb2
                   11549: <code class="prompt">#</code></pre>
                   11550: </div>
                   11551: <div class="sect1">
                   11552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11553: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
                   11554: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11555: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11556: ===&gt; Packaging figlet-2.2.1nb2
                   11557: ===&gt; Building binary package for figlet-2.2.1nb2
                   11558: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11559: Using SrcDir value of /usr/pkg
                   11560: Registering depends:.
                   11561: <code class="prompt">#</code></pre>
                   11562: </div>
                   11563: </div>
                   11564: <div class="appendix">
                   11565: <div class="titlepage"><div><div><h1 class="title">
                   11566: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
                   11567: <div class="toc">
                   11568: <p><b>Table of Contents</b></p>
                   11569: <dl class="toc">
                   11570: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11571: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11572: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11573: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11574: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   11575: <code class="filename">stable</code>,
                   11576: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   11577: source packages</a></span></dt>
                   11578: </dl>
                   11579: </div>
                   11580: <p>As in other big projects, the directory layout of pkgsrc
                   11581:        is quite complex for newbies. This chapter explains where you
                   11582:        find things on the FTP server. The base directory on
                   11583:        <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>.
                   11584:        On other servers it may be different, but inside this directory,
                   11585:        everything should look the same, no matter on which server you
                   11586:        are. This directory contains some subdirectories, which are
                   11587:        explained below.</p>
                   11588: <div class="sect1">
                   11589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11590: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11591: <p>The directory <code class="filename">distfiles</code> contains lots
                   11592:        of archive files from all pkgsrc packages, which are mirrored
                   11593:        here. The subdirectories are called after their package names
                   11594:        and are used when the distributed files have names that don't
                   11595:        explicitly contain a version number or are otherwise too generic
                   11596:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11597: </div>
                   11598: <div class="sect1">
                   11599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11600: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11601: <p>This directory contains things that individual pkgsrc
                   11602:        developers find worth publishing.</p>
                   11603: </div>
                   11604: <div class="sect1">
                   11605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11606: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11607: <p>This directory contains binary packages for the various
                   11608:        platforms that are supported by pkgsrc.
                   11609:        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>
                   11610: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11611: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   11612:        operating system for which the packages have been built. The
                   11613:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   11614:        command, so it may differ from the one you are used to
                   11615:        hear.</p></li>
                   11616: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   11617:        architecture of the platform for which the packages have been
                   11618:        built. It also includes the <code class="varname">ABI</code> (Application
                   11619:        Binary Interface) for platforms that have several of
                   11620:        them.</p></li>
                   11621: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
                   11622:        the operating system. For version numbers that change often (for
                   11623:        example NetBSD-current), the often-changing part should be
                   11624:        replaced with an <code class="literal">x</code>, for example
                   11625:        <code class="literal">4.99.x</code>.</p></li>
                   11626: <li class="listitem"><p><code class="varname">TAG</code> is either
                   11627:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11628:        for a stable branch, or <code class="literal">head</code> for packages
                   11629:        built from the HEAD branch. The latter should only be used when
                   11630:        the packages are updated on a regular basis. Otherwise the date
                   11631:        from checking out pkgsrc should be appended, for example
                   11632:        <code class="literal">head_20071015</code>.</p></li>
                   11633: </ul></div>
                   11634: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11635:        can quickly click through the directories on the
                   11636:        server and find the best binary packages for their machines. Since they
                   11637:        usually know the operating system and the hardware architecture, OPSYS
                   11638:        and ARCH are placed first. After these choices, they can select the
                   11639:        best combination of OSVERSION and TAG together, since it is usually the
                   11640:        case that packages stay compatible between different version of the
                   11641:        operating system.</p>
                   11642: <p>In each of these directories, there is a
                   11643:        whole binary packages collection for a specific platform. It has a directory called
                   11644:        <code class="filename">All</code> which contains all binary packages.
                   11645:        Besides that, there are various category directories that
                   11646:        contain symbolic links to the real binary packages.</p>
                   11647: </div>
                   11648: <div class="sect1">
                   11649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11650: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11651: <p>Here are the reports from bulk builds, for those who want
                   11652:        to fix packages that didn't build on some of the platforms. The
1.322     leot     11653:        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   11654: </div>
1.148     asau     11655: <div class="sect1">
1.108     rillig   11656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11657: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261     leot     11658: <code class="filename">stable</code>,
1.126     jakllsch 11659: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11660: source packages</h2></div></div></div>
1.128     wiz      11661: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11662:        that is the files that define how to create binary packages from
                   11663:        source archives.</p>
1.262     leot     11664: <p>Each of the <code class="filename">current</code>,
                   11665:        <code class="filename">stable</code> and
                   11666:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11667:        directories share the same structure.  They each contain a
                   11668:        <code class="filename">pkgsrc</code> directory and
                   11669:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   11670: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11671:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     11672:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11673:        as the directory, ready to be downloaded as a whole.</p>
                   11674: <p>The <code class="filename">current</code> directory contains files
                   11675:        related to the HEAD branch of the CVS repository.
                   11676:        In this directory there is an additional file called
                   11677:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11678:        all pkgsrc <code class="filename">README</code>s with information about
                   11679:        categories and packages.
                   11680:        </p>
                   11681: <p>The <code class="filename">stable</code> directory is a symlink to
                   11682:        the latest 
                   11683:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11684:        </p>
                   11685: <p>The
                   11686:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11687:        directories contain files related to the 
                   11688:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11689:        stable branch of the CVS repository. In these directories there is
                   11690:        an additional file called
                   11691:        <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   11692:        which contains the state of pkgsrc when it was branched.</p>
                   11693: </div>
1.75      rillig   11694: </div>
1.148     asau     11695: <div class="appendix">
                   11696: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     11697: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267     rillig   11698: <p>
                   11699:        The following list contains all help topics that are available
                   11700:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11701: </p>
1.269     leot     11702: <table border="0" summary="Simple list" class="simplelist">
                   11703: <tr>
                   11704: <td>#!</td>
                   11705: <td>-lintl</td>
                   11706: </tr>
                   11707: <tr>
1.320     wiz      11708: <td>32bit</td>
1.269     leot     11709: <td>64bit</td>
1.320     wiz      11710: </tr>
                   11711: <tr>
1.269     leot     11712: <td>ABI</td>
1.320     wiz      11713: <td>ACCEPTABLE_LICENSES</td>
1.269     leot     11714: </tr>
                   11715: <tr>
                   11716: <td>ACROREAD_FONTPATH</td>
1.320     wiz      11717: <td>ADDITIONAL</td>
1.269     leot     11718: </tr>
                   11719: <tr>
                   11720: <td>AFAIK</td>
1.320     wiz      11721: <td>AIX</td>
1.269     leot     11722: </tr>
                   11723: <tr>
                   11724: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320     wiz      11725: <td>ALL_ENV</td>
1.269     leot     11726: </tr>
                   11727: <tr>
1.332     rillig   11728: <td>ALSA_PC</td>
1.315     cirnatda 11729: <td>ALTERNATIVES_SRC</td>
1.332     rillig   11730: </tr>
                   11731: <tr>
1.331     gutterid 11732: <td>AMANDA_TMP</td>
1.332     rillig   11733: <td>AMANDA_USER</td>
1.329     leot     11734: </tr>
                   11735: <tr>
1.331     gutterid 11736: <td>AMANDA_VAR</td>
1.332     rillig   11737: <td>APACHE_GROUP</td>
1.327     wiz      11738: </tr>
                   11739: <tr>
1.331     gutterid 11740: <td>APACHE_MODULE_NAME</td>
1.332     rillig   11741: <td>APACHE_MODULE_SRC</td>
1.311     leot     11742: </tr>
                   11743: <tr>
1.331     gutterid 11744: <td>APACHE_MODULE_SRCDIR</td>
1.332     rillig   11745: <td>APACHE_PKG_PREFIX</td>
1.292     leot     11746: </tr>
                   11747: <tr>
1.331     gutterid 11748: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.332     rillig   11749: <td>APACHE_SUEXEC_DOCROOT</td>
1.274     rillig   11750: </tr>
                   11751: <tr>
1.331     gutterid 11752: <td>APACHE_USER</td>
1.332     rillig   11753: <td>APPEND_ABI</td>
1.269     leot     11754: </tr>
                   11755: <tr>
1.331     gutterid 11756: <td>APPEND_ELF</td>
1.332     rillig   11757: <td>ARLA_CACHE</td>
1.269     leot     11758: </tr>
                   11759: <tr>
1.331     gutterid 11760: <td>AUDIT_PACKAGES_FLAGS</td>
1.332     rillig   11761: <td>AUTOCONF_REQD</td>
1.269     leot     11762: </tr>
                   11763: <tr>
1.331     gutterid 11764: <td>AUTOMAKE_OVERRIDE</td>
1.332     rillig   11765: <td>AUTOMAKE_REQD</td>
1.269     leot     11766: </tr>
                   11767: <tr>
1.331     gutterid 11768: <td>AUTO_MKDIRS</td>
1.332     rillig   11769: <td>BDB185_DEFAULT</td>
1.269     leot     11770: </tr>
                   11771: <tr>
1.331     gutterid 11772: <td>BDBBASE</td>
1.332     rillig   11773: <td>BDB_ACCEPTED</td>
1.269     leot     11774: </tr>
                   11775: <tr>
1.331     gutterid 11776: <td>BDB_DEFAULT</td>
1.332     rillig   11777: <td>BDB_LIBS</td>
1.269     leot     11778: </tr>
                   11779: <tr>
1.331     gutterid 11780: <td>BDB_TYPE</td>
1.332     rillig   11781: <td>BINCIMAP_GROUP</td>
1.269     leot     11782: </tr>
                   11783: <tr>
1.331     gutterid 11784: <td>BINCIMAP_USER</td>
1.332     rillig   11785: <td>BIND_DIR</td>
1.269     leot     11786: </tr>
                   11787: <tr>
1.331     gutterid 11788: <td>BIND_GROUP</td>
1.332     rillig   11789: <td>BIND_USER</td>
1.269     leot     11790: </tr>
                   11791: <tr>
1.331     gutterid 11792: <td>BINOWN</td>
1.332     rillig   11793: <td>BINPKG_SITES</td>
1.269     leot     11794: </tr>
                   11795: <tr>
1.331     gutterid 11796: <td>BIN_INSTALL_FLAGS</td>
1.332     rillig   11797: <td>BISON_PKGDATADIR</td>
1.312     gdt      11798: </tr>
                   11799: <tr>
1.331     gutterid 11800: <td>BLAS</td>
1.332     rillig   11801: <td>BLAS_ACCEPTED</td>
1.269     leot     11802: </tr>
                   11803: <tr>
1.331     gutterid 11804: <td>BLAS_C_INTERFACE</td>
1.332     rillig   11805: <td>BLAS_INCLUDES</td>
1.269     leot     11806: </tr>
                   11807: <tr>
1.331     gutterid 11808: <td>BLAS_INDEX64</td>
1.332     rillig   11809: <td>BLAS_LIBS</td>
1.303     bacon    11810: </tr>
                   11811: <tr>
1.331     gutterid 11812: <td>BLAS_TYPE</td>
1.332     rillig   11813: <td>BOOTSTRAP_DEPENDS</td>
1.320     wiz      11814: </tr>
                   11815: <tr>
1.329     leot     11816: <td>BROKEN</td>
1.332     rillig   11817: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269     leot     11818: </tr>
                   11819: <tr>
1.329     leot     11820: <td>BROKEN_ON_PLATFORM</td>
1.332     rillig   11821: <td>BSDSRCDIR</td>
1.292     leot     11822: </tr>
                   11823: <tr>
1.329     leot     11824: <td>BSDXSRCDIR</td>
1.332     rillig   11825: <td>BSD_MAKE_ENV</td>
1.269     leot     11826: </tr>
                   11827: <tr>
1.329     leot     11828: <td>BUILDLINK_AUTO_DIRS</td>
1.332     rillig   11829: <td>BUILDLINK_AUTO_VARS</td>
1.269     leot     11830: </tr>
                   11831: <tr>
1.329     leot     11832: <td>BUILDLINK_CFLAGS</td>
1.332     rillig   11833: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269     leot     11834: </tr>
                   11835: <tr>
1.329     leot     11836: <td>BUILDLINK_CPPFLAGS</td>
1.332     rillig   11837: <td>BUILDLINK_DEPMETHOD</td>
1.269     leot     11838: </tr>
                   11839: <tr>
                   11840: <td>BUILDLINK_FILES</td>
1.331     gutterid 11841: <td>BUILDLINK_FILES_CMD</td>
1.320     wiz      11842: </tr>
                   11843: <tr>
                   11844: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.331     gutterid 11845: <td>BUILDLINK_LDFLAGS</td>
1.269     leot     11846: </tr>
                   11847: <tr>
1.320     wiz      11848: <td>BUILDLINK_LIBS</td>
1.331     gutterid 11849: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269     leot     11850: </tr>
                   11851: <tr>
1.320     wiz      11852: <td>BUILDLINK_PKGNAME</td>
1.331     gutterid 11853: <td>BUILDLINK_PREFIX</td>
1.269     leot     11854: </tr>
                   11855: <tr>
1.320     wiz      11856: <td>BUILDLINK_RPATHDIRS</td>
1.331     gutterid 11857: <td>BUILDLINK_TREE</td>
1.269     leot     11858: </tr>
                   11859: <tr>
1.320     wiz      11860: <td>BUILD_DEFS</td>
1.331     gutterid 11861: <td>BUILD_DEFS_EFFECTS</td>
1.269     leot     11862: </tr>
                   11863: <tr>
1.320     wiz      11864: <td>BUILD_DEPENDS</td>
1.331     gutterid 11865: <td>BUILD_DIRS</td>
1.269     leot     11866: </tr>
                   11867: <tr>
1.320     wiz      11868: <td>BUILD_ENV_SHELL</td>
1.331     gutterid 11869: <td>BUILD_MAKE_CMD</td>
1.269     leot     11870: </tr>
                   11871: <tr>
1.320     wiz      11872: <td>BUILD_MAKE_FLAGS</td>
1.331     gutterid 11873: <td>BUILD_TARGET</td>
1.269     leot     11874: </tr>
                   11875: <tr>
1.320     wiz      11876: <td>BUILTIN_FIND_FILES</td>
1.331     gutterid 11877: <td>BUILTIN_FIND_FILES_VAR</td>
1.269     leot     11878: </tr>
                   11879: <tr>
1.320     wiz      11880: <td>BUILTIN_FIND_GREP</td>
1.331     gutterid 11881: <td>BUILTIN_FIND_HEADERS</td>
1.269     leot     11882: </tr>
                   11883: <tr>
1.320     wiz      11884: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.331     gutterid 11885: <td>BUILTIN_FIND_PKGCONFIG</td>
1.269     leot     11886: </tr>
                   11887: <tr>
1.320     wiz      11888: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.331     gutterid 11889: <td>BUILTIN_PKG</td>
1.309     gutterid 11890: </tr>
                   11891: <tr>
1.320     wiz      11892: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.331     gutterid 11893: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269     leot     11894: </tr>
                   11895: <tr>
1.320     wiz      11896: <td>BUILTIN_VERSION_SCRIPT</td>
1.331     gutterid 11897: <td>BUILTIN_X11_TYPE</td>
1.269     leot     11898: </tr>
                   11899: <tr>
1.320     wiz      11900: <td>BUILTIN_X11_VERSION</td>
1.331     gutterid 11901: <td>CACTI_GROUP</td>
1.269     leot     11902: </tr>
                   11903: <tr>
1.320     wiz      11904: <td>CACTI_USER</td>
1.331     gutterid 11905: <td>CANNA_GROUP</td>
1.269     leot     11906: </tr>
                   11907: <tr>
1.320     wiz      11908: <td>CANNA_USER</td>
1.331     gutterid 11909: <td>CAT</td>
1.269     leot     11910: </tr>
                   11911: <tr>
1.320     wiz      11912: <td>CBLAS_LIBS</td>
1.331     gutterid 11913: <td>CCACHE_BASE</td>
1.269     leot     11914: </tr>
                   11915: <tr>
1.303     bacon    11916: <td>CCACHE_DIR</td>
1.331     gutterid 11917: <td>CCACHE_LOGFILE</td>
1.269     leot     11918: </tr>
                   11919: <tr>
1.303     bacon    11920: <td>CC_VERSION</td>
1.331     gutterid 11921: <td>CC_VERSION_STRING</td>
1.269     leot     11922: </tr>
                   11923: <tr>
1.303     bacon    11924: <td>CDRECORD_CONF</td>
1.331     gutterid 11925: <td>CDROM_PKG_URL_DIR</td>
1.269     leot     11926: </tr>
                   11927: <tr>
1.303     bacon    11928: <td>CDROM_PKG_URL_HOST</td>
1.332     rillig   11929: <td>CHECKOUT_DATE</td>
                   11930: </tr>
                   11931: <tr>
1.303     bacon    11932: <td>CHECK_COMPILER</td>
1.332     rillig   11933: <td>CHECK_FAKEHOME</td>
1.329     leot     11934: </tr>
                   11935: <tr>
                   11936: <td>CHECK_FILES</td>
1.332     rillig   11937: <td>CHECK_FILES_SKIP</td>
1.327     wiz      11938: </tr>
                   11939: <tr>
1.329     leot     11940: <td>CHECK_FILES_STRICT</td>
1.332     rillig   11941: <td>CHECK_HEADERS</td>
1.320     wiz      11942: </tr>
                   11943: <tr>
1.329     leot     11944: <td>CHECK_HEADERS_SKIP</td>
1.332     rillig   11945: <td>CHECK_INTERPRETER</td>
1.311     leot     11946: </tr>
                   11947: <tr>
1.329     leot     11948: <td>CHECK_INTERPRETER_SKIP</td>
1.332     rillig   11949: <td>CHECK_PERMS</td>
1.292     leot     11950: </tr>
                   11951: <tr>
1.329     leot     11952: <td>CHECK_PERMS_AUTOFIX</td>
1.332     rillig   11953: <td>CHECK_PERMS_SKIP</td>
1.274     rillig   11954: </tr>
                   11955: <tr>
1.331     gutterid 11956: <td>CHECK_PIE</td>
1.332     rillig   11957: <td>CHECK_PIE_SKIP</td>
1.331     gutterid 11958: </tr>
                   11959: <tr>
                   11960: <td>CHECK_PIE_SUPPORTED</td>
1.332     rillig   11961: <td>CHECK_PORTABILITY</td>
1.269     leot     11962: </tr>
                   11963: <tr>
1.328     jnemeth  11964: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.332     rillig   11965: <td>CHECK_PORTABILITY_SKIP</td>
1.269     leot     11966: </tr>
                   11967: <tr>
1.328     jnemeth  11968: <td>CHECK_RELRO</td>
1.332     rillig   11969: <td>CHECK_RELRO_SKIP</td>
1.269     leot     11970: </tr>
                   11971: <tr>
1.328     jnemeth  11972: <td>CHECK_RELRO_SUPPORTED</td>
1.332     rillig   11973: <td>CHECK_SHLIBS</td>
1.269     leot     11974: </tr>
                   11975: <tr>
1.328     jnemeth  11976: <td>CHECK_SHLIBS_SKIP</td>
1.332     rillig   11977: <td>CHECK_SHLIBS_SUPPORTED</td>
1.269     leot     11978: </tr>
                   11979: <tr>
1.328     jnemeth  11980: <td>CHECK_SHLIBS_TOXIC</td>
1.332     rillig   11981: <td>CHECK_SSP</td>
1.269     leot     11982: </tr>
                   11983: <tr>
1.328     jnemeth  11984: <td>CHECK_SSP_SKIP</td>
1.332     rillig   11985: <td>CHECK_SSP_SUPPORTED</td>
1.269     leot     11986: </tr>
                   11987: <tr>
1.328     jnemeth  11988: <td>CHECK_STRIPPED</td>
1.332     rillig   11989: <td>CHECK_STRIPPED_SKIP</td>
1.269     leot     11990: </tr>
                   11991: <tr>
1.328     jnemeth  11992: <td>CHECK_WRKREF</td>
1.332     rillig   11993: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269     leot     11994: </tr>
                   11995: <tr>
1.328     jnemeth  11996: <td>CHECK_WRKREF_SKIP</td>
1.332     rillig   11997: <td>CLAMAV_DBDIR</td>
1.269     leot     11998: </tr>
                   11999: <tr>
1.328     jnemeth  12000: <td>CLAMAV_GROUP</td>
1.332     rillig   12001: <td>CLAMAV_USER</td>
1.269     leot     12002: </tr>
                   12003: <tr>
1.328     jnemeth  12004: <td>CLANGBASE</td>
1.332     rillig   12005: <td>CLEANDEPENDS</td>
1.269     leot     12006: </tr>
                   12007: <tr>
1.328     jnemeth  12008: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.332     rillig   12009: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269     leot     12010: </tr>
                   12011: <tr>
1.328     jnemeth  12012: <td>CMAKE_INSTALL_PREFIX</td>
1.332     rillig   12013: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269     leot     12014: </tr>
                   12015: <tr>
1.328     jnemeth  12016: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.332     rillig   12017: <td>CMAKE_PREFIX_PATH</td>
1.269     leot     12018: </tr>
                   12019: <tr>
1.305     bacon    12020: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.332     rillig   12021: <td>COMMON_LISP_DOCFILES</td>
                   12022: </tr>
                   12023: <tr>
                   12024: <td>COMMON_LISP_EXAMPLES</td>
                   12025: <td>COMMON_LISP_EXTRAFILES</td>
                   12026: </tr>
                   12027: <tr>
                   12028: <td>COMMON_LISP_PACKAGES</td>
                   12029: <td>COMMON_LISP_SYSTEM</td>
1.292     leot     12030: </tr>
                   12031: <tr>
1.305     bacon    12032: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     12033: <td>COMPILER_USE_SYMLINKS</td>
                   12034: </tr>
                   12035: <tr>
1.305     bacon    12036: <td>CONFIGURE_ARGS</td>
1.269     leot     12037: <td>CONFIGURE_DIRS</td>
                   12038: </tr>
                   12039: <tr>
1.305     bacon    12040: <td>CONFIGURE_ENV</td>
1.287     rillig   12041: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     12042: </tr>
                   12043: <tr>
1.305     bacon    12044: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     12045: <td>CONFIGURE_HAS_MANDIR</td>
                   12046: </tr>
                   12047: <tr>
1.305     bacon    12048: <td>CONFIGURE_SCRIPT</td>
1.269     leot     12049: <td>CONFIG_SHELL</td>
                   12050: </tr>
                   12051: <tr>
1.305     bacon    12052: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     12053: <td>CONF_FILES</td>
                   12054: </tr>
                   12055: <tr>
1.305     bacon    12056: <td>CONF_FILES_MODE</td>
1.269     leot     12057: <td>CONF_FILES_PERMS</td>
                   12058: </tr>
                   12059: <tr>
1.305     bacon    12060: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     12061: <td>CONSERVER_DEFAULTPORT</td>
                   12062: </tr>
                   12063: <tr>
1.305     bacon    12064: <td>CP</td>
1.269     leot     12065: <td>CPP</td>
                   12066: </tr>
                   12067: <tr>
1.305     bacon    12068: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     12069: <td>CREATE_WRKDIR_SYMLINK</td>
                   12070: </tr>
                   12071: <tr>
1.305     bacon    12072: <td>CROSSBASE</td>
1.269     leot     12073: <td>CTFCONVERT</td>
                   12074: </tr>
                   12075: <tr>
1.305     bacon    12076: <td>CTF_FILES_SKIP</td>
1.269     leot     12077: <td>CTF_SUPPORTED</td>
                   12078: </tr>
                   12079: <tr>
1.305     bacon    12080: <td>CTYPE</td>
1.269     leot     12081: <td>CUPS_GROUP</td>
                   12082: </tr>
                   12083: <tr>
1.305     bacon    12084: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     12085: <td>CUPS_USER</td>
                   12086: </tr>
                   12087: <tr>
1.305     bacon    12088: <td>CURSES_DEFAULT</td>
1.269     leot     12089: <td>CURSES_TYPE</td>
1.292     leot     12090: </tr>
                   12091: <tr>
1.332     rillig   12092: <td>CVS_EXTRACTDIR</td>
                   12093: <td>CVS_MODULE</td>
                   12094: </tr>
                   12095: <tr>
                   12096: <td>CVS_PROJECT</td>
                   12097: <td>CVS_REPOSITORIES</td>
                   12098: </tr>
                   12099: <tr>
                   12100: <td>CVS_ROOT</td>
                   12101: <td>CVS_ROOT_GNU</td>
                   12102: </tr>
                   12103: <tr>
                   12104: <td>CVS_ROOT_NONGNU</td>
                   12105: <td>CVS_ROOT_SOURCEFORGE</td>
                   12106: </tr>
                   12107: <tr>
                   12108: <td>CVS_TAG</td>
1.273     brook    12109: <td>CXX</td>
1.332     rillig   12110: </tr>
                   12111: <tr>
1.331     gutterid 12112: <td>CYRUS_GROUP</td>
1.332     rillig   12113: <td>CYRUS_IDLE</td>
1.329     leot     12114: </tr>
                   12115: <tr>
1.331     gutterid 12116: <td>CYRUS_USER</td>
1.332     rillig   12117: <td>DAEMONTOOLS_GROUP</td>
1.327     wiz      12118: </tr>
                   12119: <tr>
1.331     gutterid 12120: <td>DAEMONTOOLS_LOG_USER</td>
1.332     rillig   12121: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.320     wiz      12122: </tr>
                   12123: <tr>
1.331     gutterid 12124: <td>DARWIN_REQUIRES_FILTER</td>
1.332     rillig   12125: <td>DBUS_GROUP</td>
1.311     leot     12126: </tr>
                   12127: <tr>
1.331     gutterid 12128: <td>DBUS_USER</td>
1.332     rillig   12129: <td>DEFANG_GROUP</td>
1.269     leot     12130: </tr>
                   12131: <tr>
1.331     gutterid 12132: <td>DEFANG_USER</td>
1.332     rillig   12133: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269     leot     12134: </tr>
                   12135: <tr>
1.331     gutterid 12136: <td>DEFAULT_DISTFILES</td>
1.332     rillig   12137: <td>DEFAULT_IRC_SERVER</td>
1.269     leot     12138: </tr>
                   12139: <tr>
1.331     gutterid 12140: <td>DEFAULT_SERIAL_DEVICE</td>
1.332     rillig   12141: <td>DEF_UMASK</td>
1.309     gutterid 12142: </tr>
                   12143: <tr>
1.331     gutterid 12144: <td>DEINSTALLDEPENDS</td>
1.332     rillig   12145: <td>DEINSTALL_SRC</td>
1.269     leot     12146: </tr>
                   12147: <tr>
1.331     gutterid 12148: <td>DEINSTALL_TEMPLATES</td>
1.332     rillig   12149: <td>DELAYED_ERROR_MSG</td>
1.269     leot     12150: </tr>
                   12151: <tr>
1.331     gutterid 12152: <td>DELAYED_WARNING_MSG</td>
1.332     rillig   12153: <td>DEPENDS</td>
1.269     leot     12154: </tr>
                   12155: <tr>
1.331     gutterid 12156: <td>DEPENDS_TARGET</td>
1.332     rillig   12157: <td>DEPENDS_TYPE</td>
1.269     leot     12158: </tr>
                   12159: <tr>
1.331     gutterid 12160: <td>DESTDIR</td>
1.332     rillig   12161: <td>DESTDIR_VARNAME</td>
1.269     leot     12162: </tr>
                   12163: <tr>
1.331     gutterid 12164: <td>DIALER_GROUP</td>
1.332     rillig   12165: <td>DIGEST_REQD</td>
1.269     leot     12166: </tr>
                   12167: <tr>
1.331     gutterid 12168: <td>DISTDIR</td>
1.332     rillig   12169: <td>DISTFILES</td>
1.269     leot     12170: </tr>
                   12171: <tr>
1.331     gutterid 12172: <td>DISTINFO_FILE</td>
1.332     rillig   12173: <td>DISTNAME</td>
1.269     leot     12174: </tr>
                   12175: <tr>
1.331     gutterid 12176: <td>DIST_PATH</td>
1.332     rillig   12177: <td>DIST_SUBDIR</td>
1.269     leot     12178: </tr>
                   12179: <tr>
1.331     gutterid 12180: <td>DJBDNS_AXFR_USER</td>
1.332     rillig   12181: <td>DJBDNS_CACHE_USER</td>
1.269     leot     12182: </tr>
                   12183: <tr>
1.331     gutterid 12184: <td>DJBDNS_DJBDNS_GROUP</td>
1.332     rillig   12185: <td>DJBDNS_LOG_USER</td>
1.269     leot     12186: </tr>
                   12187: <tr>
1.331     gutterid 12188: <td>DJBDNS_RBL_USER</td>
1.332     rillig   12189: <td>DJBDNS_TINY_USER</td>
1.269     leot     12190: </tr>
                   12191: <tr>
1.331     gutterid 12192: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.332     rillig   12193: <td>DL_AUTO_VARS</td>
1.269     leot     12194: </tr>
                   12195: <tr>
1.331     gutterid 12196: <td>DL_CFLAGS</td>
1.332     rillig   12197: <td>DL_LDFLAGS</td>
1.269     leot     12198: </tr>
                   12199: <tr>
1.331     gutterid 12200: <td>DL_LIBS</td>
1.332     rillig   12201: <td>DNS</td>
1.269     leot     12202: </tr>
                   12203: <tr>
1.331     gutterid 12204: <td>DOCOWN</td>
1.332     rillig   12205: <td>DOWNLOADED_DISTFILE</td>
1.269     leot     12206: </tr>
                   12207: <tr>
1.333     nia      12208: <td>DQCACHE_GROUP</td>
                   12209: <td>DQCACHE_USER</td>
                   12210: </tr>
                   12211: <tr>
1.331     gutterid 12212: <td>DT_LAYOUT</td>
1.332     rillig   12213: <td>DYNAMIC_SITES_CMD</td>
1.269     leot     12214: </tr>
                   12215: <tr>
1.331     gutterid 12216: <td>DYNAMIC_SITES_SCRIPT</td>
1.332     rillig   12217: <td>ECHO</td>
1.269     leot     12218: </tr>
                   12219: <tr>
1.331     gutterid 12220: <td>ECHO_N</td>
1.332     rillig   12221: <td>ELK_GUI</td>
1.269     leot     12222: </tr>
                   12223: <tr>
1.331     gutterid 12224: <td>EMACS_TYPE</td>
1.332     rillig   12225: <td>EMULDIR</td>
1.269     leot     12226: </tr>
                   12227: <tr>
1.331     gutterid 12228: <td>EMULSUBDIR</td>
1.332     rillig   12229: <td>EMULSUBDIRSLASH</td>
1.269     leot     12230: </tr>
                   12231: <tr>
1.331     gutterid 12232: <td>EMUL_ARCH</td>
1.332     rillig   12233: <td>EMUL_DISTRO</td>
1.269     leot     12234: </tr>
                   12235: <tr>
1.331     gutterid 12236: <td>EMUL_EXEC_FMT</td>
1.332     rillig   12237: <td>EMUL_IS_NATIVE</td>
1.269     leot     12238: </tr>
                   12239: <tr>
1.331     gutterid 12240: <td>EMUL_MODULES</td>
1.332     rillig   12241: <td>EMUL_OPSYS</td>
1.269     leot     12242: </tr>
                   12243: <tr>
1.331     gutterid 12244: <td>EMUL_PKG_FMT</td>
1.332     rillig   12245: <td>EMUL_PLATFORM</td>
1.269     leot     12246: </tr>
                   12247: <tr>
1.331     gutterid 12248: <td>EMUL_PLATFORMS</td>
1.332     rillig   12249: <td>EMUL_PREFER</td>
1.269     leot     12250: </tr>
                   12251: <tr>
1.331     gutterid 12252: <td>EMUL_REQD</td>
1.332     rillig   12253: <td>EMUL_TYPE</td>
1.269     leot     12254: </tr>
                   12255: <tr>
1.331     gutterid 12256: <td>ERROR_MSG</td>
1.332     rillig   12257: <td>EXIM_GROUP</td>
1.269     leot     12258: </tr>
                   12259: <tr>
1.331     gutterid 12260: <td>EXIM_USER</td>
1.332     rillig   12261: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269     leot     12262: </tr>
                   12263: <tr>
1.331     gutterid 12264: <td>EXTRACTOR</td>
1.332     rillig   12265: <td>EXTRACT_CMD</td>
1.269     leot     12266: </tr>
                   12267: <tr>
1.331     gutterid 12268: <td>EXTRACT_CMD_DEFAULT</td>
1.332     rillig   12269: <td>EXTRACT_DIR</td>
1.269     leot     12270: </tr>
                   12271: <tr>
1.331     gutterid 12272: <td>EXTRACT_ELEMENTS</td>
1.332     rillig   12273: <td>EXTRACT_ENV</td>
1.269     leot     12274: </tr>
                   12275: <tr>
1.331     gutterid 12276: <td>EXTRACT_ONLY</td>
1.332     rillig   12277: <td>EXTRACT_OPTS</td>
1.269     leot     12278: </tr>
                   12279: <tr>
1.331     gutterid 12280: <td>EXTRACT_SUFX</td>
1.332     rillig   12281: <td>EXTRACT_USING</td>
1.269     leot     12282: </tr>
                   12283: <tr>
1.331     gutterid 12284: <td>FAIL</td>
1.332     rillig   12285: <td>FAILOVER_FETCH</td>
1.269     leot     12286: </tr>
                   12287: <tr>
1.331     gutterid 12288: <td>FAIL_MSG</td>
1.332     rillig   12289: <td>FAKE_NCURSES</td>
1.269     leot     12290: </tr>
                   12291: <tr>
1.331     gutterid 12292: <td>FAM</td>
1.332     rillig   12293: <td>FAM_ACCEPTED</td>
1.269     leot     12294: </tr>
                   12295: <tr>
1.331     gutterid 12296: <td>FAM_DEFAULT</td>
1.332     rillig   12297: <td>FAM_SERVER</td>
1.269     leot     12298: </tr>
                   12299: <tr>
1.331     gutterid 12300: <td>FCPATH</td>
1.332     rillig   12301: <td>FEATURE_CPPFLAGS</td>
1.292     leot     12302: </tr>
                   12303: <tr>
1.331     gutterid 12304: <td>FEATURE_LDFLAGS</td>
1.332     rillig   12305: <td>FEATURE_LIBS</td>
1.269     leot     12306: </tr>
                   12307: <tr>
1.331     gutterid 12308: <td>FETCH_AFTER_ARGS</td>
1.332     rillig   12309: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     12310: </tr>
                   12311: <tr>
1.331     gutterid 12312: <td>FETCH_CMD</td>
1.332     rillig   12313: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     12314: </tr>
                   12315: <tr>
1.331     gutterid 12316: <td>FETCH_PROXY</td>
1.332     rillig   12317: <td>FETCH_RESUME_ARGS</td>
1.269     leot     12318: </tr>
                   12319: <tr>
1.331     gutterid 12320: <td>FETCH_TIMEOUT</td>
1.332     rillig   12321: <td>FETCH_USE_IPV4_ONLY</td>
1.269     leot     12322: </tr>
                   12323: <tr>
1.331     gutterid 12324: <td>FETCH_USING</td>
1.332     rillig   12325: <td>FILES_SUBST</td>
1.269     leot     12326: </tr>
                   12327: <tr>
1.331     gutterid 12328: <td>FILES_SUBST_SED</td>
1.332     rillig   12329: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     12330: </tr>
                   12331: <tr>
1.332     rillig   12332: <td>FONTDIR</td>
1.295     rillig   12333: <td>FONTS_DIRS</td>
1.274     rillig   12334: </tr>
                   12335: <tr>
1.305     bacon    12336: <td>FONTS_VERBOSE</td>
1.295     rillig   12337: <td>FOO_HACKS_MK</td>
1.292     leot     12338: </tr>
                   12339: <tr>
1.332     rillig   12340: <td>FOSSIL_EXTRACTDIR</td>
                   12341: <td>FOSSIL_REPO</td>
                   12342: </tr>
                   12343: <tr>
                   12344: <td>FOSSIL_REPOSITORIES</td>
                   12345: <td>FOSSIL_VERSION</td>
                   12346: </tr>
                   12347: <tr>
1.305     bacon    12348: <td>FOX_USE_XUNICODE</td>
1.295     rillig   12349: <td>FREEWNN_GROUP</td>
1.269     leot     12350: </tr>
                   12351: <tr>
1.305     bacon    12352: <td>FREEWNN_USER</td>
1.295     rillig   12353: <td>FTP_PKG_URL_DIR</td>
1.269     leot     12354: </tr>
                   12355: <tr>
1.305     bacon    12356: <td>FTP_PKG_URL_HOST</td>
1.295     rillig   12357: <td>GAMEDATAMODE</td>
1.269     leot     12358: </tr>
                   12359: <tr>
1.305     bacon    12360: <td>GAMEDATA_PERMS</td>
1.295     rillig   12361: <td>GAMEDIRMODE</td>
1.269     leot     12362: </tr>
                   12363: <tr>
1.305     bacon    12364: <td>GAMEDIR_PERMS</td>
1.295     rillig   12365: <td>GAMEGRP</td>
1.269     leot     12366: </tr>
                   12367: <tr>
1.305     bacon    12368: <td>GAMEMODE</td>
1.295     rillig   12369: <td>GAMEOWN</td>
1.269     leot     12370: </tr>
                   12371: <tr>
1.305     bacon    12372: <td>GAMES_GROUP</td>
1.295     rillig   12373: <td>GAMES_USER</td>
1.269     leot     12374: </tr>
                   12375: <tr>
1.305     bacon    12376: <td>GCC</td>
1.295     rillig   12377: <td>GCCBASE</td>
1.269     leot     12378: </tr>
                   12379: <tr>
1.305     bacon    12380: <td>GCC_REQD</td>
1.295     rillig   12381: <td>GCC_VERSION_SUFFIX</td>
1.269     leot     12382: </tr>
                   12383: <tr>
1.305     bacon    12384: <td>GEM_BUILD</td>
1.295     rillig   12385: <td>GEM_CLEANBUILD</td>
1.269     leot     12386: </tr>
                   12387: <tr>
1.305     bacon    12388: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295     rillig   12389: <td>GEM_DOCDIR</td>
1.269     leot     12390: </tr>
                   12391: <tr>
1.305     bacon    12392: <td>GEM_EXTSDIR</td>
1.295     rillig   12393: <td>GEM_HOME</td>
1.292     leot     12394: </tr>
                   12395: <tr>
1.305     bacon    12396: <td>GEM_KEEPBUILD</td>
1.295     rillig   12397: <td>GEM_LIBDIR</td>
1.269     leot     12398: </tr>
                   12399: <tr>
1.305     bacon    12400: <td>GEM_NAME</td>
1.295     rillig   12401: <td>GEM_PATH</td>
1.269     leot     12402: </tr>
                   12403: <tr>
1.312     gdt      12404: <td>GEM_PLUGINSDIR</td>
1.305     bacon    12405: <td>GEM_SPECFILE</td>
1.269     leot     12406: </tr>
                   12407: <tr>
1.312     gdt      12408: <td>GENERATE_PLIST</td>
1.316     cirnatda 12409: <td>GHC</td>
1.269     leot     12410: </tr>
                   12411: <tr>
1.316     cirnatda 12412: <td>GHOSTSCRIPT_REQD</td>
1.312     gdt      12413: <td>GITHUB_PROJECT</td>
1.292     leot     12414: </tr>
                   12415: <tr>
1.316     cirnatda 12416: <td>GITHUB_RELEASE</td>
1.315     cirnatda 12417: <td>GITHUB_SUBMODULES</td>
1.311     leot     12418: </tr>
                   12419: <tr>
1.316     cirnatda 12420: <td>GITHUB_TAG</td>
1.313     leot     12421: <td>GITHUB_TYPE</td>
1.269     leot     12422: </tr>
                   12423: <tr>
1.332     rillig   12424: <td>GITLAB_PROJECT</td>
                   12425: <td>GITLAB_TAG</td>
                   12426: </tr>
                   12427: <tr>
                   12428: <td>GITLAB_TYPE</td>
                   12429: <td>GIT_BRANCH</td>
                   12430: </tr>
                   12431: <tr>
                   12432: <td>GIT_ENV</td>
                   12433: <td>GIT_EXTRACTDIR</td>
                   12434: </tr>
                   12435: <tr>
                   12436: <td>GIT_REPO</td>
                   12437: <td>GIT_REPOSITORIES</td>
                   12438: </tr>
                   12439: <tr>
                   12440: <td>GIT_REVISION</td>
                   12441: <td>GIT_TAG</td>
                   12442: </tr>
                   12443: <tr>
1.316     cirnatda 12444: <td>GNU</td>
1.313     leot     12445: <td>GNU_CONFIGURE</td>
1.269     leot     12446: </tr>
                   12447: <tr>
1.316     cirnatda 12448: <td>GNU_CONFIGURE_INFODIR</td>
1.313     leot     12449: <td>GNU_CONFIGURE_MANDIR</td>
1.269     leot     12450: </tr>
                   12451: <tr>
1.316     cirnatda 12452: <td>GNU_CONFIGURE_QUIET</td>
1.313     leot     12453: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     12454: </tr>
                   12455: <tr>
1.316     cirnatda 12456: <td>GODEP_REDIRECTS</td>
1.313     leot     12457: <td>GO_BUILD_PATTERN</td>
1.276     leot     12458: </tr>
                   12459: <tr>
1.316     cirnatda 12460: <td>GO_DEPS</td>
1.313     leot     12461: <td>GO_DIST_BASE</td>
1.269     leot     12462: </tr>
                   12463: <tr>
1.324     nia      12464: <td>GO_EXTRA_MOD_DIRS</td>
1.316     cirnatda 12465: <td>GO_MODULE_FILES</td>
1.269     leot     12466: </tr>
                   12467: <tr>
1.324     nia      12468: <td>GO_SRCPATH</td>
1.316     cirnatda 12469: <td>GO_VERSION_DEFAULT</td>
1.269     leot     12470: </tr>
                   12471: <tr>
1.324     nia      12472: <td>GROUP_SPECIFIC_PKGS</td>
1.316     cirnatda 12473: <td>GRUB_NETWORK_CARDS</td>
1.311     leot     12474: </tr>
                   12475: <tr>
1.324     nia      12476: <td>GRUB_PRESET_COMMAND</td>
1.316     cirnatda 12477: <td>GRUB_SCAN_ARGS</td>
1.269     leot     12478: </tr>
                   12479: <tr>
1.324     nia      12480: <td>GZIP</td>
1.332     rillig   12481: <td>HASKELL_COMPILER</td>
                   12482: </tr>
                   12483: <tr>
1.331     gutterid 12484: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.332     rillig   12485: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.329     leot     12486: </tr>
                   12487: <tr>
1.331     gutterid 12488: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.332     rillig   12489: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.327     wiz      12490: </tr>
                   12491: <tr>
1.331     gutterid 12492: <td>HAS_CONFIGURE</td>
1.332     rillig   12493: <td>HEADER_TEMPLATES</td>
                   12494: </tr>
                   12495: <tr>
                   12496: <td>HG_REPO</td>
                   12497: <td>HG_REPOSITORIES</td>
1.320     wiz      12498: </tr>
                   12499: <tr>
1.332     rillig   12500: <td>HG_TAG</td>
1.316     cirnatda 12501: <td>HOMEPAGE</td>
1.269     leot     12502: </tr>
                   12503: <tr>
1.324     nia      12504: <td>HOST_PKGTOOLS_ARGS</td>
1.316     cirnatda 12505: <td>HOST_SPECIFIC_PKGS</td>
1.305     bacon    12506: </tr>
                   12507: <tr>
1.324     nia      12508: <td>HOWL_GROUP</td>
1.316     cirnatda 12509: <td>HOWL_USER</td>
1.269     leot     12510: </tr>
                   12511: <tr>
1.324     nia      12512: <td>ICCBASE</td>
1.316     cirnatda 12513: <td>ICECAST_CHROOTDIR</td>
1.269     leot     12514: </tr>
                   12515: <tr>
1.324     nia      12516: <td>ICON_THEMES</td>
1.316     cirnatda 12517: <td>IDOBASE</td>
1.269     leot     12518: </tr>
                   12519: <tr>
1.324     nia      12520: <td>IGNORE_CCACHE</td>
1.316     cirnatda 12521: <td>IGNORE_INFO_DIRS</td>
1.269     leot     12522: </tr>
                   12523: <tr>
1.324     nia      12524: <td>IGNORE_INTERACTIVE_FETCH</td>
1.316     cirnatda 12525: <td>IMAKE</td>
1.269     leot     12526: </tr>
                   12527: <tr>
1.324     nia      12528: <td>IMAKEOPTS</td>
1.316     cirnatda 12529: <td>IMAKE_MAKE</td>
1.269     leot     12530: </tr>
                   12531: <tr>
1.324     nia      12532: <td>IMAKE_MANINSTALL</td>
1.316     cirnatda 12533: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269     leot     12534: </tr>
                   12535: <tr>
1.324     nia      12536: <td>IMDICTDIR</td>
1.316     cirnatda 12537: <td>INCOMPAT_CURSES</td>
1.269     leot     12538: </tr>
                   12539: <tr>
1.324     nia      12540: <td>INFO_DIR</td>
1.316     cirnatda 12541: <td>INFO_FILES</td>
1.269     leot     12542: </tr>
                   12543: <tr>
1.324     nia      12544: <td>INFO_FILES_VERBOSE</td>
1.316     cirnatda 12545: <td>INFO_MSG</td>
1.287     rillig   12546: </tr>
                   12547: <tr>
1.324     nia      12548: <td>INIT_SYSTEM</td>
1.316     cirnatda 12549: <td>INN_DATA_DIR</td>
1.269     leot     12550: </tr>
                   12551: <tr>
1.324     nia      12552: <td>INN_GROUP</td>
1.316     cirnatda 12553: <td>INN_USER</td>
1.269     leot     12554: </tr>
                   12555: <tr>
1.324     nia      12556: <td>INSTALLATION_DIRS</td>
1.316     cirnatda 12557: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269     leot     12558: </tr>
                   12559: <tr>
1.324     nia      12560: <td>INSTALL_ENV</td>
1.316     cirnatda 12561: <td>INSTALL_SH_OVERRIDE</td>
1.269     leot     12562: </tr>
                   12563: <tr>
1.324     nia      12564: <td>INSTALL_SRC</td>
1.316     cirnatda 12565: <td>INSTALL_TEMPLATES</td>
1.269     leot     12566: </tr>
                   12567: <tr>
1.324     nia      12568: <td>INSTALL_UNSTRIPPED</td>
1.316     cirnatda 12569: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269     leot     12570: </tr>
                   12571: <tr>
1.324     nia      12572: <td>IRCD_HYBRID_IRC_USER</td>
1.316     cirnatda 12573: <td>IRCD_HYBRID_MAXCONN</td>
1.269     leot     12574: </tr>
                   12575: <tr>
1.324     nia      12576: <td>IRCD_HYBRID_NICLEN</td>
1.316     cirnatda 12577: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269     leot     12578: </tr>
                   12579: <tr>
1.324     nia      12580: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.316     cirnatda 12581: <td>IRCD_HYBRID_TOPICLEN</td>
1.269     leot     12582: </tr>
                   12583: <tr>
1.324     nia      12584: <td>IRIX</td>
1.316     cirnatda 12585: <td>IRRD_USE_PGP</td>
1.269     leot     12586: </tr>
                   12587: <tr>
1.324     nia      12588: <td>JABBERD_GROUP</td>
1.316     cirnatda 12589: <td>JABBERD_LOGDIR</td>
1.292     leot     12590: </tr>
                   12591: <tr>
1.324     nia      12592: <td>JABBERD_PIDDIR</td>
1.316     cirnatda 12593: <td>JABBERD_SPOOLDIR</td>
1.311     leot     12594: </tr>
                   12595: <tr>
1.324     nia      12596: <td>JABBERD_USER</td>
1.333     nia      12597: <td>JAVA_APP_PATH</td>
1.320     wiz      12598: </tr>
                   12599: <tr>
1.332     rillig   12600: <td>JAVA_APP_TARGETS</td>
1.333     nia      12601: <td>JAVA_BINPREFIX</td>
1.269     leot     12602: </tr>
                   12603: <tr>
1.332     rillig   12604: <td>JAVA_CLASSPATH</td>
1.333     nia      12605: <td>JAVA_HOME</td>
1.332     rillig   12606: </tr>
                   12607: <tr>
1.316     cirnatda 12608: <td>JAVA_LD_LIBRARY_PATH</td>
1.333     nia      12609: <td>JAVA_NAME</td>
1.332     rillig   12610: </tr>
                   12611: <tr>
                   12612: <td>JAVA_UNLIMIT</td>
1.333     nia      12613: <td>JAVA_WRAPPERS</td>
1.269     leot     12614: </tr>
                   12615: <tr>
1.332     rillig   12616: <td>JPEG_ACCEPTED</td>
1.333     nia      12617: <td>JPEG_DEFAULT</td>
1.269     leot     12618: </tr>
                   12619: <tr>
1.332     rillig   12620: <td>KERBEROS</td>
1.333     nia      12621: <td>KERMIT_SUID_UUCP</td>
1.269     leot     12622: </tr>
                   12623: <tr>
1.332     rillig   12624: <td>KJS_USE_PCRE</td>
1.333     nia      12625: <td>KNEWS_DOMAIN_FILE</td>
1.269     leot     12626: </tr>
                   12627: <tr>
1.332     rillig   12628: <td>KNEWS_DOMAIN_NAME</td>
1.333     nia      12629: <td>KRB5_ACCEPTED</td>
1.292     leot     12630: </tr>
                   12631: <tr>
1.332     rillig   12632: <td>KRB5_DEFAULT</td>
1.333     nia      12633: <td>LANGUAGES</td>
1.271     brook    12634: </tr>
                   12635: <tr>
1.332     rillig   12636: <td>LAPACKE_LIBS</td>
1.333     nia      12637: <td>LAPACK_LIBS</td>
1.269     leot     12638: </tr>
                   12639: <tr>
1.332     rillig   12640: <td>LATEX2HTML_ICONPATH</td>
1.333     nia      12641: <td>LDCONFIG_ADD_CMD</td>
1.269     leot     12642: </tr>
                   12643: <tr>
1.332     rillig   12644: <td>LDCONFIG_REMOVE_CMD</td>
1.333     nia      12645: <td>LDD</td>
1.269     leot     12646: </tr>
                   12647: <tr>
1.332     rillig   12648: <td>LEAFNODE_DATA_DIR</td>
1.333     nia      12649: <td>LEAFNODE_GROUP</td>
1.269     leot     12650: </tr>
                   12651: <tr>
1.332     rillig   12652: <td>LEAFNODE_USER</td>
1.333     nia      12653: <td>LIBDVDCSS_HOMEPAGE</td>
1.320     wiz      12654: </tr>
                   12655: <tr>
1.332     rillig   12656: <td>LIBDVDCSS_MASTER_SITES</td>
1.333     nia      12657: <td>LIBRSVG_TYPE</td>
1.270     leot     12658: </tr>
                   12659: <tr>
1.332     rillig   12660: <td>LIBTOOL</td>
1.333     nia      12661: <td>LIBTOOLIZE_PLIST</td>
1.327     wiz      12662: </tr>
                   12663: <tr>
1.332     rillig   12664: <td>LIBTOOL_M4_OVERRIDE</td>
1.333     nia      12665: <td>LIBUSB_TYPE</td>
1.269     leot     12666: </tr>
                   12667: <tr>
1.332     rillig   12668: <td>LICENSE</td>
1.333     nia      12669: <td>LINKER_RPATH_FLAG</td>
1.292     leot     12670: </tr>
                   12671: <tr>
1.332     rillig   12672: <td>LINK_RPATH_FLAG</td>
1.333     nia      12673: <td>LINUX_BASE_NODEPS</td>
1.332     rillig   12674: </tr>
                   12675: <tr>
                   12676: <td>LINUX_BASE_PREFERRED</td>
1.333     nia      12677: <td>LINUX_BASE_REQUIRED</td>
1.269     leot     12678: </tr>
                   12679: <tr>
1.325     gutterid 12680: <td>LINUX_LOCALES</td>
1.333     nia      12681: <td>LOCALBASE</td>
1.329     leot     12682: </tr>
                   12683: <tr>
                   12684: <td>LOCALBASE_LOCKTYPE</td>
1.333     nia      12685: <td>LOCALPATCHES</td>
1.269     leot     12686: </tr>
                   12687: <tr>
1.329     leot     12688: <td>LOVE_DATA</td>
1.333     nia      12689: <td>LOVE_GAME</td>
1.269     leot     12690: </tr>
                   12691: <tr>
1.329     leot     12692: <td>LOVE_VERSION</td>
1.333     nia      12693: <td>LP32PLATFORMS</td>
1.269     leot     12694: </tr>
                   12695: <tr>
1.329     leot     12696: <td>LP64PLATFORMS</td>
1.333     nia      12697: <td>LUA_CDIR</td>
                   12698: </tr>
                   12699: <tr>
                   12700: <td>LUA_COMPILER</td>
                   12701: <td>LUA_DOCDIR</td>
                   12702: </tr>
                   12703: <tr>
                   12704: <td>LUA_EXAMPLESDIR</td>
                   12705: <td>LUA_INCDIR</td>
                   12706: </tr>
                   12707: <tr>
                   12708: <td>LUA_INTERPRETER</td>
                   12709: <td>LUA_LDIR</td>
                   12710: </tr>
                   12711: <tr>
                   12712: <td>LUA_LINKER_MAGIC</td>
                   12713: <td>LUA_PKGPREFIX</td>
                   12714: </tr>
                   12715: <tr>
                   12716: <td>LUA_SELF_CONFLICT</td>
                   12717: <td>LUA_VERSIONS_ACCEPTED</td>
                   12718: </tr>
                   12719: <tr>
                   12720: <td>LUA_VERSIONS_INCOMPATIBLE</td>
                   12721: <td>LUA_VERSION_DEFAULT</td>
                   12722: </tr>
                   12723: <tr>
                   12724: <td>LUA_VERSION_REQD</td>
                   12725: <td>Lua</td>
1.269     leot     12726: </tr>
                   12727: <tr>
1.328     jnemeth  12728: <td>MACHINE_PLATFORM</td>
1.332     rillig   12729: <td>MAILAGENT_DOMAIN</td>
1.320     wiz      12730: </tr>
                   12731: <tr>
1.328     jnemeth  12732: <td>MAILAGENT_EMAIL</td>
1.332     rillig   12733: <td>MAILAGENT_FQDN</td>
1.269     leot     12734: </tr>
                   12735: <tr>
1.328     jnemeth  12736: <td>MAILAGENT_ORGANIZATION</td>
1.332     rillig   12737: <td>MAJORDOMO_HOMEDIR</td>
1.269     leot     12738: </tr>
                   12739: <tr>
1.332     rillig   12740: <td>MAJOR_OS_VERSION</td>
1.324     nia      12741: <td>MAKEINFO_ARGS</td>
1.327     wiz      12742: </tr>
                   12743: <tr>
1.316     cirnatda 12744: <td>MAKE_DIRS</td>
1.327     wiz      12745: <td>MAKE_DIRS_PERMS</td>
1.269     leot     12746: </tr>
                   12747: <tr>
1.316     cirnatda 12748: <td>MAKE_ENV</td>
1.327     wiz      12749: <td>MAKE_FILE</td>
1.269     leot     12750: </tr>
                   12751: <tr>
1.316     cirnatda 12752: <td>MAKE_FLAGS</td>
1.327     wiz      12753: <td>MAKE_JOBS</td>
1.269     leot     12754: </tr>
                   12755: <tr>
1.316     cirnatda 12756: <td>MAKE_JOBS_SAFE</td>
1.327     wiz      12757: <td>MAKE_PROGRAM</td>
1.303     bacon    12758: </tr>
                   12759: <tr>
1.316     cirnatda 12760: <td>MANCOMPRESSED_IF_MANZ</td>
1.327     wiz      12761: <td>MANINSTALL</td>
1.269     leot     12762: </tr>
                   12763: <tr>
1.316     cirnatda 12764: <td>MANZ</td>
1.327     wiz      12765: <td>MASTER_SITES</td>
1.269     leot     12766: </tr>
                   12767: <tr>
1.316     cirnatda 12768: <td>MASTER_SITE_BACKUP</td>
1.327     wiz      12769: <td>MASTER_SITE_LOCAL</td>
1.269     leot     12770: </tr>
                   12771: <tr>
1.316     cirnatda 12772: <td>MASTER_SITE_MOZILLA</td>
1.327     wiz      12773: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     12774: </tr>
                   12775: <tr>
1.316     cirnatda 12776: <td>MASTER_SITE_PERL_CPAN</td>
1.327     wiz      12777: <td>MASTER_SORT</td>
1.269     leot     12778: </tr>
                   12779: <tr>
1.316     cirnatda 12780: <td>MASTER_SORT_RANDOM</td>
1.327     wiz      12781: <td>MASTER_SORT_REGEX</td>
1.269     leot     12782: </tr>
                   12783: <tr>
1.316     cirnatda 12784: <td>MECAB_CHARSET</td>
1.327     wiz      12785: <td>MEDIATOMB_GROUP</td>
1.269     leot     12786: </tr>
                   12787: <tr>
1.316     cirnatda 12788: <td>MEDIATOMB_USER</td>
1.327     wiz      12789: <td>MIPSPROBASE</td>
1.269     leot     12790: </tr>
                   12791: <tr>
1.316     cirnatda 12792: <td>MIREDO_GROUP</td>
1.327     wiz      12793: <td>MIREDO_USER</td>
1.269     leot     12794: </tr>
                   12795: <tr>
1.316     cirnatda 12796: <td>MISSING_FEATURES</td>
1.327     wiz      12797: <td>MKDIR</td>
1.269     leot     12798: </tr>
                   12799: <tr>
1.322     leot     12800: <td>MKPIE_SUPPORTED</td>
1.327     wiz      12801: <td>MLDONKEY_GROUP</td>
1.322     leot     12802: </tr>
                   12803: <tr>
1.313     leot     12804: <td>MLDONKEY_HOME</td>
1.327     wiz      12805: <td>MLDONKEY_USER</td>
1.269     leot     12806: </tr>
                   12807: <tr>
1.313     leot     12808: <td>MONOTONE_GROUP</td>
1.327     wiz      12809: <td>MONOTONE_USER</td>
1.269     leot     12810: </tr>
                   12811: <tr>
1.313     leot     12812: <td>MOTIFBASE</td>
1.327     wiz      12813: <td>MOTIF_TYPE</td>
1.269     leot     12814: </tr>
                   12815: <tr>
1.313     leot     12816: <td>MOTIF_TYPE_DEFAULT</td>
1.327     wiz      12817: <td>MPI_TYPE</td>
1.269     leot     12818: </tr>
                   12819: <tr>
1.313     leot     12820: <td>MSGFMT_STRIP_MSGCTXT</td>
1.327     wiz      12821: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.311     leot     12822: </tr>
                   12823: <tr>
1.313     leot     12824: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.332     rillig   12825: <td>MUST</td>
1.329     leot     12826: </tr>
                   12827: <tr>
1.332     rillig   12828: <td>MV</td>
1.329     leot     12829: <td>MYSQL_CHARSET</td>
1.269     leot     12830: </tr>
                   12831: <tr>
1.332     rillig   12832: <td>MYSQL_DATADIR</td>
1.329     leot     12833: <td>MYSQL_EXTRA_CHARSET</td>
1.320     wiz      12834: </tr>
                   12835: <tr>
1.332     rillig   12836: <td>MYSQL_GROUP</td>
1.329     leot     12837: <td>MYSQL_USER</td>
1.269     leot     12838: </tr>
                   12839: <tr>
1.332     rillig   12840: <td>MYSQL_VERSION</td>
1.329     leot     12841: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.269     leot     12842: </tr>
                   12843: <tr>
1.332     rillig   12844: <td>MYSQL_VERSIONS_ALL</td>
1.329     leot     12845: <td>MYSQL_VERSION_DEFAULT</td>
1.269     leot     12846: </tr>
                   12847: <tr>
1.332     rillig   12848: <td>NAGIOSCMD_GROUP</td>
1.329     leot     12849: <td>NAGIOSDIR</td>
1.309     gutterid 12850: </tr>
                   12851: <tr>
1.332     rillig   12852: <td>NAGIOS_GROUP</td>
1.329     leot     12853: <td>NAGIOS_USER</td>
1.269     leot     12854: </tr>
                   12855: <tr>
1.332     rillig   12856: <td>NATIVE_APPEND_ABI</td>
1.329     leot     12857: <td>NATIVE_APPEND_ELF</td>
1.269     leot     12858: </tr>
                   12859: <tr>
1.332     rillig   12860: <td>NATIVE_EXEC_FMT</td>
1.329     leot     12861: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     12862: </tr>
                   12863: <tr>
1.332     rillig   12864: <td>NATIVE_OBJECT_FMT</td>
1.329     leot     12865: <td>NBPAX_PROGRAM_PREFIX</td>
1.269     leot     12866: </tr>
                   12867: <tr>
1.332     rillig   12868: <td>NETBSD_LOGIN_NAME</td>
1.329     leot     12869: <td>NMH_EDITOR</td>
1.269     leot     12870: </tr>
                   12871: <tr>
1.332     rillig   12872: <td>NMH_MTA</td>
1.329     leot     12873: <td>NMH_PAGER</td>
1.269     leot     12874: </tr>
                   12875: <tr>
1.333     nia      12876: <td>NODE_VERSIONS_ACCEPTED</td>
                   12877: <td>NODE_VERSIONS_INCOMPATIBLE</td>
                   12878: </tr>
                   12879: <tr>
                   12880: <td>NODE_VERSION_DEFAULT</td>
                   12881: <td>NODE_VERSION_REQD</td>
                   12882: </tr>
                   12883: <tr>
1.328     jnemeth  12884: <td>NOLOGIN</td>
1.332     rillig   12885: <td>NOTE</td>
1.293     rillig   12886: </tr>
                   12887: <tr>
1.328     jnemeth  12888: <td>NOT_FOR_PLATFORM</td>
1.332     rillig   12889: <td>NOT_PAX_ASLR_SAFE</td>
1.269     leot     12890: </tr>
                   12891: <tr>
1.328     jnemeth  12892: <td>NOT_PAX_MPROTECT_SAFE</td>
1.332     rillig   12893: <td>NO_BUILD</td>
1.269     leot     12894: </tr>
                   12895: <tr>
1.328     jnemeth  12896: <td>NO_CHECKSUM</td>
1.332     rillig   12897: <td>NO_CONFIGURE</td>
1.269     leot     12898: </tr>
                   12899: <tr>
1.328     jnemeth  12900: <td>NO_SKIP</td>
1.332     rillig   12901: <td>NS_PREFERRED</td>
1.269     leot     12902: </tr>
                   12903: <tr>
1.328     jnemeth  12904: <td>NULLMAILER_GROUP</td>
1.332     rillig   12905: <td>NULLMAILER_USER</td>
1.269     leot     12906: </tr>
                   12907: <tr>
1.328     jnemeth  12908: <td>OASIS</td>
1.332     rillig   12909: <td>OASIS_BUILD_ARGS</td>
1.269     leot     12910: </tr>
                   12911: <tr>
1.328     jnemeth  12912: <td>OBJHOSTNAME</td>
1.332     rillig   12913: <td>OBJMACHINE</td>
1.269     leot     12914: </tr>
                   12915: <tr>
1.328     jnemeth  12916: <td>OCAML_FINDLIB_DIRS</td>
1.332     rillig   12917: <td>OCAML_FINDLIB_REGISTER</td>
1.269     leot     12918: </tr>
                   12919: <tr>
1.328     jnemeth  12920: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.332     rillig   12921: <td>OCAML_SITELIBDIR</td>
1.269     leot     12922: </tr>
                   12923: <tr>
1.328     jnemeth  12924: <td>OCAML_TOPKG_DOCDIR</td>
1.332     rillig   12925: <td>OCAML_USE_DUNE</td>
1.269     leot     12926: </tr>
                   12927: <tr>
1.328     jnemeth  12928: <td>OCAML_USE_FINDLIB</td>
1.332     rillig   12929: <td>OCAML_USE_JBUILDER</td>
1.269     leot     12930: </tr>
                   12931: <tr>
1.328     jnemeth  12932: <td>OCAML_USE_OASIS</td>
1.332     rillig   12933: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269     leot     12934: </tr>
                   12935: <tr>
1.328     jnemeth  12936: <td>OCAML_USE_OPAM</td>
1.332     rillig   12937: <td>OCAML_USE_OPT_COMPILER</td>
1.269     leot     12938: </tr>
                   12939: <tr>
1.328     jnemeth  12940: <td>OCAML_USE_TOPKG</td>
1.332     rillig   12941: <td>OMF</td>
1.269     leot     12942: </tr>
                   12943: <tr>
1.328     jnemeth  12944: <td>ONLY_FOR_COMPILER</td>
1.332     rillig   12945: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     12946: </tr>
                   12947: <tr>
1.328     jnemeth  12948: <td>OPENSSH_CHROOT</td>
1.332     rillig   12949: <td>OPENSSH_GROUP</td>
1.269     leot     12950: </tr>
                   12951: <tr>
1.328     jnemeth  12952: <td>OPENSSH_USER</td>
1.332     rillig   12953: <td>OPSYS</td>
1.269     leot     12954: </tr>
                   12955: <tr>
1.328     jnemeth  12956: <td>OPSYS_EMULDIR</td>
1.332     rillig   12957: <td>OPSYS_VERSION</td>
1.269     leot     12958: </tr>
                   12959: <tr>
1.328     jnemeth  12960: <td>OS</td>
1.332     rillig   12961: <td>OSS_TYPE</td>
1.327     wiz      12962: </tr>
                   12963: <tr>
1.328     jnemeth  12964: <td>OSX</td>
1.332     rillig   12965: <td>OSX_TOLERATE_SDK_SKEW</td>
                   12966: </tr>
                   12967: <tr>
                   12968: <td>OS_HAVE_ALSA</td>
                   12969: <td>OS_HAVE_RCD</td>
1.329     leot     12970: </tr>
                   12971: <tr>
1.331     gutterid 12972: <td>OS_VARIANT</td>
1.332     rillig   12973: <td>OS_VERSION</td>
1.269     leot     12974: </tr>
                   12975: <tr>
1.331     gutterid 12976: <td>OTF_FONTS_DIR</td>
1.332     rillig   12977: <td>OVERRIDE_DIRDEPTH</td>
1.327     wiz      12978: </tr>
                   12979: <tr>
1.331     gutterid 12980: <td>OVERRIDE_GEMSPEC</td>
1.332     rillig   12981: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.320     wiz      12982: </tr>
                   12983: <tr>
1.332     rillig   12984: <td>OVERRIDE_ROCKSPEC</td>
1.313     leot     12985: <td>OWN_DIRS</td>
1.269     leot     12986: </tr>
                   12987: <tr>
1.324     nia      12988: <td>OWN_DIRS_PERMS</td>
1.313     leot     12989: <td>P4GROUP</td>
1.269     leot     12990: </tr>
                   12991: <tr>
1.324     nia      12992: <td>P4PORT</td>
1.313     leot     12993: <td>P4ROOT</td>
1.269     leot     12994: </tr>
                   12995: <tr>
1.324     nia      12996: <td>P4USER</td>
1.313     leot     12997: <td>PACKAGES</td>
1.269     leot     12998: </tr>
                   12999: <tr>
1.324     nia      13000: <td>PALMOS_DEFAULT_SDK</td>
1.313     leot     13001: <td>PAMBASE</td>
1.269     leot     13002: </tr>
                   13003: <tr>
1.324     nia      13004: <td>PAM_DEFAULT</td>
1.313     leot     13005: <td>PAPERSIZE</td>
1.269     leot     13006: </tr>
                   13007: <tr>
1.324     nia      13008: <td>PASSIVE_FETCH</td>
1.313     leot     13009: <td>PATCHDIR</td>
1.324     nia      13010: </tr>
                   13011: <tr>
1.322     leot     13012: <td>PATCHFILES</td>
1.324     nia      13013: <td>PATCH_ARGS</td>
1.269     leot     13014: </tr>
                   13015: <tr>
1.322     leot     13016: <td>PATCH_DEBUG</td>
1.324     nia      13017: <td>PATCH_DIST_ARGS</td>
1.269     leot     13018: </tr>
                   13019: <tr>
1.322     leot     13020: <td>PATCH_DIST_CAT</td>
1.324     nia      13021: <td>PATCH_DIST_STRIP</td>
1.284     rillig   13022: </tr>
                   13023: <tr>
1.322     leot     13024: <td>PATCH_FUZZ_FACTOR</td>
1.324     nia      13025: <td>PATCH_STRIP</td>
1.269     leot     13026: </tr>
                   13027: <tr>
1.322     leot     13028: <td>PATH</td>
1.324     nia      13029: <td>PCCBASE</td>
1.316     cirnatda 13030: </tr>
                   13031: <tr>
1.332     rillig   13032: <td>PEAR</td>
                   13033: <td>PEAR_CHANNEL</td>
                   13034: </tr>
                   13035: <tr>
                   13036: <td>PEAR_CHANNEL_ALIAS</td>
                   13037: <td>PEAR_CHANNEL_VERSION</td>
                   13038: </tr>
                   13039: <tr>
1.322     leot     13040: <td>PEAR_CMD</td>
1.324     nia      13041: <td>PEAR_LIB</td>
1.320     wiz      13042: </tr>
                   13043: <tr>
1.322     leot     13044: <td>PEAR_PACKAGE_XML</td>
1.324     nia      13045: <td>PERL5</td>
1.292     leot     13046: </tr>
                   13047: <tr>
1.322     leot     13048: <td>PERL5_CONFIGURE</td>
1.324     nia      13049: <td>PERL5_CONFIGURE_DIRS</td>
1.274     rillig   13050: </tr>
                   13051: <tr>
1.322     leot     13052: <td>PERL5_LDFLAGS</td>
1.324     nia      13053: <td>PERL5_LICENSE</td>
1.274     rillig   13054: </tr>
                   13055: <tr>
1.322     leot     13056: <td>PERL5_MODULE_TYPE</td>
1.324     nia      13057: <td>PERL5_PACKLIST</td>
1.269     leot     13058: </tr>
                   13059: <tr>
1.322     leot     13060: <td>PERL5_PACKLIST_DIR</td>
1.324     nia      13061: <td>PERL5_PERLBASE</td>
1.269     leot     13062: </tr>
                   13063: <tr>
1.322     leot     13064: <td>PERL5_SITEBASE</td>
1.324     nia      13065: <td>PERL5_USE_PACKLIST</td>
1.269     leot     13066: </tr>
                   13067: <tr>
1.322     leot     13068: <td>PERL5_VENDORBASE</td>
1.324     nia      13069: <td>PFCTL</td>
1.269     leot     13070: </tr>
                   13071: <tr>
1.322     leot     13072: <td>PFVAR_H</td>
1.324     nia      13073: <td>PF_VERSION</td>
1.269     leot     13074: </tr>
                   13075: <tr>
1.322     leot     13076: <td>PGGROUP</td>
1.324     nia      13077: <td>PGHOME</td>
1.269     leot     13078: </tr>
                   13079: <tr>
1.322     leot     13080: <td>PGPKGSRCDIR</td>
1.324     nia      13081: <td>PGSQL_TYPE</td>
1.269     leot     13082: </tr>
                   13083: <tr>
1.322     leot     13084: <td>PGSQL_VERSION</td>
1.324     nia      13085: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     13086: </tr>
                   13087: <tr>
1.322     leot     13088: <td>PGSQL_VERSION_DEFAULT</td>
1.324     nia      13089: <td>PGUSER</td>
1.269     leot     13090: </tr>
                   13091: <tr>
1.322     leot     13092: <td>PG_LIB_EXT</td>
1.324     nia      13093: <td>PHP</td>
1.269     leot     13094: </tr>
                   13095: <tr>
1.322     leot     13096: <td>PHPCOMMON_MK</td>
1.324     nia      13097: <td>PHPPKGSRCDIR</td>
1.269     leot     13098: </tr>
                   13099: <tr>
1.322     leot     13100: <td>PHP_BASE_VERS</td>
1.324     nia      13101: <td>PHP_CHECK_INSTALLED</td>
1.269     leot     13102: </tr>
                   13103: <tr>
1.322     leot     13104: <td>PHP_EXTENSION_DIR</td>
1.324     nia      13105: <td>PHP_INITIAL_TEENY</td>
1.269     leot     13106: </tr>
                   13107: <tr>
1.322     leot     13108: <td>PHP_PKG_PREFIX</td>
1.324     nia      13109: <td>PHP_VERSION</td>
1.269     leot     13110: </tr>
                   13111: <tr>
1.322     leot     13112: <td>PHP_VERSIONS_ACCEPTED</td>
1.324     nia      13113: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13114: </tr>
                   13115: <tr>
1.322     leot     13116: <td>PHP_VERSION_DEFAULT</td>
1.324     nia      13117: <td>PHP_VERSION_REQD</td>
1.269     leot     13118: </tr>
                   13119: <tr>
1.322     leot     13120: <td>PILRC_USE_GTK</td>
1.324     nia      13121: <td>PKGCONFIG_BASE</td>
1.269     leot     13122: </tr>
                   13123: <tr>
1.322     leot     13124: <td>PKGCONFIG_FILE</td>
1.324     nia      13125: <td>PKGCONFIG_OVERRIDE</td>
1.269     leot     13126: </tr>
                   13127: <tr>
1.322     leot     13128: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.324     nia      13129: <td>PKGDIR</td>
1.269     leot     13130: </tr>
                   13131: <tr>
1.322     leot     13132: <td>PKGGNUDIR</td>
1.324     nia      13133: <td>PKGINFODIR</td>
1.269     leot     13134: </tr>
                   13135: <tr>
1.322     leot     13136: <td>PKGLOCALEDIR</td>
1.324     nia      13137: <td>PKGMANDIR</td>
1.269     leot     13138: </tr>
                   13139: <tr>
1.322     leot     13140: <td>PKGNAME</td>
1.324     nia      13141: <td>PKGNAME_REQD</td>
1.269     leot     13142: </tr>
                   13143: <tr>
1.322     leot     13144: <td>PKGPATH</td>
1.324     nia      13145: <td>PKGREVISION</td>
1.269     leot     13146: </tr>
                   13147: <tr>
1.322     leot     13148: <td>PKGSRC_BLAS_TYPES</td>
1.324     nia      13149: <td>PKGSRC_CHANGES</td>
1.269     leot     13150: </tr>
                   13151: <tr>
1.322     leot     13152: <td>PKGSRC_COMPILER</td>
1.324     nia      13153: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.292     leot     13154: </tr>
                   13155: <tr>
1.322     leot     13156: <td>PKGSRC_LOCKTYPE</td>
1.324     nia      13157: <td>PKGSRC_MAKE_ENV</td>
1.269     leot     13158: </tr>
                   13159: <tr>
1.322     leot     13160: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.324     nia      13161: <td>PKGSRC_MKPIE</td>
1.274     rillig   13162: </tr>
                   13163: <tr>
1.322     leot     13164: <td>PKGSRC_MKREPRO</td>
1.331     gutterid 13165: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.269     leot     13166: </tr>
                   13167: <tr>
1.331     gutterid 13168: <td>PKGSRC_RUN_TEST</td>
1.322     leot     13169: <td>PKGSRC_SETENV</td>
1.269     leot     13170: </tr>
                   13171: <tr>
1.331     gutterid 13172: <td>PKGSRC_SLEEPSECS</td>
1.322     leot     13173: <td>PKGSRC_TODO</td>
1.269     leot     13174: </tr>
                   13175: <tr>
1.331     gutterid 13176: <td>PKGSRC_USE_CTF</td>
1.322     leot     13177: <td>PKGSRC_USE_FORTIFY</td>
1.269     leot     13178: </tr>
                   13179: <tr>
1.331     gutterid 13180: <td>PKGSRC_USE_RELRO</td>
1.322     leot     13181: <td>PKGSRC_USE_SSP</td>
1.269     leot     13182: </tr>
                   13183: <tr>
1.331     gutterid 13184: <td>PKGSRC_USE_STACK_CHECK</td>
1.322     leot     13185: <td>PKGTASKS_DATAFILE</td>
1.269     leot     13186: </tr>
                   13187: <tr>
1.331     gutterid 13188: <td>PKGTOOLS_ARGS</td>
1.322     leot     13189: <td>PKGTOOLS_ENV</td>
1.269     leot     13190: </tr>
                   13191: <tr>
1.331     gutterid 13192: <td>PKG_ALTERNATIVES</td>
1.322     leot     13193: <td>PKG_APACHE</td>
1.269     leot     13194: </tr>
                   13195: <tr>
1.331     gutterid 13196: <td>PKG_APACHE_ACCEPTED</td>
1.322     leot     13197: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     13198: </tr>
                   13199: <tr>
1.331     gutterid 13200: <td>PKG_BEST_EXISTS</td>
1.322     leot     13201: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     13202: </tr>
                   13203: <tr>
1.331     gutterid 13204: <td>PKG_COMPRESSION</td>
1.322     leot     13205: <td>PKG_CONFIG</td>
1.269     leot     13206: </tr>
                   13207: <tr>
1.331     gutterid 13208: <td>PKG_CONFIG_PERMS</td>
1.322     leot     13209: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     13210: </tr>
                   13211: <tr>
1.331     gutterid 13212: <td>PKG_DB_TMPDIR</td>
1.322     leot     13213: <td>PKG_DEBUG_LEVEL</td>
1.269     leot     13214: </tr>
                   13215: <tr>
1.331     gutterid 13216: <td>PKG_DEFAULT_OPTIONS</td>
1.322     leot     13217: <td>PKG_DESTDIR_SUPPORT</td>
1.269     leot     13218: </tr>
                   13219: <tr>
1.331     gutterid 13220: <td>PKG_DEVELOPER</td>
1.322     leot     13221: <td>PKG_DISABLED_OPTIONS</td>
1.269     leot     13222: </tr>
                   13223: <tr>
1.331     gutterid 13224: <td>PKG_FATAL_ERRORS</td>
1.322     leot     13225: <td>PKG_FC</td>
1.269     leot     13226: </tr>
                   13227: <tr>
1.331     gutterid 13228: <td>PKG_FILELIST_CMD</td>
1.322     leot     13229: <td>PKG_GECOS</td>
1.269     leot     13230: </tr>
                   13231: <tr>
1.331     gutterid 13232: <td>PKG_GID</td>
1.322     leot     13233: <td>PKG_GROUPS</td>
1.269     leot     13234: </tr>
                   13235: <tr>
1.331     gutterid 13236: <td>PKG_GROUPS_VARS</td>
1.322     leot     13237: <td>PKG_HOME</td>
1.269     leot     13238: </tr>
                   13239: <tr>
1.331     gutterid 13240: <td>PKG_INIT_SCRIPTS</td>
1.322     leot     13241: <td>PKG_JAVA_HOME</td>
1.269     leot     13242: </tr>
                   13243: <tr>
1.331     gutterid 13244: <td>PKG_JVM</td>
1.322     leot     13245: <td>PKG_JVMS_ACCEPTED</td>
1.269     leot     13246: </tr>
                   13247: <tr>
1.331     gutterid 13248: <td>PKG_JVM_DEFAULT</td>
1.322     leot     13249: <td>PKG_LEGACY_OPTIONS</td>
1.269     leot     13250: </tr>
                   13251: <tr>
1.331     gutterid 13252: <td>PKG_LIBTOOL</td>
1.322     leot     13253: <td>PKG_OPTIONS</td>
1.269     leot     13254: </tr>
                   13255: <tr>
1.331     gutterid 13256: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.322     leot     13257: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     13258: </tr>
                   13259: <tr>
1.331     gutterid 13260: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.322     leot     13261: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     13262: </tr>
                   13263: <tr>
1.331     gutterid 13264: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.322     leot     13265: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     13266: </tr>
                   13267: <tr>
1.331     gutterid 13268: <td>PKG_OPTIONS_VAR</td>
1.322     leot     13269: <td>PKG_PHP</td>
1.269     leot     13270: </tr>
                   13271: <tr>
1.331     gutterid 13272: <td>PKG_PHP_MAJOR_VERS</td>
1.322     leot     13273: <td>PKG_PHP_VERSION</td>
1.269     leot     13274: </tr>
                   13275: <tr>
1.331     gutterid 13276: <td>PKG_RCD_SCRIPTS</td>
1.322     leot     13277: <td>PKG_REFCOUNT_DBDIR</td>
1.269     leot     13278: </tr>
                   13279: <tr>
1.331     gutterid 13280: <td>PKG_REGISTER_SHELLS</td>
1.322     leot     13281: <td>PKG_RESUME_TRANSFERS</td>
1.269     leot     13282: </tr>
                   13283: <tr>
1.331     gutterid 13284: <td>PKG_SHELL</td>
1.322     leot     13285: <td>PKG_SUGGESTED_OPTIONS</td>
1.269     leot     13286: </tr>
                   13287: <tr>
1.331     gutterid 13288: <td>PKG_SUPPORTED_OPTIONS</td>
1.322     leot     13289: <td>PKG_SYSCONFBASE</td>
1.269     leot     13290: </tr>
                   13291: <tr>
1.331     gutterid 13292: <td>PKG_SYSCONFBASEDIR</td>
1.322     leot     13293: <td>PKG_SYSCONFDIR</td>
1.269     leot     13294: </tr>
                   13295: <tr>
1.331     gutterid 13296: <td>PKG_SYSCONFDIR_PERMS</td>
1.322     leot     13297: <td>PKG_SYSCONFSUBDIR</td>
1.269     leot     13298: </tr>
                   13299: <tr>
1.331     gutterid 13300: <td>PKG_SYSCONFVAR</td>
1.322     leot     13301: <td>PKG_TOOLS_BIN</td>
1.269     leot     13302: </tr>
                   13303: <tr>
1.331     gutterid 13304: <td>PKG_UID</td>
1.322     leot     13305: <td>PKG_UPDATE_FONTS_DB</td>
1.269     leot     13306: </tr>
                   13307: <tr>
1.331     gutterid 13308: <td>PKG_USERS</td>
1.322     leot     13309: <td>PKG_USERS_VARS</td>
1.269     leot     13310: </tr>
                   13311: <tr>
1.331     gutterid 13312: <td>PKG_VERBOSE</td>
1.322     leot     13313: <td>PLEASE</td>
1.269     leot     13314: </tr>
                   13315: <tr>
1.331     gutterid 13316: <td>PLIST</td>
1.322     leot     13317: <td>PLIST_AWK</td>
1.269     leot     13318: </tr>
                   13319: <tr>
1.331     gutterid 13320: <td>PLIST_AWK_ENV</td>
1.322     leot     13321: <td>PLIST_SRC</td>
1.269     leot     13322: </tr>
                   13323: <tr>
1.331     gutterid 13324: <td>PLIST_SUBST</td>
1.322     leot     13325: <td>PLIST_TYPE</td>
1.269     leot     13326: </tr>
                   13327: <tr>
1.331     gutterid 13328: <td>PLIST_VARS</td>
1.322     leot     13329: <td>POPTOP_USE_MPPE</td>
1.269     leot     13330: </tr>
                   13331: <tr>
1.331     gutterid 13332: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.322     leot     13333: <td>POST_FETCH_HOOK</td>
1.269     leot     13334: </tr>
                   13335: <tr>
1.331     gutterid 13336: <td>PREFER</td>
1.322     leot     13337: <td>PREFER_NATIVE</td>
1.269     leot     13338: </tr>
                   13339: <tr>
1.331     gutterid 13340: <td>PREFER_NATIVE_PTHREADS</td>
1.322     leot     13341: <td>PREFER_PKGSRC</td>
1.269     leot     13342: </tr>
                   13343: <tr>
1.331     gutterid 13344: <td>PREFIX</td>
1.322     leot     13345: <td>PREPEND_PATH</td>
1.269     leot     13346: </tr>
                   13347: <tr>
1.331     gutterid 13348: <td>PRE_ROOT_CMD</td>
1.322     leot     13349: <td>PRIVILEGED_STAGES</td>
1.269     leot     13350: </tr>
                   13351: <tr>
1.331     gutterid 13352: <td>PS</td>
1.322     leot     13353: <td>PTHREAD_AUTO_VARS</td>
1.269     leot     13354: </tr>
                   13355: <tr>
1.331     gutterid 13356: <td>PTHREAD_CFLAGS</td>
1.322     leot     13357: <td>PTHREAD_LDFLAGS</td>
1.269     leot     13358: </tr>
                   13359: <tr>
1.331     gutterid 13360: <td>PTHREAD_LIBS</td>
1.322     leot     13361: <td>PTHREAD_OPTS</td>
1.269     leot     13362: </tr>
                   13363: <tr>
1.331     gutterid 13364: <td>PTHREAD_TYPE</td>
1.322     leot     13365: <td>PVM_SSH</td>
1.269     leot     13366: </tr>
                   13367: <tr>
1.331     gutterid 13368: <td>PYPKGPREFIX</td>
1.322     leot     13369: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269     leot     13370: </tr>
                   13371: <tr>
1.331     gutterid 13372: <td>PYTHON_SELF_CONFLICT</td>
1.322     leot     13373: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269     leot     13374: </tr>
                   13375: <tr>
1.331     gutterid 13376: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.322     leot     13377: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13378: </tr>
                   13379: <tr>
1.331     gutterid 13380: <td>PYTHON_VERSION_DEFAULT</td>
1.322     leot     13381: <td>PYTHON_VERSION_REQD</td>
1.269     leot     13382: </tr>
                   13383: <tr>
1.331     gutterid 13384: <td>PYVERSSUFFIX</td>
1.324     nia      13385: <td>QMAILDIR</td>
1.269     leot     13386: </tr>
                   13387: <tr>
1.322     leot     13388: <td>QMAIL_ALIAS_USER</td>
1.324     nia      13389: <td>QMAIL_DAEMON_USER</td>
1.269     leot     13390: </tr>
                   13391: <tr>
1.322     leot     13392: <td>QMAIL_LOG_USER</td>
1.324     nia      13393: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     13394: </tr>
                   13395: <tr>
1.322     leot     13396: <td>QMAIL_PASSWD_USER</td>
1.324     nia      13397: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     13398: </tr>
                   13399: <tr>
1.322     leot     13400: <td>QMAIL_QUEUE_DIR</td>
1.324     nia      13401: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     13402: </tr>
                   13403: <tr>
1.322     leot     13404: <td>QMAIL_QUEUE_USER</td>
1.324     nia      13405: <td>QMAIL_REMOTE_USER</td>
1.269     leot     13406: </tr>
                   13407: <tr>
1.322     leot     13408: <td>QMAIL_ROOT_USER</td>
1.324     nia      13409: <td>QMAIL_SEND_USER</td>
1.269     leot     13410: </tr>
                   13411: <tr>
1.333     nia      13412: <td>QORE_LATEST_MODULE_API</td>
                   13413: <td>QORE_MODULE_API</td>
                   13414: </tr>
                   13415: <tr>
                   13416: <td>QORE_MODULE_DIR</td>
                   13417: <td>QORE_USER_MODULE_DIR</td>
                   13418: </tr>
                   13419: <tr>
                   13420: <td>QORE_VERSION</td>
1.322     leot     13421: <td>QPOPPER_FAC</td>
1.333     nia      13422: </tr>
                   13423: <tr>
1.332     rillig   13424: <td>QPOPPER_SPOOL_DIR</td>
1.333     nia      13425: <td>QPOPPER_USER</td>
1.269     leot     13426: </tr>
                   13427: <tr>
1.332     rillig   13428: <td>RAKE_NAME</td>
1.333     nia      13429: <td>RASMOL_DEPTH</td>
1.269     leot     13430: </tr>
                   13431: <tr>
1.332     rillig   13432: <td>RCD_DIR</td>
1.333     nia      13433: <td>RCD_ORDER</td>
1.329     leot     13434: </tr>
                   13435: <tr>
1.324     nia      13436: <td>RCD_SCRIPTS</td>
1.333     nia      13437: <td>RCD_SCRIPTS_DIR</td>
1.332     rillig   13438: </tr>
                   13439: <tr>
                   13440: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.333     nia      13441: <td>RCD_SCRIPTS_MODE</td>
1.320     wiz      13442: </tr>
                   13443: <tr>
1.332     rillig   13444: <td>RCD_SCRIPTS_SHELL</td>
1.333     nia      13445: <td>RCD_SCRIPT_SRC</td>
1.292     leot     13446: </tr>
                   13447: <tr>
1.332     rillig   13448: <td>RCD_SUBR</td>
1.333     nia      13449: <td>RDOC</td>
1.329     leot     13450: </tr>
                   13451: <tr>
                   13452: <td>READLINE_DEFAULT</td>
1.333     nia      13453: <td>READLINE_TYPE</td>
1.327     wiz      13454: </tr>
                   13455: <tr>
1.329     leot     13456: <td>REAL_ROOT_GROUP</td>
1.333     nia      13457: <td>REAL_ROOT_USER</td>
1.269     leot     13458: </tr>
                   13459: <tr>
1.329     leot     13460: <td>RECURSIVE_MAKE</td>
1.333     nia      13461: <td>RELAY_CTRL_DIR</td>
1.320     wiz      13462: </tr>
                   13463: <tr>
1.329     leot     13464: <td>RELRO_SUPPORTED</td>
1.333     nia      13465: <td>REPLACE_AWK</td>
1.311     leot     13466: </tr>
                   13467: <tr>
1.329     leot     13468: <td>REPLACE_BASH</td>
1.333     nia      13469: <td>REPLACE_CSH</td>
1.269     leot     13470: </tr>
                   13471: <tr>
1.329     leot     13472: <td>REPLACE_KSH</td>
1.333     nia      13473: <td>REPLACE_LUA</td>
                   13474: </tr>
                   13475: <tr>
                   13476: <td>REPLACE_NODEJS</td>
                   13477: <td>REPLACE_OCTAVE</td>
1.269     leot     13478: </tr>
                   13479: <tr>
1.328     jnemeth  13480: <td>REPLACE_PERL</td>
1.332     rillig   13481: <td>REPLACE_PERL6</td>
1.331     gutterid 13482: </tr>
                   13483: <tr>
                   13484: <td>REPLACE_PHP</td>
1.329     leot     13485: <td>REPLACE_PYTHON</td>
1.269     leot     13486: </tr>
                   13487: <tr>
1.333     nia      13488: <td>REPLACE_QORE</td>
1.328     jnemeth  13489: <td>REPLACE_R</td>
1.333     nia      13490: </tr>
                   13491: <tr>
1.329     leot     13492: <td>REPLACE_RUBY</td>
1.333     nia      13493: <td>REPLACE_RUBY_DIRS</td>
1.269     leot     13494: </tr>
                   13495: <tr>
1.329     leot     13496: <td>REPLACE_RUBY_PAT</td>
1.333     nia      13497: <td>REPLACE_SH</td>
1.269     leot     13498: </tr>
                   13499: <tr>
1.329     leot     13500: <td>REPLACE_TEXLUA</td>
1.333     nia      13501: <td>REPLACE_WISH</td>
1.269     leot     13502: </tr>
                   13503: <tr>
1.328     jnemeth  13504: <td>REQD_DIRS</td>
1.332     rillig   13505: <td>REQD_DIRS_PERMS</td>
1.269     leot     13506: </tr>
                   13507: <tr>
1.328     jnemeth  13508: <td>REQD_FILES</td>
1.332     rillig   13509: <td>REQD_FILES_MODE</td>
1.281     leot     13510: </tr>
                   13511: <tr>
1.328     jnemeth  13512: <td>REQD_FILES_PERMS</td>
1.332     rillig   13513: <td>RESOLV_AUTO_VARS</td>
1.269     leot     13514: </tr>
                   13515: <tr>
1.328     jnemeth  13516: <td>RESOLV_LDFLAGS</td>
1.332     rillig   13517: <td>RESOLV_LIBS</td>
1.269     leot     13518: </tr>
                   13519: <tr>
1.320     wiz      13520: <td>RM</td>
1.332     rillig   13521: <td>ROCKSPEC_NAME</td>
1.320     wiz      13522: </tr>
                   13523: <tr>
1.332     rillig   13524: <td>ROCKSPEC_SPECFILE</td>
1.324     nia      13525: <td>ROOT_CMD</td>
1.332     rillig   13526: </tr>
                   13527: <tr>
1.331     gutterid 13528: <td>ROOT_GROUP</td>
1.332     rillig   13529: <td>ROOT_USER</td>
1.329     leot     13530: </tr>
                   13531: <tr>
1.331     gutterid 13532: <td>RPCGEN</td>
1.332     rillig   13533: <td>RPM</td>
1.327     wiz      13534: </tr>
                   13535: <tr>
1.331     gutterid 13536: <td>RPM2PKG_PLIST</td>
1.332     rillig   13537: <td>RPM2PKG_PREFIX</td>
1.269     leot     13538: </tr>
                   13539: <tr>
1.331     gutterid 13540: <td>RPM2PKG_STAGE</td>
1.332     rillig   13541: <td>RPM2PKG_STRIP</td>
1.311     leot     13542: </tr>
                   13543: <tr>
1.331     gutterid 13544: <td>RPM2PKG_SUBPREFIX</td>
1.332     rillig   13545: <td>RPMFILES</td>
1.269     leot     13546: </tr>
                   13547: <tr>
1.331     gutterid 13548: <td>RPMIGNOREPATH</td>
1.332     rillig   13549: <td>RPM_DB_PREFIX</td>
1.269     leot     13550: </tr>
                   13551: <tr>
1.331     gutterid 13552: <td>RSSH_CVS_PATH</td>
1.332     rillig   13553: <td>RSSH_RDIST_PATH</td>
1.269     leot     13554: </tr>
                   13555: <tr>
1.331     gutterid 13556: <td>RSSH_RSYNC_PATH</td>
1.332     rillig   13557: <td>RSSH_SCP_PATH</td>
1.269     leot     13558: </tr>
                   13559: <tr>
1.331     gutterid 13560: <td>RSSH_SFTP_SERVER_PATH</td>
1.332     rillig   13561: <td>RUBY</td>
1.269     leot     13562: </tr>
                   13563: <tr>
1.331     gutterid 13564: <td>RUBYGEM</td>
1.332     rillig   13565: <td>RUBYGEM_NAME</td>
1.269     leot     13566: </tr>
                   13567: <tr>
1.331     gutterid 13568: <td>RUBYGEM_OPTIONS</td>
1.332     rillig   13569: <td>RUBYGEM_VERBOSE</td>
1.269     leot     13570: </tr>
                   13571: <tr>
1.331     gutterid 13572: <td>RUBY_ABI_VERSION</td>
1.332     rillig   13573: <td>RUBY_ARCH</td>
1.269     leot     13574: </tr>
                   13575: <tr>
1.331     gutterid 13576: <td>RUBY_ARCHINC</td>
1.332     rillig   13577: <td>RUBY_ARCHLIB</td>
1.269     leot     13578: </tr>
                   13579: <tr>
1.331     gutterid 13580: <td>RUBY_BASE</td>
1.332     rillig   13581: <td>RUBY_BASERIDIR</td>
1.269     leot     13582: </tr>
                   13583: <tr>
1.331     gutterid 13584: <td>RUBY_BUILD_DOCUMENT</td>
1.332     rillig   13585: <td>RUBY_DLEXT</td>
1.269     leot     13586: </tr>
                   13587: <tr>
1.331     gutterid 13588: <td>RUBY_DOC</td>
1.332     rillig   13589: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     13590: </tr>
                   13591: <tr>
1.331     gutterid 13592: <td>RUBY_EG</td>
1.332     rillig   13593: <td>RUBY_ENCODING_ARG</td>
1.269     leot     13594: </tr>
                   13595: <tr>
1.331     gutterid 13596: <td>RUBY_EXTCONF</td>
1.332     rillig   13597: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     13598: </tr>
                   13599: <tr>
1.331     gutterid 13600: <td>RUBY_EXTCONF_DEBUG</td>
1.332     rillig   13601: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     13602: </tr>
                   13603: <tr>
1.331     gutterid 13604: <td>RUBY_GEM_ARCH</td>
1.332     rillig   13605: <td>RUBY_GEM_BASE</td>
1.269     leot     13606: </tr>
                   13607: <tr>
1.329     leot     13608: <td>RUBY_INC</td>
1.332     rillig   13609: <td>RUBY_LIB</td>
1.269     leot     13610: </tr>
                   13611: <tr>
1.329     leot     13612: <td>RUBY_LIB_BASE</td>
1.332     rillig   13613: <td>RUBY_NAME</td>
1.269     leot     13614: </tr>
                   13615: <tr>
1.329     leot     13616: <td>RUBY_NOVERSION</td>
1.332     rillig   13617: <td>RUBY_PKGPREFIX</td>
1.269     leot     13618: </tr>
                   13619: <tr>
1.329     leot     13620: <td>RUBY_RAILS</td>
1.332     rillig   13621: <td>RUBY_RAILS52_VERSION</td>
1.269     leot     13622: </tr>
                   13623: <tr>
1.329     leot     13624: <td>RUBY_RAILS60_VERSION</td>
1.332     rillig   13625: <td>RUBY_RAILS61_VERSION</td>
1.269     leot     13626: </tr>
                   13627: <tr>
1.329     leot     13628: <td>RUBY_RAILS70_VERSION</td>
1.332     rillig   13629: <td>RUBY_RAILS_ACCEPTED</td>
1.269     leot     13630: </tr>
                   13631: <tr>
1.329     leot     13632: <td>RUBY_RAILS_DEFAULT</td>
1.332     rillig   13633: <td>RUBY_RAILS_REQD</td>
1.269     leot     13634: </tr>
                   13635: <tr>
1.329     leot     13636: <td>RUBY_RAILS_STRICT_DEP</td>
1.332     rillig   13637: <td>RUBY_RIDIR</td>
1.312     gdt      13638: </tr>
                   13639: <tr>
1.329     leot     13640: <td>RUBY_SETUP</td>
1.332     rillig   13641: <td>RUBY_SHLIB</td>
1.289     leot     13642: </tr>
                   13643: <tr>
1.329     leot     13644: <td>RUBY_SHLIBALIAS</td>
1.332     rillig   13645: <td>RUBY_SHLIBVER</td>
1.269     leot     13646: </tr>
                   13647: <tr>
1.329     leot     13648: <td>RUBY_SIMPLE_INSTALL</td>
1.332     rillig   13649: <td>RUBY_SITEARCHLIB</td>
1.269     leot     13650: </tr>
                   13651: <tr>
1.329     leot     13652: <td>RUBY_SITELIB</td>
1.332     rillig   13653: <td>RUBY_SITELIB_BASE</td>
1.269     leot     13654: </tr>
                   13655: <tr>
1.329     leot     13656: <td>RUBY_SITERIDIR</td>
1.332     rillig   13657: <td>RUBY_SLEXT</td>
1.269     leot     13658: </tr>
                   13659: <tr>
1.329     leot     13660: <td>RUBY_SRCDIR</td>
1.332     rillig   13661: <td>RUBY_STATICLIB</td>
1.269     leot     13662: </tr>
                   13663: <tr>
1.329     leot     13664: <td>RUBY_SUFFIX</td>
1.332     rillig   13665: <td>RUBY_SYSRIDIR</td>
1.269     leot     13666: </tr>
                   13667: <tr>
1.329     leot     13668: <td>RUBY_USE_PTHREAD</td>
1.332     rillig   13669: <td>RUBY_VENDORARCHLIB</td>
1.269     leot     13670: </tr>
                   13671: <tr>
1.329     leot     13672: <td>RUBY_VENDORLIB</td>
1.332     rillig   13673: <td>RUBY_VENDORLIB_BASE</td>
1.269     leot     13674: </tr>
                   13675: <tr>
1.329     leot     13676: <td>RUBY_VER</td>
1.332     rillig   13677: <td>RUBY_VERSION</td>
1.269     leot     13678: </tr>
                   13679: <tr>
1.329     leot     13680: <td>RUBY_VERSIONS_ACCEPTED</td>
1.332     rillig   13681: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13682: </tr>
                   13683: <tr>
1.329     leot     13684: <td>RUBY_VERSION_DEFAULT</td>
1.332     rillig   13685: <td>RUBY_VERSION_REQD</td>
1.269     leot     13686: </tr>
                   13687: <tr>
1.329     leot     13688: <td>RUBY_VER_DIR</td>
1.332     rillig   13689: <td>RUN</td>
1.269     leot     13690: </tr>
                   13691: <tr>
1.329     leot     13692: <td>RUN_LDCONFIG</td>
1.333     nia      13693: <td>SCO</td>
1.269     leot     13694: </tr>
                   13695: <tr>
1.331     gutterid 13696: <td>SCREWS_GROUP</td>
1.333     nia      13697: <td>SCREWS_USER</td>
1.269     leot     13698: </tr>
                   13699: <tr>
1.331     gutterid 13700: <td>SCRIPTS_ENV</td>
1.333     nia      13701: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     13702: </tr>
                   13703: <tr>
1.331     gutterid 13704: <td>SCROLLKEEPER_REBUILDDB</td>
1.333     nia      13705: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     13706: </tr>
                   13707: <tr>
1.331     gutterid 13708: <td>SDIST_PAWD</td>
1.333     nia      13709: <td>SERIAL_DEVICES</td>
1.269     leot     13710: </tr>
                   13711: <tr>
1.331     gutterid 13712: <td>SETGIDGAME</td>
1.333     nia      13713: <td>SETGID_GAMES_PERMS</td>
1.269     leot     13714: </tr>
                   13715: <tr>
1.331     gutterid 13716: <td>SETUID_ROOT_PERMS</td>
1.333     nia      13717: <td>SH</td>
1.269     leot     13718: </tr>
                   13719: <tr>
1.327     wiz      13720: <td>SHLIB</td>
1.333     nia      13721: <td>SHORTNAME</td>
1.269     leot     13722: </tr>
                   13723: <tr>
1.324     nia      13724: <td>SIGN_PACKAGES</td>
1.333     nia      13725: <td>SILC_CLIENT_WITH_PERL</td>
1.292     leot     13726: </tr>
                   13727: <tr>
1.324     nia      13728: <td>SITE_SPECIFIC_PKGS</td>
1.333     nia      13729: <td>SKIP_DEPENDS</td>
1.269     leot     13730: </tr>
                   13731: <tr>
1.324     nia      13732: <td>SMF_INSTANCES</td>
1.333     nia      13733: <td>SMF_MANIFEST</td>
1.332     rillig   13734: </tr>
                   13735: <tr>
                   13736: <td>SMF_METHODS</td>
1.333     nia      13737: <td>SMF_METHOD_SHELL</td>
1.269     leot     13738: </tr>
                   13739: <tr>
1.332     rillig   13740: <td>SMF_METHOD_SRC</td>
1.333     nia      13741: <td>SMF_NAME</td>
1.274     rillig   13742: </tr>
                   13743: <tr>
1.332     rillig   13744: <td>SMF_PREFIX</td>
1.333     nia      13745: <td>SMF_SRCDIR</td>
1.269     leot     13746: </tr>
                   13747: <tr>
1.332     rillig   13748: <td>SNIPROXY_GROUP</td>
1.333     nia      13749: <td>SNIPROXY_USER</td>
1.269     leot     13750: </tr>
                   13751: <tr>
1.332     rillig   13752: <td>SOURCE_BUFFSIZE</td>
1.333     nia      13753: <td>SPECIAL_PERMS</td>
1.269     leot     13754: </tr>
                   13755: <tr>
1.332     rillig   13756: <td>SPECIFIC_PKGS</td>
1.333     nia      13757: <td>SSH_SUID</td>
1.269     leot     13758: </tr>
                   13759: <tr>
1.332     rillig   13760: <td>SSP_SUPPORTED</td>
1.333     nia      13761: <td>SSYNC_PAWD</td>
1.269     leot     13762: </tr>
                   13763: <tr>
1.332     rillig   13764: <td>STEP_MSG</td>
1.333     nia      13765: <td>STRIP</td>
1.269     leot     13766: </tr>
                   13767: <tr>
1.332     rillig   13768: <td>STRIP_DBG</td>
1.333     nia      13769: <td>STRIP_DEBUG</td>
1.269     leot     13770: </tr>
                   13771: <tr>
1.332     rillig   13772: <td>STRIP_DEBUG_SUPPORTED</td>
1.333     nia      13773: <td>STRIP_FILES_SKIP</td>
1.269     leot     13774: </tr>
                   13775: <tr>
1.332     rillig   13776: <td>SU</td>
1.333     nia      13777: <td>SUBDIR</td>
1.269     leot     13778: </tr>
                   13779: <tr>
1.332     rillig   13780: <td>SUBST</td>
1.333     nia      13781: <td>SUBST_CLASSES</td>
1.269     leot     13782: </tr>
                   13783: <tr>
1.332     rillig   13784: <td>SUBST_FILES</td>
1.333     nia      13785: <td>SUBST_FILTER_CMD</td>
1.269     leot     13786: </tr>
                   13787: <tr>
1.332     rillig   13788: <td>SUBST_MESSAGE</td>
1.333     nia      13789: <td>SUBST_NOOP_OK</td>
1.289     leot     13790: </tr>
                   13791: <tr>
1.332     rillig   13792: <td>SUBST_SED</td>
1.333     nia      13793: <td>SUBST_SHOW_DIFF</td>
1.269     leot     13794: </tr>
                   13795: <tr>
1.332     rillig   13796: <td>SUBST_SKIP_TEXT_CHECK</td>
1.333     nia      13797: <td>SUBST_STAGE</td>
1.269     leot     13798: </tr>
                   13799: <tr>
1.332     rillig   13800: <td>SUBST_VARS</td>
1.333     nia      13801: <td>SUNWSPROBASE</td>
1.269     leot     13802: </tr>
                   13803: <tr>
1.332     rillig   13804: <td>SUSE_PREFER</td>
1.333     nia      13805: <td>SU_CMD</td>
1.269     leot     13806: </tr>
                   13807: <tr>
1.332     rillig   13808: <td>SVN_EXTRACTDIR</td>
1.333     nia      13809: <td>SVN_REPO</td>
1.332     rillig   13810: </tr>
                   13811: <tr>
                   13812: <td>SVN_REPOSITORIES</td>
1.333     nia      13813: <td>SVN_REVISION</td>
1.327     wiz      13814: </tr>
                   13815: <tr>
1.324     nia      13816: <td>SYSCONFBASE</td>
1.333     nia      13817: <td>TBL</td>
1.332     rillig   13818: </tr>
                   13819: <tr>
                   13820: <td>TERMCAP_TYPE</td>
1.333     nia      13821: <td>TERMINFO_DEFAULT</td>
1.320     wiz      13822: </tr>
                   13823: <tr>
1.332     rillig   13824: <td>TERMINFO_TYPE</td>
1.333     nia      13825: <td>TEST</td>
1.303     bacon    13826: </tr>
                   13827: <tr>
1.332     rillig   13828: <td>TEST_DEPENDS</td>
1.333     nia      13829: <td>TEST_DIRS</td>
1.274     rillig   13830: </tr>
                   13831: <tr>
1.332     rillig   13832: <td>TEST_ENV</td>
1.333     nia      13833: <td>TEST_ENV_SHELL</td>
1.269     leot     13834: </tr>
                   13835: <tr>
1.332     rillig   13836: <td>TEST_MAKE_CMD</td>
1.333     nia      13837: <td>TEST_MAKE_FLAGS</td>
1.269     leot     13838: </tr>
                   13839: <tr>
1.332     rillig   13840: <td>TEST_TARGET</td>
1.333     nia      13841: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     13842: </tr>
                   13843: <tr>
1.332     rillig   13844: <td>TEXLIVE_REV</td>
1.333     nia      13845: <td>TEXLIVE_UNVERSIONED</td>
1.269     leot     13846: </tr>
                   13847: <tr>
1.332     rillig   13848: <td>TEXMFSITE</td>
1.333     nia      13849: <td>TEX_FORMATS</td>
1.269     leot     13850: </tr>
                   13851: <tr>
1.332     rillig   13852: <td>TEX_HYPHEN_DAT</td>
1.333     nia      13853: <td>TEX_HYPHEN_DEF</td>
1.269     leot     13854: </tr>
                   13855: <tr>
1.332     rillig   13856: <td>TEX_TEXMF_DIRS</td>
1.333     nia      13857: <td>THTTPD_LOG_FACILITY</td>
1.269     leot     13858: </tr>
                   13859: <tr>
1.332     rillig   13860: <td>TINYDYN_USER</td>
1.333     nia      13861: <td>TLSWRAPPER_CHROOT</td>
1.269     leot     13862: </tr>
                   13863: <tr>
1.332     rillig   13864: <td>TO</td>
1.333     nia      13865: <td>TOOLS_ALIASES</td>
1.269     leot     13866: </tr>
                   13867: <tr>
1.332     rillig   13868: <td>TOOLS_ALWAYS_WRAP</td>
1.333     nia      13869: <td>TOOLS_ARGS</td>
1.269     leot     13870: </tr>
                   13871: <tr>
1.332     rillig   13872: <td>TOOLS_BROKEN</td>
1.333     nia      13873: <td>TOOLS_CMD</td>
1.269     leot     13874: </tr>
                   13875: <tr>
1.332     rillig   13876: <td>TOOLS_CMDLINE_SED</td>
1.333     nia      13877: <td>TOOLS_CREATE</td>
1.269     leot     13878: </tr>
                   13879: <tr>
1.332     rillig   13880: <td>TOOLS_DIR</td>
1.333     nia      13881: <td>TOOLS_FAIL</td>
1.269     leot     13882: </tr>
                   13883: <tr>
1.332     rillig   13884: <td>TOOLS_GNU_MISSING</td>
1.333     nia      13885: <td>TOOLS_LDCONFIG</td>
1.269     leot     13886: </tr>
                   13887: <tr>
1.332     rillig   13888: <td>TOOLS_NOOP</td>
1.333     nia      13889: <td>TOOLS_PATH</td>
1.269     leot     13890: </tr>
                   13891: <tr>
1.332     rillig   13892: <td>TOOLS_SCRIPT</td>
1.333     nia      13893: <td>TOOL_DEPENDS</td>
1.269     leot     13894: </tr>
                   13895: <tr>
1.332     rillig   13896: <td>TTF_FONTDIR</td>
1.333     nia      13897: <td>TTF_FONTS_DIR</td>
1.329     leot     13898: </tr>
                   13899: <tr>
1.331     gutterid 13900: <td>TYPE</td>
1.333     nia      13901: <td>UAC_REQD_EXECS</td>
1.327     wiz      13902: </tr>
                   13903: <tr>
1.330     wiz      13904: <td>UCSPI_SSL_GROUP</td>
1.333     nia      13905: <td>UCSPI_SSL_USER</td>
1.269     leot     13906: </tr>
                   13907: <tr>
1.330     wiz      13908: <td>UNLIMIT_RESOURCES</td>
1.333     nia      13909: <td>UNPRIVILEGED</td>
1.269     leot     13910: </tr>
                   13911: <tr>
1.330     wiz      13912: <td>UNPRIVILEGED_GROUP</td>
1.333     nia      13913: <td>UNPRIVILEGED_GROUPS</td>
1.269     leot     13914: </tr>
                   13915: <tr>
1.330     wiz      13916: <td>UNPRIVILEGED_USER</td>
1.333     nia      13917: <td>UNWRAP_FILES</td>
1.269     leot     13918: </tr>
                   13919: <tr>
1.330     wiz      13920: <td>UNWRAP_PATTERNS</td>
1.333     nia      13921: <td>UPDATE_GEMSPEC</td>
1.269     leot     13922: </tr>
                   13923: <tr>
1.330     wiz      13924: <td>UPDATE_TARGET</td>
1.333     nia      13925: <td>URI</td>
1.269     leot     13926: </tr>
                   13927: <tr>
1.330     wiz      13928: <td>USERGROUP_PHASE</td>
1.333     nia      13929: <td>USERPPP_GROUP</td>
1.269     leot     13930: </tr>
                   13931: <tr>
1.330     wiz      13932: <td>USER_SPECIFIC_PKGS</td>
1.333     nia      13933: <td>USE_ABI_DEPENDS</td>
1.269     leot     13934: </tr>
                   13935: <tr>
1.330     wiz      13936: <td>USE_APR</td>
1.333     nia      13937: <td>USE_BSD_MAKEFILE</td>
1.269     leot     13938: </tr>
                   13939: <tr>
1.330     wiz      13940: <td>USE_BUILTIN</td>
1.333     nia      13941: <td>USE_CROSS_COMPILE</td>
1.320     wiz      13942: </tr>
                   13943: <tr>
1.330     wiz      13944: <td>USE_CURSES</td>
1.333     nia      13945: <td>USE_CWRAPPERS</td>
1.269     leot     13946: </tr>
                   13947: <tr>
1.330     wiz      13948: <td>USE_DB185</td>
1.333     nia      13949: <td>USE_FEATURES</td>
1.269     leot     13950: </tr>
                   13951: <tr>
1.330     wiz      13952: <td>USE_GAMESGROUP</td>
1.333     nia      13953: <td>USE_GCC_RUNTIME</td>
1.269     leot     13954: </tr>
                   13955: <tr>
1.330     wiz      13956: <td>USE_IMAKE</td>
1.333     nia      13957: <td>USE_JAVA</td>
1.269     leot     13958: </tr>
                   13959: <tr>
1.330     wiz      13960: <td>USE_JAVA2</td>
1.333     nia      13961: <td>USE_LANGUAGES</td>
1.269     leot     13962: </tr>
                   13963: <tr>
1.330     wiz      13964: <td>USE_LIBTOOL</td>
1.333     nia      13965: <td>USE_NATIVE_GCC</td>
1.269     leot     13966: </tr>
                   13967: <tr>
1.330     wiz      13968: <td>USE_NETBSD_REPO</td>
1.333     nia      13969: <td>USE_PKGSRC_GCC</td>
1.269     leot     13970: </tr>
                   13971: <tr>
1.330     wiz      13972: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.333     nia      13973: <td>USE_PKGTASKS</td>
1.269     leot     13974: </tr>
                   13975: <tr>
1.330     wiz      13976: <td>USE_PKG_ADMIN_DIGEST</td>
1.333     nia      13977: <td>USE_RUBY_EXTCONF</td>
1.269     leot     13978: </tr>
                   13979: <tr>
1.330     wiz      13980: <td>USE_RUBY_INSTALL</td>
1.333     nia      13981: <td>USE_RUBY_SETUP</td>
1.269     leot     13982: </tr>
                   13983: <tr>
1.330     wiz      13984: <td>USE_RUBY_SETUP_PKG</td>
1.333     nia      13985: <td>USE_TOOLS</td>
1.269     leot     13986: </tr>
                   13987: <tr>
1.330     wiz      13988: <td>UUCP_GROUP</td>
1.333     nia      13989: <td>UUCP_USER</td>
1.269     leot     13990: </tr>
                   13991: <tr>
1.330     wiz      13992: <td>VARBASE</td>
1.333     nia      13993: <td>VARNAME</td>
1.269     leot     13994: </tr>
                   13995: <tr>
1.330     wiz      13996: <td>VIM_EXTRA_OPTS</td>
1.333     nia      13997: <td>WARNING_MSG</td>
1.269     leot     13998: </tr>
                   13999: <tr>
1.330     wiz      14000: <td>WCALC_CGIDIR</td>
1.333     nia      14001: <td>WCALC_CGIPATH</td>
1.269     leot     14002: </tr>
                   14003: <tr>
1.330     wiz      14004: <td>WCALC_HTMLDIR</td>
1.333     nia      14005: <td>WCALC_HTMLPATH</td>
1.269     leot     14006: </tr>
                   14007: <tr>
1.330     wiz      14008: <td>WDM_MANAGERS</td>
1.333     nia      14009: <td>WRAPPER_CC</td>
1.269     leot     14010: </tr>
                   14011: <tr>
1.330     wiz      14012: <td>WRAPPER_REORDER_CMDS</td>
1.333     nia      14013: <td>WRKDIR</td>
1.269     leot     14014: </tr>
                   14015: <tr>
1.330     wiz      14016: <td>WRKDIR_BASENAME</td>
1.333     nia      14017: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     14018: </tr>
                   14019: <tr>
1.330     wiz      14020: <td>WRKLOG</td>
1.333     nia      14021: <td>WRKOBJDIR</td>
1.303     bacon    14022: </tr>
                   14023: <tr>
1.330     wiz      14024: <td>WRKSRC</td>
1.333     nia      14025: <td>X10_PORT</td>
1.269     leot     14026: </tr>
                   14027: <tr>
1.330     wiz      14028: <td>X11</td>
1.333     nia      14029: <td>X11BASE</td>
1.269     leot     14030: </tr>
                   14031: <tr>
1.330     wiz      14032: <td>X11_PKGSRCDIR</td>
1.333     nia      14033: <td>X11_TYPE</td>
1.269     leot     14034: </tr>
                   14035: <tr>
1.330     wiz      14036: <td>X509_CERTIFICATE</td>
1.333     nia      14037: <td>X509_KEY</td>
1.269     leot     14038: </tr>
                   14039: <tr>
1.330     wiz      14040: <td>XAW_TYPE</td>
1.333     nia      14041: <td>XLOCK_DEFAULT_MODE</td>
1.269     leot     14042: </tr>
                   14043: <tr>
1.330     wiz      14044: <td>XMKMF</td>
1.333     nia      14045: <td>XMKMF_FLAGS</td>
1.269     leot     14046: </tr>
                   14047: <tr>
1.330     wiz      14048: <td>XXX</td>
1.333     nia      14049: <td>XXXX</td>
1.274     rillig   14050: </tr>
                   14051: <tr>
1.330     wiz      14052: <td>YES</td>
1.333     nia      14053: <td>ZSH_STATIC</td>
1.332     rillig   14054: </tr>
                   14055: <tr>
                   14056: <td>__stdc__</td>
1.333     nia      14057: <td>_vargroups</td>
1.269     leot     14058: </tr>
                   14059: <tr>
1.332     rillig   14060: <td>accept</td>
1.333     nia      14061: <td>acquire-localbase-lock</td>
1.316     cirnatda 14062: </tr>
                   14063: <tr>
1.332     rillig   14064: <td>acquire-lock</td>
1.333     nia      14065: <td>add</td>
1.289     leot     14066: </tr>
                   14067: <tr>
1.332     rillig   14068: <td>administrator</td>
1.333     nia      14069: <td>alloca</td>
1.269     leot     14070: </tr>
                   14071: <tr>
1.332     rillig   14072: <td>alternatives</td>
1.333     nia      14073: <td>aslr</td>
1.269     leot     14074: </tr>
                   14075: <tr>
1.332     rillig   14076: <td>asprintf</td>
1.333     nia      14077: <td>atlas</td>
1.289     leot     14078: </tr>
                   14079: <tr>
1.332     rillig   14080: <td>autoconf</td>
1.333     nia      14081: <td>automake</td>
1.269     leot     14082: </tr>
                   14083: <tr>
1.332     rillig   14084: <td>autoreconf</td>
1.333     nia      14085: <td>awk</td>
1.269     leot     14086: </tr>
                   14087: <tr>
1.332     rillig   14088: <td>bash</td>
1.333     nia      14089: <td>big-endian</td>
1.269     leot     14090: </tr>
                   14091: <tr>
1.332     rillig   14092: <td>bin-install</td>
1.333     nia      14093: <td>bind</td>
1.271     brook    14094: </tr>
                   14095: <tr>
1.332     rillig   14096: <td>binpkg-list</td>
1.333     nia      14097: <td>blas</td>
1.269     leot     14098: </tr>
                   14099: <tr>
1.332     rillig   14100: <td>bootstrap-depends</td>
1.333     nia      14101: <td>broken</td>
1.292     leot     14102: </tr>
                   14103: <tr>
1.332     rillig   14104: <td>broken_on_platform</td>
1.333     nia      14105: <td>bsd</td>
1.274     rillig   14106: </tr>
                   14107: <tr>
1.332     rillig   14108: <td>bsd.prog.mk</td>
1.333     nia      14109: <td>build</td>
1.269     leot     14110: </tr>
                   14111: <tr>
1.332     rillig   14112: <td>build-env</td>
1.333     nia      14113: <td>buildlink-directories</td>
1.289     leot     14114: </tr>
                   14115: <tr>
1.332     rillig   14116: <td>buildlink-oss-soundcard-h</td>
1.333     nia      14117: <td>c</td>
1.269     leot     14118: </tr>
                   14119: <tr>
1.332     rillig   14120: <td>c++</td>
1.333     nia      14121: <td>ccache</td>
1.269     leot     14122: </tr>
                   14123: <tr>
1.332     rillig   14124: <td>cce</td>
1.333     nia      14125: <td>cdefs</td>
1.269     leot     14126: </tr>
                   14127: <tr>
1.332     rillig   14128: <td>ceil</td>
1.333     nia      14129: <td>changes</td>
1.269     leot     14130: </tr>
                   14131: <tr>
1.332     rillig   14132: <td>changes-entry</td>
1.333     nia      14133: <td>changes-entry-noupdate</td>
1.289     leot     14134: </tr>
                   14135: <tr>
1.332     rillig   14136: <td>check</td>
1.333     nia      14137: <td>check-clean</td>
1.269     leot     14138: </tr>
                   14139: <tr>
1.332     rillig   14140: <td>check-files</td>
1.333     nia      14141: <td>check-files-clean</td>
1.269     leot     14142: </tr>
                   14143: <tr>
1.332     rillig   14144: <td>check-vulnerable</td>
1.333     nia      14145: <td>checksum</td>
1.269     leot     14146: </tr>
                   14147: <tr>
1.332     rillig   14148: <td>checksum-phase</td>
1.333     nia      14149: <td>clean</td>
1.269     leot     14150: </tr>
                   14151: <tr>
1.332     rillig   14152: <td>clean-depends</td>
1.333     nia      14153: <td>cleandir</td>
1.269     leot     14154: </tr>
                   14155: <tr>
1.332     rillig   14156: <td>commit</td>
1.333     nia      14157: <td>commit-changes-entry</td>
1.269     leot     14158: </tr>
                   14159: <tr>
1.332     rillig   14160: <td>compact</td>
1.333     nia      14161: <td>compiler</td>
1.269     leot     14162: </tr>
                   14163: <tr>
1.332     rillig   14164: <td>conf</td>
1.333     nia      14165: <td>config.guess</td>
1.269     leot     14166: </tr>
                   14167: <tr>
1.332     rillig   14168: <td>config.sub</td>
1.333     nia      14169: <td>configuration</td>
1.269     leot     14170: </tr>
                   14171: <tr>
1.332     rillig   14172: <td>configure</td>
1.333     nia      14173: <td>configure-env</td>
1.269     leot     14174: </tr>
                   14175: <tr>
1.332     rillig   14176: <td>configure-help</td>
1.333     nia      14177: <td>configure_args</td>
1.269     leot     14178: </tr>
                   14179: <tr>
1.332     rillig   14180: <td>connect</td>
1.333     nia      14181: <td>cos</td>
1.269     leot     14182: </tr>
                   14183: <tr>
1.332     rillig   14184: <td>cputime</td>
1.333     nia      14185: <td>create-usergroup</td>
1.269     leot     14186: </tr>
                   14187: <tr>
1.332     rillig   14188: <td>csh</td>
1.333     nia      14189: <td>ctf</td>
1.289     leot     14190: </tr>
                   14191: <tr>
1.332     rillig   14192: <td>cvs</td>
1.333     nia      14193: <td>debug</td>
1.329     leot     14194: </tr>
                   14195: <tr>
1.331     gutterid 14196: <td>declaration</td>
1.333     nia      14197: <td>declare</td>
1.327     wiz      14198: </tr>
                   14199: <tr>
1.331     gutterid 14200: <td>defined</td>
1.333     nia      14201: <td>depend</td>
1.320     wiz      14202: </tr>
                   14203: <tr>
1.331     gutterid 14204: <td>dependencies</td>
1.333     nia      14205: <td>depends</td>
1.269     leot     14206: </tr>
                   14207: <tr>
1.331     gutterid 14208: <td>depends-checksum</td>
1.333     nia      14209: <td>depends-fetch</td>
1.311     leot     14210: </tr>
                   14211: <tr>
1.331     gutterid 14212: <td>deps</td>
1.333     nia      14213: <td>describe</td>
1.269     leot     14214: </tr>
                   14215: <tr>
1.331     gutterid 14216: <td>destdir</td>
1.333     nia      14217: <td>disable</td>
1.269     leot     14218: </tr>
                   14219: <tr>
1.331     gutterid 14220: <td>distclean</td>
1.333     nia      14221: <td>distinfo</td>
1.269     leot     14222: </tr>
                   14223: <tr>
1.331     gutterid 14224: <td>dl</td>
1.333     nia      14225: <td>dlopen</td>
1.269     leot     14226: </tr>
                   14227: <tr>
1.327     wiz      14228: <td>do-buildlink</td>
1.333     nia      14229: <td>do-clean</td>
1.269     leot     14230: </tr>
                   14231: <tr>
1.327     wiz      14232: <td>do-configure</td>
1.333     nia      14233: <td>do-configure-post-hook</td>
1.277     rillig   14234: </tr>
                   14235: <tr>
1.327     wiz      14236: <td>do-extract</td>
1.333     nia      14237: <td>do-fetch</td>
1.269     leot     14238: </tr>
                   14239: <tr>
1.332     rillig   14240: <td>do-install</td>
1.333     nia      14241: <td>emul</td>
1.332     rillig   14242: </tr>
                   14243: <tr>
                   14244: <td>emul-distinfo</td>
1.333     nia      14245: <td>emul-fetch</td>
1.269     leot     14246: </tr>
                   14247: <tr>
1.332     rillig   14248: <td>emulation</td>
1.333     nia      14249: <td>emulator</td>
1.289     leot     14250: </tr>
                   14251: <tr>
1.332     rillig   14252: <td>enable</td>
1.333     nia      14253: <td>endian</td>
1.269     leot     14254: </tr>
                   14255: <tr>
1.332     rillig   14256: <td>endif</td>
1.333     nia      14257: <td>enomem</td>
1.329     leot     14258: </tr>
                   14259: <tr>
1.327     wiz      14260: <td>err</td>
1.333     nia      14261: <td>errx</td>
1.269     leot     14262: </tr>
                   14263: <tr>
1.327     wiz      14264: <td>etc</td>
1.333     nia      14265: <td>exp</td>
1.320     wiz      14266: </tr>
                   14267: <tr>
1.327     wiz      14268: <td>extract-rpm</td>
1.333     nia      14269: <td>fabs</td>
1.311     leot     14270: </tr>
                   14271: <tr>
1.327     wiz      14272: <td>feature</td>
1.333     nia      14273: <td>features</td>
1.269     leot     14274: </tr>
                   14275: <tr>
1.327     wiz      14276: <td>fetch</td>
1.333     nia      14277: <td>fetch-list</td>
1.269     leot     14278: </tr>
                   14279: <tr>
1.327     wiz      14280: <td>follows</td>
1.333     nia      14281: <td>forbids</td>
1.289     leot     14282: </tr>
                   14283: <tr>
1.327     wiz      14284: <td>form</td>
1.333     nia      14285: <td>format</td>
1.269     leot     14286: </tr>
                   14287: <tr>
1.327     wiz      14288: <td>fortify</td>
1.333     nia      14289: <td>fortify_source</td>
1.269     leot     14290: </tr>
                   14291: <tr>
1.332     rillig   14292: <td>fossil</td>
1.333     nia      14293: <td>friend</td>
1.332     rillig   14294: </tr>
                   14295: <tr>
                   14296: <td>fts</td>
1.333     nia      14297: <td>fts_close</td>
1.269     leot     14298: </tr>
                   14299: <tr>
1.332     rillig   14300: <td>fts_open</td>
1.333     nia      14301: <td>fts_read</td>
1.269     leot     14302: </tr>
                   14303: <tr>
1.332     rillig   14304: <td>fts_set</td>
1.333     nia      14305: <td>gcc</td>
1.269     leot     14306: </tr>
                   14307: <tr>
1.332     rillig   14308: <td>gethostbyaddr</td>
1.333     nia      14309: <td>gethostbyname</td>
1.269     leot     14310: </tr>
                   14311: <tr>
1.332     rillig   14312: <td>gethostbyname2</td>
1.333     nia      14313: <td>getopt_long</td>
1.289     leot     14314: </tr>
                   14315: <tr>
1.332     rillig   14316: <td>getprogname</td>
1.333     nia      14317: <td>getservbyname</td>
1.269     leot     14318: </tr>
                   14319: <tr>
1.332     rillig   14320: <td>getservbyport</td>
1.333     nia      14321: <td>getservent</td>
1.269     leot     14322: </tr>
                   14323: <tr>
1.332     rillig   14324: <td>gettext</td>
1.333     nia      14325: <td>git</td>
1.289     leot     14326: </tr>
                   14327: <tr>
1.324     nia      14328: <td>github</td>
1.333     nia      14329: <td>gitlab</td>
1.327     wiz      14330: </tr>
                   14331: <tr>
1.324     nia      14332: <td>glob</td>
1.333     nia      14333: <td>gnu</td>
1.332     rillig   14334: </tr>
                   14335: <tr>
                   14336: <td>gnu_configure_strict</td>
1.333     nia      14337: <td>go</td>
1.269     leot     14338: </tr>
                   14339: <tr>
1.332     rillig   14340: <td>go-deps</td>
1.333     nia      14341: <td>golang</td>
1.274     rillig   14342: </tr>
                   14343: <tr>
1.332     rillig   14344: <td>guess-license</td>
1.333     nia      14345: <td>hashbang</td>
1.269     leot     14346: </tr>
                   14347: <tr>
1.332     rillig   14348: <td>heimdal</td>
1.333     nia      14349: <td>help</td>
1.269     leot     14350: </tr>
                   14351: <tr>
1.332     rillig   14352: <td>hg</td>
1.333     nia      14353: <td>imake</td>
1.329     leot     14354: </tr>
                   14355: <tr>
1.327     wiz      14356: <td>increment</td>
1.333     nia      14357: <td>inet_aton</td>
1.269     leot     14358: </tr>
                   14359: <tr>
1.327     wiz      14360: <td>interp</td>
1.333     nia      14361: <td>interpreter</td>
1.320     wiz      14362: </tr>
                   14363: <tr>
1.327     wiz      14364: <td>intl</td>
1.333     nia      14365: <td>ip4</td>
1.311     leot     14366: </tr>
                   14367: <tr>
1.327     wiz      14368: <td>ip6</td>
1.333     nia      14369: <td>ipv4</td>
1.269     leot     14370: </tr>
                   14371: <tr>
1.327     wiz      14372: <td>ipv6</td>
1.333     nia      14373: <td>iso</td>
1.269     leot     14374: </tr>
                   14375: <tr>
1.327     wiz      14376: <td>kerberos</td>
1.333     nia      14377: <td>krb</td>
1.269     leot     14378: </tr>
                   14379: <tr>
1.327     wiz      14380: <td>krb5</td>
1.333     nia      14381: <td>ksh</td>
1.269     leot     14382: </tr>
                   14383: <tr>
1.327     wiz      14384: <td>lapack</td>
1.333     nia      14385: <td>latex</td>
1.303     bacon    14386: </tr>
                   14387: <tr>
1.327     wiz      14388: <td>libintl_bindtextdomain</td>
1.333     nia      14389: <td>libintl_gettext</td>
1.303     bacon    14390: </tr>
                   14391: <tr>
1.327     wiz      14392: <td>libintl_textdomain</td>
1.333     nia      14393: <td>libnbcompat</td>
1.269     leot     14394: </tr>
                   14395: <tr>
1.327     wiz      14396: <td>libs</td>
1.333     nia      14397: <td>libtool</td>
1.292     leot     14398: </tr>
                   14399: <tr>
1.327     wiz      14400: <td>licence</td>
1.333     nia      14401: <td>license</td>
1.269     leot     14402: </tr>
                   14403: <tr>
1.327     wiz      14404: <td>lintl</td>
1.333     nia      14405: <td>little-endian</td>
1.289     leot     14406: </tr>
                   14407: <tr>
1.327     wiz      14408: <td>lock</td>
1.333     nia      14409: <td>locking</td>
1.274     rillig   14410: </tr>
                   14411: <tr>
1.333     nia      14412: <td>lua</td>
1.332     rillig   14413: <td>lvalue</td>
1.271     brook    14414: </tr>
                   14415: <tr>
1.330     wiz      14416: <td>make</td>
1.332     rillig   14417: <td>makesum</td>
1.269     leot     14418: </tr>
                   14419: <tr>
1.330     wiz      14420: <td>memory</td>
1.332     rillig   14421: <td>mercurial</td>
1.269     leot     14422: </tr>
                   14423: <tr>
1.330     wiz      14424: <td>meta</td>
1.324     nia      14425: <td>meta-package</td>
1.269     leot     14426: </tr>
                   14427: <tr>
1.330     wiz      14428: <td>meta_package</td>
1.324     nia      14429: <td>mit-krb5</td>
1.269     leot     14430: </tr>
                   14431: <tr>
1.330     wiz      14432: <td>mk.conf</td>
1.324     nia      14433: <td>mkl</td>
1.292     leot     14434: </tr>
                   14435: <tr>
1.330     wiz      14436: <td>mount</td>
1.324     nia      14437: <td>mprotect</td>
1.274     rillig   14438: </tr>
                   14439: <tr>
1.330     wiz      14440: <td>mremap</td>
1.324     nia      14441: <td>nb</td>
1.269     leot     14442: </tr>
                   14443: <tr>
1.330     wiz      14444: <td>nbcompat</td>
1.324     nia      14445: <td>netlib</td>
1.269     leot     14446: </tr>
                   14447: <tr>
1.333     nia      14448: <td>node</td>
                   14449: <td>node.js</td>
                   14450: </tr>
                   14451: <tr>
                   14452: <td>nodejs</td>
1.330     wiz      14453: <td>obstack</td>
1.333     nia      14454: </tr>
                   14455: <tr>
1.332     rillig   14456: <td>obstack_ptr_grow</td>
1.333     nia      14457: <td>occurs</td>
1.320     wiz      14458: </tr>
                   14459: <tr>
1.332     rillig   14460: <td>only</td>
1.333     nia      14461: <td>openblas</td>
1.269     leot     14462: </tr>
                   14463: <tr>
1.332     rillig   14464: <td>options</td>
1.333     nia      14465: <td>options.mk</td>
1.269     leot     14466: </tr>
                   14467: <tr>
1.332     rillig   14468: <td>order</td>
1.333     nia      14469: <td>override</td>
1.269     leot     14470: </tr>
                   14471: <tr>
1.332     rillig   14472: <td>override-intltool</td>
1.333     nia      14473: <td>override-message-intltool</td>
1.271     brook    14474: </tr>
                   14475: <tr>
1.332     rillig   14476: <td>package</td>
1.333     nia      14477: <td>parallel</td>
1.269     leot     14478: </tr>
                   14479: <tr>
1.332     rillig   14480: <td>path</td>
1.333     nia      14481: <td>pax</td>
1.269     leot     14482: </tr>
                   14483: <tr>
1.332     rillig   14484: <td>paxctl</td>
1.333     nia      14485: <td>pbulk-index</td>
1.269     leot     14486: </tr>
                   14487: <tr>
1.332     rillig   14488: <td>pc</td>
1.333     nia      14489: <td>perl</td>
1.269     leot     14490: </tr>
                   14491: <tr>
1.332     rillig   14492: <td>perl5</td>
1.333     nia      14493: <td>perms</td>
1.269     leot     14494: </tr>
                   14495: <tr>
1.332     rillig   14496: <td>php</td>
1.333     nia      14497: <td>pkg-build-options</td>
1.269     leot     14498: </tr>
                   14499: <tr>
1.332     rillig   14500: <td>pkg-config</td>
1.333     nia      14501: <td>pkg_build_options</td>
1.269     leot     14502: </tr>
                   14503: <tr>
1.332     rillig   14504: <td>platform</td>
1.333     nia      14505: <td>plist</td>
1.269     leot     14506: </tr>
                   14507: <tr>
1.332     rillig   14508: <td>post-extract</td>
1.333     nia      14509: <td>post-fetch</td>
1.269     leot     14510: </tr>
                   14511: <tr>
1.332     rillig   14512: <td>post-wrapper</td>
1.333     nia      14513: <td>pre-build-checks-hook</td>
1.269     leot     14514: </tr>
                   14515: <tr>
1.332     rillig   14516: <td>pre-configure</td>
1.333     nia      14517: <td>pre-configure-checks-hook</td>
1.269     leot     14518: </tr>
                   14519: <tr>
1.332     rillig   14520: <td>pre-extract</td>
1.333     nia      14521: <td>pre-fetch</td>
1.289     leot     14522: </tr>
                   14523: <tr>
1.332     rillig   14524: <td>print-go-deps</td>
1.333     nia      14525: <td>print-plist</td>
1.269     leot     14526: </tr>
                   14527: <tr>
1.332     rillig   14528: <td>print-summary-data</td>
1.333     nia      14529: <td>privileged-install-hook</td>
1.269     leot     14530: </tr>
                   14531: <tr>
1.332     rillig   14532: <td>pypi</td>
1.333     nia      14533: <td>python</td>
1.269     leot     14534: </tr>
                   14535: <tr>
1.332     rillig   14536: <td>r</td>
1.333     nia      14537: <td>readme-all</td>
1.269     leot     14538: </tr>
                   14539: <tr>
1.332     rillig   14540: <td>recv</td>
1.333     nia      14541: <td>recvfrom</td>
1.269     leot     14542: </tr>
                   14543: <tr>
1.332     rillig   14544: <td>regcomp</td>
1.333     nia      14545: <td>release-localbase-lock</td>
1.289     leot     14546: </tr>
                   14547: <tr>
1.332     rillig   14548: <td>release-lock</td>
1.333     nia      14549: <td>relro</td>
1.289     leot     14550: </tr>
                   14551: <tr>
1.332     rillig   14552: <td>rename</td>
1.333     nia      14553: <td>reorder</td>
1.269     leot     14554: </tr>
                   14555: <tr>
1.332     rillig   14556: <td>replace</td>
1.333     nia      14557: <td>replace_interpreter</td>
1.269     leot     14558: </tr>
                   14559: <tr>
1.332     rillig   14560: <td>reproducible</td>
1.333     nia      14561: <td>resolv</td>
1.269     leot     14562: </tr>
                   14563: <tr>
1.332     rillig   14564: <td>root</td>
1.333     nia      14565: <td>ruby</td>
1.269     leot     14566: </tr>
                   14567: <tr>
1.332     rillig   14568: <td>send</td>
1.333     nia      14569: <td>sendfile</td>
1.289     leot     14570: </tr>
                   14571: <tr>
1.332     rillig   14572: <td>sendto</td>
1.333     nia      14573: <td>setenv</td>
1.269     leot     14574: </tr>
                   14575: <tr>
1.332     rillig   14576: <td>setgid</td>
1.333     nia      14577: <td>setprogname</td>
1.269     leot     14578: </tr>
                   14579: <tr>
1.332     rillig   14580: <td>setuid</td>
1.333     nia      14581: <td>sh</td>
1.269     leot     14582: </tr>
                   14583: <tr>
1.332     rillig   14584: <td>shebang</td>
1.333     nia      14585: <td>show</td>
1.269     leot     14586: </tr>
                   14587: <tr>
1.332     rillig   14588: <td>show-all</td>
1.333     nia      14589: <td>show-build-defs</td>
1.296     rillig   14590: </tr>
                   14591: <tr>
1.332     rillig   14592: <td>show-depends</td>
1.333     nia      14593: <td>show-deps</td>
1.269     leot     14594: </tr>
                   14595: <tr>
1.332     rillig   14596: <td>show-distfiles</td>
1.333     nia      14597: <td>show-downlevel</td>
1.269     leot     14598: </tr>
                   14599: <tr>
1.332     rillig   14600: <td>show-subdir-var</td>
1.333     nia      14601: <td>show-tools</td>
1.269     leot     14602: </tr>
                   14603: <tr>
1.332     rillig   14604: <td>show-var</td>
1.333     nia      14605: <td>show-vars</td>
1.269     leot     14606: </tr>
                   14607: <tr>
1.332     rillig   14608: <td>snprintf</td>
1.333     nia      14609: <td>socket</td>
1.269     leot     14610: </tr>
                   14611: <tr>
1.332     rillig   14612: <td>ssp</td>
1.333     nia      14613: <td>st_mode</td>
1.289     leot     14614: </tr>
                   14615: <tr>
1.332     rillig   14616: <td>stage-install</td>
1.333     nia      14617: <td>strcasestr</td>
1.269     leot     14618: </tr>
                   14619: <tr>
1.332     rillig   14620: <td>strict</td>
1.333     nia      14621: <td>strip</td>
1.269     leot     14622: </tr>
                   14623: <tr>
1.332     rillig   14624: <td>strndup</td>
1.333     nia      14625: <td>strnlen</td>
1.277     rillig   14626: </tr>
                   14627: <tr>
1.332     rillig   14628: <td>strsep</td>
1.333     nia      14629: <td>subst</td>
1.269     leot     14630: </tr>
                   14631: <tr>
1.332     rillig   14632: <td>substitutions</td>
1.333     nia      14633: <td>subversion</td>
1.329     leot     14634: </tr>
                   14635: <tr>
1.326     gutterid 14636: <td>sun</td>
1.333     nia      14637: <td>sunpro</td>
1.327     wiz      14638: </tr>
                   14639: <tr>
                   14640: <td>sunwspro</td>
1.333     nia      14641: <td>svn</td>
1.311     leot     14642: </tr>
                   14643: <tr>
1.276     leot     14644: <td>symlink</td>
1.333     nia      14645: <td>test</td>
1.269     leot     14646: </tr>
                   14647: <tr>
1.289     leot     14648: <td>test-env</td>
1.333     nia      14649: <td>tex</td>
1.269     leot     14650: </tr>
                   14651: <tr>
1.289     leot     14652: <td>texlive</td>
1.333     nia      14653: <td>tmp</td>
1.269     leot     14654: </tr>
                   14655: <tr>
1.289     leot     14656: <td>tool</td>
1.333     nia      14657: <td>tools</td>
1.269     leot     14658: </tr>
                   14659: <tr>
1.289     leot     14660: <td>tools-libtool-m4-override</td>
1.333     nia      14661: <td>type</td>
1.269     leot     14662: </tr>
                   14663: <tr>
1.289     leot     14664: <td>ulimit</td>
1.333     nia      14665: <td>undefined</td>
1.269     leot     14666: </tr>
                   14667: <tr>
1.289     leot     14668: <td>undo-replace</td>
1.333     nia      14669: <td>unlimit</td>
1.269     leot     14670: </tr>
                   14671: <tr>
1.289     leot     14672: <td>unprivileged</td>
1.333     nia      14673: <td>unprivileged-install-hook</td>
1.269     leot     14674: </tr>
                   14675: <tr>
1.289     leot     14676: <td>unstripped</td>
1.333     nia      14677: <td>update</td>
1.269     leot     14678: </tr>
                   14679: <tr>
1.289     leot     14680: <td>upload</td>
1.333     nia      14681: <td>upload-distfiles</td>
1.269     leot     14682: </tr>
                   14683: <tr>
1.270     leot     14684: <td>use_tools</td>
1.333     nia      14685: <td>user</td>
1.269     leot     14686: </tr>
                   14687: <tr>
1.270     leot     14688: <td>utimes</td>
1.333     nia      14689: <td>vasprintf</td>
1.269     leot     14690: </tr>
                   14691: <tr>
1.270     leot     14692: <td>verbose</td>
1.333     nia      14693: <td>vsnprintf</td>
1.269     leot     14694: </tr>
                   14695: <tr>
1.270     leot     14696: <td>warn</td>
1.333     nia      14697: <td>warning</td>
1.269     leot     14698: </tr>
                   14699: <tr>
1.270     leot     14700: <td>warnings</td>
1.333     nia      14701: <td>warnx</td>
1.269     leot     14702: </tr>
                   14703: <tr>
1.289     leot     14704: <td>wattr_off</td>
1.333     nia      14705: <td>wattr_on</td>
1.269     leot     14706: </tr>
                   14707: <tr>
1.289     leot     14708: <td>work</td>
1.333     nia      14709: <td>wrapper</td>
1.269     leot     14710: </tr>
                   14711: <tr>
1.289     leot     14712: <td>wrkdir</td>
1.333     nia      14713: <td> </td>
1.269     leot     14714: </tr>
                   14715: </table>
1.267     rillig   14716: </div>
                   14717: <div class="appendix">
                   14718: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     14719: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   14720: <div class="toc">
                   14721: <p><b>Table of Contents</b></p>
1.210     leot     14722: <dl class="toc">
1.322     leot     14723: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   14724: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig   14725: </dl>
                   14726: </div>
1.79      rillig   14727: <p>This section contains information on editing the pkgsrc
                   14728:        guide itself.</p>
1.148     asau     14729: <div class="sect1">
1.75      rillig   14730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     14731: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79      rillig   14732: <p>The pkgsrc guide's source code is stored in
                   14733:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   14734:        are created from it:</p>
1.148     asau     14735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      14736: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   14737: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     14738: <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>
                   14739: <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   14740:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     14741: <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   14742:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   14743: </ul></div>
                   14744: </div>
1.148     asau     14745: <div class="sect1">
1.75      rillig   14746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     14747: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79      rillig   14748: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      14749: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    14750: <li class="step"><p>Make sure you have checked out the htdocs repository
                   14751:        into a sibling directory of your pkgsrc directory.  You will need
                   14752:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     14753: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      14754:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   14755:        documentation) installed. These are automatically installed when
1.322     leot     14756:        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     14757: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   14758:        right directory. All further steps will take place
                   14759:        here.</p></li>
1.148     asau     14760: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   14761:        <code class="filename">files/</code>.</p></li>
1.148     asau     14762: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   14763:        guide for valid XML and to build the final output files. If you
                   14764:        get any errors at this stage, you can just edit the files, as
                   14765:        there are only symbolic links in the working directory, pointing
                   14766:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     14767: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   14768:        commit)</strong></span></p></li>
1.148     asau     14769: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   14770:        regenerate the output files with the proper RCS
                   14771:        Ids.</p></li>
1.148     asau     14772: <li class="step">
1.110     hubertf  14773: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   14774:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   14775:        <code class="filename">htdocs</code>.</p>
1.148     asau     14776: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   14777: <h3 class="title">Note</h3>
                   14778: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  14779:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   14780:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   14781:        directory.</p>
                   14782: </div>
                   14783: </li>
1.79      rillig   14784: </ol></div>
1.75      rillig   14785: </div>
                   14786: </div>
                   14787: </div></body>
1.1       grant    14788: </html>

CVSweb <webmaster@jp.NetBSD.org>