Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.227

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      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.">
                      9: </head>
1.41      asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1       dsieger    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.10      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.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      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.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.213     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.41      asau       35: <div><div class="abstract">
1.1       dsieger    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.100     leot       48: <dl class="toc">
1.1       dsieger    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>
                     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>
                     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>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     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.154     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.1       dsieger    65: <dd><dl>
1.154     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger    67: <dd><dl>
1.154     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.1       dsieger    70: </dl></dd>
1.154     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger    72: <dd><dl>
1.154     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.1       dsieger    75: </dl></dd>
                     76: </dl></dd>
1.154     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger    78: <dd><dl>
1.154     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.1       dsieger    81: </dl></dd>
1.154     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger    83: <dd><dl>
1.154     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger    85: <dd><dl>
1.154     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.202     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.1       dsieger    94: </dl></dd>
1.154     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger    96: <dd><dl>
1.154     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.1       dsieger   100: </dl></dd>
                    101: </dl></dd>
1.154     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   103: <dd><dl>
1.154     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.1       dsieger   108: <dd><dl>
1.154     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.1       dsieger   112: </dl></dd>
1.154     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.1       dsieger   115: </dl></dd>
1.154     rillig    116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   117: <dd><dl>
1.154     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.6       rillig    120: </dl></dd>
1.154     rillig    121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    122: builds)</a></span></dt>
1.1       dsieger   123: <dd><dl>
1.154     rillig    124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig    125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     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.178     rillig    128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    129: <dd><dl>
1.179     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.181     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.178     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.154     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.23      wiz       161: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     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>
1.221     nia       163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154     rillig    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.1       dsieger   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.154     rillig    173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184     rillig    174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1       dsieger   175: <dd><dl>
1.184     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.1       dsieger   179: <dd><dl>
1.184     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.1       dsieger   185: </dl></dd>
1.184     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.6       rillig    195: </dl></dd>
1.184     rillig    196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6       rillig    197: <dd><dl>
1.184     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.6       rillig    203: <dd><dl>
1.184     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.6       rillig    206: </dl></dd>
1.184     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.6       rillig    223: <dd><dl>
1.219     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.6       rillig    227: </dl></dd>
1.184     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.6       rillig    230: </dl></dd>
1.184     rillig    231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    232: <dd><dl>
1.184     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.6       rillig    237: <dd><dl>
1.184     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.6       rillig    242: </dl></dd>
                    243: </dl></dd>
1.184     rillig    244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6       rillig    245: <dd><dl>
1.184     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.6       rillig    250: </dl></dd>
1.184     rillig    251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6       rillig    252: <dd><dl>
1.184     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.6       rillig    261: <dd><dl>
1.184     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.26      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.6       rillig    268: </dl></dd>
1.184     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.6       rillig    276: <dd><dl>
1.184     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.6       rillig    286: </dl></dd>
1.184     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.6       rillig    293: </dl></dd>
1.184     rillig    294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6       rillig    295: <dd><dl>
1.184     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.154     rillig    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    312: <dd><dl>
                    313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223     nia       336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154     rillig    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205     wiz       342: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223     nia       343: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                    344: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                    345: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                    346: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154     rillig    347: </dl></dd>
                    348: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    349: <dd><dl>
                    350: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    351: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172     rillig    352: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    353: <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>
                    354: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154     rillig    355: </dl></dd>
                    356: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    357: <dd><dl>
                    358: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    359: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    360: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    361: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    362: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203     nia       363: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig    364: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    365: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203     nia       366: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                    367: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                    368: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                    369: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                    370: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                    371: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                    372: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger   373:     emulation</a></span></dt>
1.203     nia       374: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                    375: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger   376: </dl></dd>
1.154     rillig    377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   378: </dl></dd>
1.184     rillig    379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    380: <dd><dl>
                    381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    385: </dl></dd>
1.154     rillig    386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger   387: <dd><dl>
1.154     rillig    388: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    389: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    390: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    391: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    392: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    393: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    394: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    395: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    396: </dl></dd>
                    397: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1       dsieger   398: </dl></dd>
                    399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    400: <dd><dl>
1.184     rillig    401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   402: <dd><dl>
1.184     rillig    403: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                    404: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                    405: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger   406: <dd><dl>
1.184     rillig    407: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                    408: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger   409: </dl></dd>
1.184     rillig    410: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                    411: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   412: <dd><dl>
1.184     rillig    413: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                    414: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   415: </dl></dd>
1.184     rillig    416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   417: <dd><dl>
1.184     rillig    418: <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>
                    419: <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.1       dsieger   420: </dl></dd>
                    421: </dl></dd>
1.184     rillig    422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1       dsieger   423: <dd><dl>
1.184     rillig    424: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                    425: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger   426: <dd><dl>
1.184     rillig    427: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                    428: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger   429: </dl></dd>
                    430: </dl></dd>
1.184     rillig    431: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                    432: <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.1       dsieger   433: </dl></dd>
                    434: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    435: <dd><dl>
                    436: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    437: <dd><dl>
                    438: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    439: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    440: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172     rillig    441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger   442: </dl></dd>
                    443: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    444: </dl></dd>
1.207     leot      445: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1       dsieger   446: <dd><dl>
1.207     leot      447: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                    448: <dd><dl>
                    449: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                    450: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                    451: </dl></dd>
                    452: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                    453: <dd><dl>
                    454: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                    455: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                    456: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                    457: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                    458: </dl></dd>
                    459: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                    460: <dd><dl>
                    461: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                    462: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                    463: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                    464: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                    465: </dl></dd>
                    466: </dl></dd>
                    467: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
                    468: <dd><dl>
                    469: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                    470: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1       dsieger   471: </dl></dd>
1.207     leot      472: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1       dsieger   473: <dd><dl>
1.207     leot      474: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    475: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    476: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    477: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    478: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148     leot      479: <code class="filename">stable</code>,
1.23      wiz       480: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   481: source packages</a></span></dt>
                    482: </dl></dd>
1.207     leot      483: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
                    484: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1       dsieger   485: <dd><dl>
1.207     leot      486: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                    487: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1       dsieger   488: </dl></dd>
                    489: </dl>
                    490: </div>
                    491: <div class="list-of-tables">
                    492: <p><b>List of Tables</b></p>
                    493: <dl>
                    494: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    495: </dt>
1.184     rillig    496: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   497: </dt>
1.184     rillig    498: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   499: </dt>
                    500: </dl>
                    501: </div>
1.41      asau      502: <div class="chapter">
                    503: <div class="titlepage"><div><div><h1 class="title">
                    504: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1       dsieger   505: <div class="toc">
                    506: <p><b>Table of Contents</b></p>
1.100     leot      507: <dl class="toc">
1.1       dsieger   508: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    509: <dd><dl>
                    510: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    511: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    512: </dl></dd>
                    513: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    514: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    515: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    516: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    517: </dl>
                    518: </div>
1.41      asau      519: <div class="sect1">
1.1       dsieger   520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    521: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    522: <p>There is a lot of software freely available for Unix-based
                    523: systems, which is usually available in form of the source code. Before
                    524: such software can be used, it needs to be configured to the local
                    525: system, compiled and installed, and this is exactly what The NetBSD
                    526: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    527: to handle binary packages, so that not every user has to build the
                    528: packages for himself, which is a time-costly task.</p>
                    529: <p>pkgsrc currently contains several thousand packages,
                    530:       including:</p>
1.41      asau      531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot      532: <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.1       dsieger   533:          web server</p></li>
1.207     leot      534: <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.1       dsieger   535:          web browser</p></li>
1.207     leot      536: <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.1       dsieger   537:          Desktop Environment</p></li>
1.207     leot      538: <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.1       dsieger   539:          Desktop Environment</p></li>
                    540: </ul></div>
1.108     rillig    541: <p>&#8230; just to name a few.</p>
1.1       dsieger   542: <p>pkgsrc has built-in support for handling varying dependencies,
                    543:       such as pthreads and X11, and extended features such as IPv6 support on
                    544:       a range of platforms.</p>
1.41      asau      545: <div class="sect2">
1.1       dsieger   546: <div class="titlepage"><div><div><h3 class="title">
                    547: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    548: <p>
                    549: pkgsrc provides the following key features:
                    550: </p>
1.41      asau      551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       552: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   553:   and installation of binary packages. The source and latest
                    554:   patches are retrieved from a master or mirror download site, checksum
                    555:   verified, then built on your system. Support for binary-only
                    556:   distributions is available for both native platforms and NetBSD
                    557:   emulated platforms.</p></li>
1.23      wiz       558: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   559:   including binaries, libraries, man pages and other
                    560:   documentation.</p></li>
1.104     sevan     561: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    562:   performing updates, to ensure required packages are installed. The
                    563:   configuration files of various packages are handled automatically during
                    564:   updates, so local changes are preserved.</p></li>
1.23      wiz       565: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   566:   consists of highly portable code. This allows the greatest speed of
1.25      spz       567:   development when porting to a new platform. This portability also
1.1       dsieger   568:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    569:   platforms</em></span>.</p></li>
1.23      wiz       570: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   571:   international encryption requirements and build-time options for a
                    572:   large number of packages are all set in a simple, central
                    573:   configuration file.</p></li>
1.23      wiz       574: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   575:   freely available under a BSD license, so you may extend and adapt
                    576:   pkgsrc to your needs. Support for local packages and patches is
                    577:   available right out of the box, so you can configure it specifically
                    578:   for your environment.</p></li>
                    579: </ul></div>
                    580: <p>The following principles are basic to pkgsrc:</p>
1.41      asau      581: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       582: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  583: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   584: them and to complain about them rather than to just install the package
                    585: and hope that it works. There are numerous checks in pkgsrc that try to
1.207     leot      586: 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.1       dsieger   587: of shell scripts), and post-installation checks (installed files,
                    588: references to shared libraries, script interpreters).</p></li>
1.23      wiz       589: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  590: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   591: pkgsrc has been ported to many operating systems. Care is taken that
                    592: packages behave the same on all platforms.</p></li>
                    593: </ul></div>
                    594: </div>
1.41      asau      595: <div class="sect2">
1.1       dsieger   596: <div class="titlepage"><div><div><h3 class="title">
                    597: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    598: <p>pkgsrc consists of both a source distribution and a binary
                    599: distribution for these operating systems. After retrieving the required
                    600: source or binaries, you can be up and running with pkgsrc in just
                    601: minutes!</p>
                    602: <p>pkgsrc was derived from FreeBSD's ports system, and
                    603:       initially developed for NetBSD only. Since then, pkgsrc has
                    604:       grown a lot, and now supports the following platforms:</p>
                    605: <div class="table">
                    606: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106     tnn       607: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1       dsieger   608: <colgroup>
                    609: <col>
                    610: <col>
1.92      sevan     611: <col>
1.1       dsieger   612: </colgroup>
                    613: <thead><tr>
                    614: <th>Platform</th>
                    615: <th>Date Support Added</th>
1.92      sevan     616: <th>Notes</th>
1.1       dsieger   617: </tr></thead>
                    618: <tbody>
                    619: <tr>
1.174     leot      620: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   621: <td align="center">Aug 1997</td>
1.92      sevan     622: <td class="auto-generated"> </td>
1.1       dsieger   623: </tr>
                    624: <tr>
1.10      hubertf   625: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   626: <td align="center">Mar 1999</td>
1.151     sevan     627: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1       dsieger   628: </tr>
                    629: <tr>
1.174     leot      630: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   631: <td align="center">Jun 1999</td>
1.151     sevan     632: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1       dsieger   633: </tr>
                    634: <tr>
                    635: <td>
1.118     sevan     636:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1       dsieger   637:         </td>
                    638: <td align="center">Oct 2001</td>
1.191     bacon     639: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1       dsieger   640: </tr>
                    641: <tr>
1.174     leot      642: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   643: <td align="center">Nov 2002</td>
1.151     sevan     644: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1       dsieger   645: </tr>
                    646: <tr>
1.174     leot      647: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   648: <td align="center">Nov 2002</td>
1.151     sevan     649: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1       dsieger   650: </tr>
                    651: <tr>
1.174     leot      652: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   653: <td align="center">Dec 2002</td>
1.92      sevan     654: <td>
1.151     sevan     655:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    656:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92      sevan     657:        </td>
1.1       dsieger   658: </tr>
                    659: <tr>
                    660: <td>BSD/OS</td>
                    661: <td align="center">Dec 2003</td>
1.92      sevan     662: <td class="auto-generated"> </td>
1.1       dsieger   663: </tr>
                    664: <tr>
1.174     leot      665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   666: <td align="center">Dec 2003</td>
1.151     sevan     667: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1       dsieger   668: </tr>
                    669: <tr>
                    670: <td>
1.174     leot      671:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   672:           (Microsoft Windows Services for Unix)
                    673:         </td>
                    674: <td align="center">Mar 2004</td>
1.151     sevan     675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1       dsieger   676: </tr>
                    677: <tr>
1.174     leot      678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   679: <td align="center">Oct 2004</td>
1.92      sevan     680: <td class="auto-generated"> </td>
1.1       dsieger   681: </tr>
                    682: <tr>
1.10      hubertf   683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   684: <td align="center">Nov 2004</td>
1.151     sevan     685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1       dsieger   686: </tr>
                    687: <tr>
1.174     leot      688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   689: <td align="center">Apr 2007</td>
1.151     sevan     690: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1       dsieger   691: </tr>
1.23      wiz       692: <tr>
1.174     leot      693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23      wiz       694: <td align="center">Sep 2010</td>
1.151     sevan     695: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23      wiz       696: </tr>
1.45      obache    697: <tr>
1.174     leot      698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57      bsiegert  699: <td align="center">Jan 2011</td>
1.92      sevan     700: <td class="auto-generated"> </td>
1.45      obache    701: </tr>
                    702: <tr>
1.174     leot      703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45      obache    704: <td align="center">Nov 2011</td>
1.151     sevan     705: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45      obache    706: </tr>
                    707: <tr>
1.174     leot      708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45      obache    709: <td align="center">Mar 2013</td>
1.151     sevan     710: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45      obache    711: </tr>
1.58      ryoon     712: <tr>
1.174     leot      713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58      ryoon     714: <td align="center">Jul 2013</td>
1.151     sevan     715: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58      ryoon     716: </tr>
1.104     sevan     717: <tr>
1.174     leot      718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104     sevan     719: <td align="center">Jun 2014</td>
1.151     sevan     720: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104     sevan     721: </tr>
1.1       dsieger   722: </tbody>
                    723: </table></div>
                    724: </div>
                    725: <br class="table-break">
                    726: </div>
                    727: </div>
1.41      asau      728: <div class="sect1">
1.1       dsieger   729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    730: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    731: <p>This document is divided into three parts. The first,
1.10      hubertf   732:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   733:        describes how one can use one of the packages in the Package
                    734:        Collection, either by installing a precompiled binary package,
                    735:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   736:        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.1       dsieger   737:        package so it can be easily built by other NetBSD users without
                    738:        knowing about the package's building details. The third part,
1.10      hubertf   739:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   740:        is intended for those who want to understand how pkgsrc is
                    741:        implemented.</p>
                    742: <p>This document is available in various formats:
1.10      hubertf   743:        <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.1       dsieger   744: </div>
1.41      asau      745: <div class="sect1">
1.1       dsieger   746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    747: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       748: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    749:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   750:       terminology used within this document.</p>
1.41      asau      751: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   752: <dt><span class="term">Package</span></dt>
                    753: <dd><p>A set of files and building instructions
                    754:            that describe what's necessary
                    755:            to build a certain piece of software using
                    756:             pkgsrc. Packages are traditionally stored under
1.123     wiz       757:            <code class="filename">/usr/pkgsrc</code>,
                    758:            but may be stored in any location,
                    759:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1       dsieger   760: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       761: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   762:          is part of the NetBSD operating system and can be bootstrapped
                    763:          to run on non-NetBSD operating systems as well.  It handles
                    764:          building (compiling), installing, and removing of
                    765:          packages.</p></dd>
                    766: <dt><span class="term">Distfile</span></dt>
                    767: <dd><p>This term describes the file or files that are
                    768:            provided by the author of the piece of software to
                    769:            distribute his work. All the changes necessary to build on
                    770:            NetBSD are reflected in the corresponding package. Usually
                    771:            the distfile is in the form of a compressed tar-archive,
                    772:            but other types are possible, too. Distfiles are usually
                    773:            stored below
                    774:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    775: <dt><span class="term">Port</span></dt>
                    776: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    777:            for what we call a package.
1.23      wiz       778:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   779:            architecture.</p></dd>
                    780: <dt><span class="term">Precompiled/binary package</span></dt>
                    781: <dd>
                    782: <p>A set of binaries built with pkgsrc from a distfile
                    783:            and stuffed together in a single <code class="filename">.tgz</code>
                    784:            file so it can be installed on machines of the same
                    785:            machine architecture without the need to
                    786:            recompile. Packages are usually generated in
                    787:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       788:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       789: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   790:            especially in the context of precompiled packages.</p>
                    791: </dd>
                    792: <dt><span class="term">Program</span></dt>
                    793: <dd><p>The piece of software to be installed which will be
                    794:          constructed from all the files in the distfile by the
                    795:          actions defined in the corresponding package.</p></dd>
                    796: </dl></div>
1.41      asau      797: <div class="sect2">
1.1       dsieger   798: <div class="titlepage"><div><div><h3 class="title">
                    799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41      asau      800: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   801: <dt><span class="term">pkgsrc users</span></dt>
                    802: <dd>
                    803: <p>The
                    804:        pkgsrc users are people who use the packages provided by pkgsrc.
                    805:        Typically they are system administrators. The people using the
1.23      wiz       806:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    807:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   808: <p>There are two kinds of pkgsrc users: Some only want to
                    809:        install pre-built binary packages. Others build the pkgsrc
                    810:        packages from source, either for installing them directly or for
1.10      hubertf   811:        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.1       dsieger   812:        documentation.</p>
                    813: </dd>
                    814: <dt><span class="term">package maintainers</span></dt>
                    815: <dd><p>A
1.10      hubertf   816:        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.1       dsieger   817: <dt><span class="term">infrastructure developers</span></dt>
                    818: <dd><p>These people are involved in all those files
                    819:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   820:        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.1       dsieger   821:        too.</p></dd>
                    822: </dl></div>
                    823: </div>
                    824: </div>
1.41      asau      825: <div class="sect1">
1.1       dsieger   826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    827: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    828: <p>When giving examples for commands, shell prompts are used to
                    829:       show if the command should/can be issued as root, or if
1.23      wiz       830:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.115     sevan     831:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    832:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    833:       bourne shell and derivatives.</p>
1.1       dsieger   834: </div>
                    835: </div>
1.41      asau      836: <div class="part">
1.1       dsieger   837: <div class="titlepage"><div><div><h1 class="title">
                    838: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    839: <div class="toc">
                    840: <p><b>Table of Contents</b></p>
1.100     leot      841: <dl class="toc">
1.154     rillig    842: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    843: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1       dsieger   844: <dd><dl>
1.154     rillig    845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   846: <dd><dl>
1.154     rillig    847: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    848: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   849: </dl></dd>
1.154     rillig    850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   851: <dd><dl>
1.154     rillig    852: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    853: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   854: </dl></dd>
                    855: </dl></dd>
1.154     rillig    856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger   857: <dd><dl>
1.154     rillig    858: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    859: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger   860: </dl></dd>
1.154     rillig    861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger   862: <dd><dl>
1.154     rillig    863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger   864: <dd><dl>
1.154     rillig    865: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    866: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202     nia       867: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    868: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    869: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    870: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    871: <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>
                    872: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1       dsieger   873: </dl></dd>
1.154     rillig    874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger   875: <dd><dl>
1.154     rillig    876: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    877: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    878: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger   879: </dl></dd>
                    880: </dl></dd>
1.154     rillig    881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   882: <dd><dl>
1.154     rillig    883: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    884: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    885: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    886: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   887: <dd><dl>
1.154     rillig    888: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    889: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    890: <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.1       dsieger   891: </dl></dd>
1.154     rillig    892: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    893: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger   894: </dl></dd>
1.154     rillig    895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   896: <dd><dl>
1.154     rillig    897: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    898: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    899: </dl></dd>
1.154     rillig    900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    901: builds)</a></span></dt>
1.1       dsieger   902: <dd><dl>
1.154     rillig    903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig    904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     rillig    905: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    906: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178     rillig    907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    908: <dd><dl>
1.179     rillig    909: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    910: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181     rillig    911: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    912: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    913: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    914: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    915: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    916: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    917: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    918: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178     rillig    919: </dl></dd>
                    920: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    921: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154     rillig    922: </dl></dd>
                    923: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    924: <dd><dl>
                    925: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    926: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    927: </dl></dd>
                    928: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    929: <dd><dl>
                    930: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    931: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    932: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    933: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    934: <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>
                    935: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    936: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    937: <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>
                    938: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    939: <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.23      wiz       940: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig    941: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.221     nia       942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154     rillig    943: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    944: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    945: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    946: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    947: <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.1       dsieger   948: </dl></dd>
                    949: </dl>
                    950: </div>
1.41      asau      951: <div class="chapter">
1.1       dsieger   952: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig    953: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    954: <p>
                    955:        To get help when using pkgsrc, the definitive source is this
                    956:        document, the pkgsrc guide. If you don't find anything here,
                    957:        there are alternatives:
                    958: </p>
                    959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    960: <li class="listitem">
                    961: <p>
                    962:        The built-in pkgsrc help, which is available after bootstrapping
                    963:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    964:        help for any topic, such as a variable name like
                    965:        <code class="varname">BUILD_DEFS</code>, a make target like
                    966:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    967:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207     leot      968: <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.154     rillig    969: </li>
                    970: <li class="listitem"><p>
1.163     rillig    971:        To see the value of a single variable, run <span class="command"><strong>bmake
                    972:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    973: </p></li>
                    974: <li class="listitem"><p>
                    975:        To see the values of the most common variables, run
                    976:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    977:        topic. To see the variables for a single topic, run
                    978:        <span class="command"><strong>bmake
                    979:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    980:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    981: </p></li>
                    982: <li class="listitem"><p>
1.154     rillig    983:        The pkgsrc-users mailing list, to which
                    984:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    985:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    986:        questions</a>.</p></li>
                    987: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    988:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    989:        or by using a specialized chat program such as
                    990:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    991:        Pick any user name and join the channel #pkgsrc.</p></li>
                    992: </ul></div>
                    993: </div>
                    994: <div class="chapter">
                    995: <div class="titlepage"><div><div><h2 class="title">
                    996: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1       dsieger   997: <div class="toc">
                    998: <p><b>Table of Contents</b></p>
1.100     leot      999: <dl class="toc">
1.154     rillig   1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger  1001: <dd><dl>
1.154     rillig   1002: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                   1003: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger  1004: </dl></dd>
1.154     rillig   1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger  1006: <dd><dl>
1.154     rillig   1007: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                   1008: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger  1009: </dl></dd>
                   1010: </dl>
                   1011: </div>
                   1012: <p>Before you download and extract the files, you need to decide
                   1013: where you want to extract them. When using pkgsrc as root user, pkgsrc
                   1014: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                   1015: free to install the sources and binary packages wherever you want in
                   1016: your filesystem, provided that the pathname does not contain white-space
                   1017: or other characters that are interpreted specially by the shell and some
                   1018: other programs. A safe bet is to use only letters, digits, underscores
                   1019: and dashes.</p>
1.41      asau     1020: <div class="sect1">
1.1       dsieger  1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1       dsieger  1023: <p>Before you download any pkgsrc files, you should decide
                   1024:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1025:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1026:        quarterly basis from the current branch and only gets modified
                   1027:        for security updates. The names of the stable branches are built
                   1028:        from the year and the quarter, for example
1.214     leot     1029:        <code class="literal">2021Q4</code>.</p>
1.1       dsieger  1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz      1031:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1032:        Both ways are described here.</p>
1.51      asau     1033: <p>Note that tar archive contains CVS working copy.
                   1034:        Thus you can switch to using CVS at any later time.</p>
1.41      asau     1035: <div class="sect2">
1.1       dsieger  1036: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1       dsieger  1038: <p>The primary download location for all pkgsrc files is
1.151     sevan    1039:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51      asau     1040:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1041:        (it points to the same location).
                   1042:        There are a number of subdirectories for different purposes,
1.207     leot     1043:        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.51      asau     1044: <p>The tar archive for the current branch is in the directory
1.151     sevan    1045:        <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.118     sevan    1046:        It is autogenerated weekly.</p>
1.51      asau     1047: <p>To save download time we provide bzip2- and
                   1048:        xz-compressed archives which are published at
1.151     sevan    1049:        <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.51      asau     1050:        and
1.151     sevan    1051:        <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.51      asau     1052:        respectively.
                   1053:        </p>
                   1054: <p>You can fetch the same files using FTP.</p>
1.214     leot     1055: <p>The tar file for the stable branch 2021Q4 is in the
                   1056:        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.136     leot     1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12      weinem   1058: <pre class="screen">
1.214     leot     1059: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz</code></strong></pre>
1.78      snj      1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51      asau     1061:        or your web browser.</p>
1.12      weinem   1062: <p>Then, extract it with:</p>
1.78      snj      1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12      weinem   1064: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1065:        in <code class="filename">/usr/</code> and all the package source will be 
                   1066:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1067: <p>To download pkgsrc-current, run:</p>
                   1068: <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.1       dsieger  1069: </div>
1.41      asau     1070: <div class="sect2">
1.1       dsieger  1071: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23      wiz      1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.214     leot     1074: <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.23      wiz      1075: </pre>
                   1076: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1077:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1078:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1079: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz      1080: <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       dsieger  1081: </pre>
1.174     leot     1082: <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.23      wiz      1083: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz      1084: <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.23      wiz      1085: </pre>
                   1086: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1087:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1088:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1089: <pre class="programlisting">
                   1090: # set CVS remote shell command
                   1091: CVS_RSH=ssh
                   1092: export CVS_RSH
                   1093: </pre>
                   1094: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1095:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1096:        in your home directory and saving the following lines to it.
                   1097:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1098:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1099: <pre class="programlisting">
                   1100: # recommended CVS configuration file from the pkgsrc guide
1.155     sevan    1101: cvs -q
1.2       rillig   1102: checkout -P
1.4       rillig   1103: update -dP
                   1104: diff -upN
1.2       rillig   1105: rdiff -u
1.23      wiz      1106: release -d
1.2       rillig   1107: </pre>
1.1       dsieger  1108: </div>
                   1109: </div>
1.41      asau     1110: <div class="sect1">
1.1       dsieger  1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1       dsieger  1113: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1114:        (which also works if you have first installed it via a tar
                   1115:        file). It saves bandwidth and hard disk activity, compared to
                   1116:        downloading the tar file again.</p>
1.41      asau     1117: <div class="sect2">
1.1       dsieger  1118: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1119: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41      asau     1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1121: <h3 class="title">Warning</h3>
                   1122: <p>When updating from a tar file, you first need to
                   1123:        completely remove the old pkgsrc directory. Otherwise those
                   1124:        files that have been removed from pkgsrc in the mean time will
                   1125:        not be removed on your local disk, resulting in inconsistencies.
                   1126:        When removing the old files, any changes that you have done to
                   1127:        the pkgsrc files will be lost after updating. Therefore updating
                   1128:        via CVS is strongly recommended.</p>
                   1129: </div>
                   1130: <p>Note that by default the distfiles and the binary packages
                   1131:        are saved in the pkgsrc tree, so don't forget to rescue them
1.78      snj      1132:        before updating. You can also configure pkgsrc to store distfiles
                   1133:         and packages in directories outside the pkgsrc tree by setting the
1.1       dsieger  1134:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154     rillig   1135:        variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1136: <p>To update pkgsrc from a tar file, download the tar file as
                   1137:        explained above. Then, make sure that you have not made any
                   1138:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1139:        directory and extract the new tar file. Done.</p>
                   1140: </div>
1.41      asau     1141: <div class="sect2">
1.1       dsieger  1142: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25      spz      1144: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1145: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1146: </pre>
                   1147: <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>
                   1148: <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>
                   1149: </pre>
1.41      asau     1150: <div class="sect3">
1.1       dsieger  1151: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1       dsieger  1153: <p>When updating pkgsrc, the CVS program keeps track of the
                   1154:        branch you selected. But if you, for whatever reason, want to
                   1155:        switch from the stable branch to the current one, you can do it
1.23      wiz      1156:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1157:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1158:        back to the stable branch, add the
1.214     leot     1159:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2021Q4</span>&#8221;</span> option.</p>
1.1       dsieger  1160: </div>
1.41      asau     1161: <div class="sect3">
1.1       dsieger  1162: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1       dsieger  1164: <p>When you update pkgsrc, the CVS program will only touch
                   1165:        those files that are registered in the CVS repository. That
                   1166:        means that any packages that you created on your own will stay
                   1167:        unmodified. If you change files that are managed by CVS, later
                   1168:        updates will try to merge your changes with those that have been
                   1169:        done by others. See the CVS manual, chapter
1.23      wiz      1170:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1171: </div>
                   1172: </div>
                   1173: </div>
                   1174: </div>
1.41      asau     1175: <div class="chapter">
1.1       dsieger  1176: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1       dsieger  1178: <div class="toc">
                   1179: <p><b>Table of Contents</b></p>
1.100     leot     1180: <dl class="toc">
1.154     rillig   1181: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1182: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger  1183: </dl>
                   1184: </div>
1.41      asau     1185: <div class="sect1">
1.1       dsieger  1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1187: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1188: <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.1       dsieger  1189: </div>
1.41      asau     1190: <div class="sect1">
1.1       dsieger  1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1193: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1194:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1195:     to privileged one all programs are installed under one particular user
1.43      asau     1196:     and cannot utilise privileged operations (packages don't create
                   1197:     special users and all special file permissions like setuid are ignored).
                   1198:     </p>
1.1       dsieger  1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1200: <pre class="screen">
1.60      asau     1201: <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.1       dsieger  1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1204:     </pre>
1.43      asau     1205: <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>
                   1206: <p>By default, in privileged mode pkgsrc uses
                   1207:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1208:     where programs will be installed in,
1.118     sevan    1209:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43      asau     1210:     directory where pkgsrc will do its internal bookkeeping,
                   1211:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1212:     where packages install their persistent data.
                   1213:     In unprivileged mode pkgsrc uses
                   1214:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118     sevan    1215:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43      asau     1216:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1217:     </p>
                   1218: <p>You can change default layout using command-line arguments.
                   1219:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1220:     </p>
1.41      asau     1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1222: <h3 class="title">Note</h3>
1.10      hubertf  1223: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1224:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1225:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1226:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1227: </div>
1.43      asau     1228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1229: <h3 class="title">Note</h3>
                   1230: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1231:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1232:       corresponding to the installation you're working with to build
                   1233:       and install packages.
                   1234:       </p>
                   1235: </div>
1.1       dsieger  1236: </div>
                   1237: </div>
1.41      asau     1238: <div class="chapter">
1.1       dsieger  1239: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1       dsieger  1241: <div class="toc">
                   1242: <p><b>Table of Contents</b></p>
1.100     leot     1243: <dl class="toc">
1.154     rillig   1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger  1245: <dd><dl>
1.154     rillig   1246: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1247: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202     nia      1248: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1249: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1250: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1251: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1252: <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>
                   1253: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154     rillig   1254: </dl></dd>
                   1255: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1256: <dd><dl>
                   1257: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1258: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1259: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger  1260: </dl></dd>
                   1261: </dl>
                   1262: </div>
                   1263: <p>Basically, there are two ways of using pkgsrc. The first
                   1264: is to only install the package tools and to use binary packages
1.23      wiz      1265: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1266: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1267: of pkgsrc, too. Then you are able to build your own packages,
                   1268: and you can still use binary packages from someone else.</p>
1.41      asau     1269: <div class="sect1">
1.1       dsieger  1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202     nia      1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151     sevan    1273:   site and mirrors, there are collections of binary packages,
1.9       rillig   1274:   ready to be installed. These binary packages have been built using the
                   1275:   default settings for the directories, that is:</p>
1.41      asau     1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1277: <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>
                   1278: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1279: <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.9       rillig   1280: </ul></div>
                   1281: <p>If you cannot use these directories for whatever reasons (maybe
                   1282:   because you're not root), you cannot use these binary packages, but
1.154     rillig   1283:   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.41      asau     1284: <div class="sect2">
1.1       dsieger  1285: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1287: <p>To install binary packages, you first need to know from where
                   1288:     to get them. The first place where you should look is on the main
1.202     nia      1289:     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.5       weinem   1290: <p>This directory contains binary packages for multiple
1.226     gutterid 1291:     platforms. First, select your operating system. Then, select your
                   1292:     hardware architecture, and in the third step, the OS version and
                   1293:     the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
                   1294: <p>In this directory, you may find a file called
1.9       rillig   1295:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1296:     management tools. If the file is missing, it is likely that your
                   1297:     operating system already provides those tools. Download the file and
                   1298:     extract it in the <code class="filename">/</code> directory. It will create
                   1299:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118     sevan    1300:     for managing binary packages and the database of installed packages).</p>
1.1       dsieger  1301: </div>
1.41      asau     1302: <div class="sect2">
1.1       dsieger  1303: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1305: <p>In the directory from the last section, there is a
1.85      wiz      1306:     subdirectory called <code class="filename">All/</code>, which contains all the
1.9       rillig   1307:     binary packages that are available for the platform, excluding those
1.202     nia      1308:     that may not be distributed via HTTP or FTP.</p>
1.9       rillig   1309: <p>To install packages directly from an FTP or HTTP server, run
                   1310:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1311:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1312: <pre class="screen">
1.202     nia      1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169     rillig   1315: <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.9       rillig   1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202     nia      1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9       rillig   1318: </pre>
                   1319: <p>Instead of URLs, you can also use local paths, for example if
                   1320:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1321:     repository. If you want to install packages from multiple sources,
                   1322:     you can separate them by a semicolon in
                   1323:     <code class="varname">PKG_PATH</code>.</p>
                   1324: <p>After these preparations, installing a package is very
                   1325:     easy:</p>
                   1326: <pre class="screen">
1.202     nia      1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1328: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1329: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1331: </pre>
                   1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1333:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1334: <p>Any prerequisite packages needed to run the
1.1       dsieger  1335:     package in question will be installed, too, assuming they are
1.202     nia      1336:     present in the repository.</p>
1.1       dsieger  1337: <p>After you've installed packages, be sure to have
                   1338:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1339:     <code class="varname">PATH</code> so you can actually start the just
                   1340:     installed program.</p>
                   1341: </div>
1.41      asau     1342: <div class="sect2">
1.1       dsieger  1343: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
                   1345: <p>To update binary packages, it is recommended that you use
                   1346:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1347:     package repository to your locally installed packages and safely
                   1348:     replace any older packages.</p>
                   1349: <p>Note that pkgsrc is released as quarterly branches.
                   1350:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1351:     need to adjust the repository in
                   1352:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1353: </div>
                   1354: <div class="sect2">
                   1355: <div class="titlepage"><div><div><h3 class="title">
                   1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1       dsieger  1357: <p>To deinstall a package, it does not matter whether it was
1.202     nia      1358:     installed from source code or from a binary package. Neither the
                   1359:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1360:     command need to know.</p>
                   1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1       dsieger  1362:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202     nia      1363:     name can be given with or without version number.</p>
1.1       dsieger  1364: </div>
1.41      asau     1365: <div class="sect2">
1.1       dsieger  1366: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202     nia      1369:     installed packages or binary package files.
                   1370:     As with other management tools, it works with packages installed
                   1371:     from source or binaries.</p>
1.1       dsieger  1372: </div>
1.41      asau     1373: <div class="sect2">
1.1       dsieger  1374: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1       dsieger  1376: <p>
1.164     leot     1377:       The pkgsrc Security Team and Packages Groups maintain a list of
1.202     nia      1378:       known vulnerabilities to packages which are (or have been)
1.1       dsieger  1379:       included in pkgsrc.  The list is available from the NetBSD
1.202     nia      1380:       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>.
                   1381:     </p>
                   1382: <p>
                   1383:       Please note that not every "vulnerability" with a CVE assignment is
                   1384:       exploitable in every configuration.
                   1385:       Some bugs are marked as active simply because an fix was not
                   1386:       marked as such.
                   1387:       Operating system specific hardening and mitigation features may also
                   1388:       reduce the impact of bugs.
1.1       dsieger  1389:     </p>
                   1390: <p>
1.22      jakllsch 1391:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1392:       this list can be downloaded
                   1393:       automatically, and a security audit of all packages installed on a system
                   1394:       can take place.
                   1395:     </p>
                   1396: <p>
1.22      jakllsch 1397:       There are two components to auditing.  The first
                   1398:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1399:       is for downloading
1.1       dsieger  1400:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1401:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1402:       installed packages are vulnerable.  If a package is vulnerable, you
                   1403:       will see output similar to the following:
                   1404:     </p>
                   1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174     leot     1406:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1       dsieger  1407: <p>
1.22      jakllsch 1408:       You may wish to have the
1.202     nia      1409:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1410:       file downloaded daily so that
                   1411:       it remains current.  This may be done by adding an appropriate entry
1.207     leot     1412:       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.22      jakllsch 1413:       </p>
                   1414: <pre class="screen">
1.121     sevan    1415: # Download vulnerabilities file
1.118     sevan    1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.121     sevan    1417: # Audit the installed packages and email results to root
                   1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1419:            root &gt;/dev/null 2&gt;&amp;1
1.22      jakllsch 1420:       </pre>
                   1421: <p>
1.118     sevan    1422:       will update the vulnerability list every day at 3AM, followed by an audit
                   1423:       at 3:09AM. The result of the audit are then emailed to root.
1.22      jakllsch 1424: 
1.118     sevan    1425:       On NetBSD this may be accomplished instead by adding the following
                   1426:       line to <code class="filename">/etc/daily.conf</code>:
                   1427:       </p>
                   1428: <pre class="screen">
                   1429: fetch_pkg_vulnerabilities=YES
                   1430:       </pre>
                   1431: <p>
                   1432:       to fetch the vulnerability list from the daily security script. The system
                   1433:       is set to audit the packages by default but can be set explicitly, if
1.123     wiz      1434:       desired (not required), by adding the following line to
1.118     sevan    1435: <code class="filename">/etc/security.conf</code>:
1.22      jakllsch 1436:       </p>
                   1437: <pre class="screen">
1.118     sevan    1438: check_pkg_vulnerabilities=YES
1.22      jakllsch 1439:       </pre>
                   1440: <p>
1.207     leot     1441:       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.1       dsieger  1442:     </p>
                   1443: </div>
1.41      asau     1444: <div class="sect2">
1.1       dsieger  1445: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1446: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1       dsieger  1447: <p>
1.207     leot     1448:       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.23      wiz      1449:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.202     nia      1450:       argument to check if any packages are stale, e.g.
1.1       dsieger  1451:     </p>
                   1452: <pre class="screen">
                   1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1454: ...
                   1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1456:     </pre>
                   1457: </div>
1.41      asau     1458: <div class="sect2">
1.1       dsieger  1459: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10      hubertf  1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1462:     administrative functions on the package system.</p>
                   1463: </div>
                   1464: </div>
1.41      asau     1465: <div class="sect1">
1.1       dsieger  1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1       dsieger  1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1469:   directory now contains a set of packages, organized into
                   1470:   categories. You can browse the online index of packages, or run
1.10      hubertf  1471:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1472:   directory to build local <code class="filename">README.html</code> files for
1.207     leot     1473:   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.1       dsieger  1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1475:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1476:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1477:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1478:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1479:   system (inside a chroot is an exception). </p>
                   1480: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1481:   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.1       dsieger  1482:   instructions how to create your own packages.</p>
1.41      asau     1483: <div class="sect2">
1.1       dsieger  1484: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1       dsieger  1486: <p>To build packages from source, you need a working C
                   1487:     compiler. On NetBSD, you need to install the
1.23      wiz      1488:     <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.1       dsieger  1489:     sets. If you want to build X11-related packages, the
1.23      wiz      1490:     <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.1       dsieger  1491:     sets are required, too.</p>
                   1492: </div>
1.41      asau     1493: <div class="sect2">
1.1       dsieger  1494: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1       dsieger  1496: <p>The first step for building a package is downloading the
                   1497:     distfiles (i.e. the unmodified source). If they have not yet been
                   1498:     downloaded, pkgsrc will fetch them automatically.</p>
                   1499: <p>If you have all files that you need in the
                   1500:     <code class="filename">distfiles</code> directory,
                   1501:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1502:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1503:     </p>
                   1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1505: <p>
1.10      hubertf  1506:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1507: <p>By default a list of distribution sites will be randomly
                   1508:     intermixed to prevent huge load on servers which holding popular
                   1509:     packages (for example, SourceForge.net mirrors). Thus, every
                   1510:     time when you need to fetch yet another distfile all the mirrors
                   1511:     will be tried in new (random) order. You can turn this feature
                   1512:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1513:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1514: <p>You can overwrite some of the major distribution sites to
                   1515:     fit to sites that are close to your own.  By setting one or two
                   1516:     variables you can modify the order in which the master sites are
                   1517:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1518:     delimited list of domain suffixes.
                   1519:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1520:     contains a whitespace delimited list of regular expressions.  It
                   1521:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1522:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1523:     some examples.  This may save some of your bandwidth and
                   1524:     time.</p>
                   1525: <p>You can change these settings either in your shell's environment, or,
                   1526:     if you want to keep the settings, by editing the
1.10      hubertf  1527:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1528:     and adding the definitions there.</p>
                   1529: <p>
                   1530:       If a package depends on many other packages (such as
1.207     leot     1531:       <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.1       dsieger  1532:       alternate between periods of
                   1533:       downloading source, and compiling. To ensure you have all the source
                   1534:       downloaded initially you can run the command:
                   1535:       </p>
                   1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1537: <p>
                   1538:       which will output and run a set of shell commands to fetch the
                   1539:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1540:       also choose to download the files manually.
                   1541:     </p>
                   1542: </div>
1.41      asau     1543: <div class="sect2">
1.1       dsieger  1544: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1       dsieger  1546: <p>
                   1547:       Once the software has downloaded, any patches will be applied, then it
                   1548:       will be compiled for you. This may take some time depending on your
                   1549:       computer, and how many other packages the software depends on and their
                   1550:       compile time.
                   1551:     </p>
1.41      asau     1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1553: <h3 class="title">Note</h3>
                   1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1555:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1556:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1557: </div>
                   1558: <p>For example, type</p>
                   1559: <pre class="screen">
                   1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1562:     </pre>
                   1563: <p>at the shell prompt to build the various components of the
                   1564:     package.</p>
                   1565: <p>The next stage is to actually install the newly compiled
                   1566:     program onto your system. Do this by entering:
                   1567: 
                   1568:     </p>
                   1569: <pre class="screen">
                   1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1571:     </pre>
                   1572: <p>
                   1573: 
                   1574:     while you are still in the directory for whatever package you
                   1575:     are installing.</p>
                   1576: <p>Installing the package on your system may require you to
                   1577:     be root.  However, pkgsrc has a
                   1578:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1579:     to only become root for the actual installation step.</p>
                   1580: <p>That's it, the software should now be installed and setup for use.
                   1581:     You can now enter:
                   1582: 
                   1583:     </p>
                   1584: <pre class="screen">
                   1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1586:     </pre>
                   1587: <p>
                   1588: 
                   1589:     to remove the compiled files in the work directory, as you shouldn't need
                   1590:     them any more. If other packages were also added to your system
                   1591:     (dependencies) to allow your program to compile, you can tidy these up
                   1592:     also with the command:</p>
                   1593: <pre class="screen">
                   1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1595:     </pre>
                   1596: <p>Taking the figlet utility as an example, we can install it on our
1.207     leot     1597:     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.1       dsieger  1598: <p>The program is installed under the default root of the
                   1599:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1600:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1601:     variable in your environment, and it will use that value as the
                   1602:     root of your packages tree. So, to use
                   1603:     <code class="filename">/usr/local</code>, set
                   1604:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1605:     Please note that you should use a directory which is dedicated to
                   1606:     packages and not shared with other programs (i.e., do not try and
                   1607:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1608:     to add any of your own files or directories (such as
                   1609:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1610:     <code class="filename">pkgsrc/</code>) below the
                   1611:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1612:     conflicts between programs and other files installed by the
                   1613:     package system and whatever else may have been installed
                   1614:     there.</p>
1.10      hubertf  1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1616:     alter some configuration options at build time.  Have a look at
                   1617:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1618:     of what will be set there by default.  Environment variables such
                   1619:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1620:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1621:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1622: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1623:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1624:     or being installed. This may be for debugging purposes, or out of
                   1625:     simple curiosity. A number of utility values have been added to
                   1626:     help with this.</p>
1.23      wiz      1627: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1628: <li class="listitem">
1.207     leot     1629: <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.1       dsieger  1630:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1631:        information will be displayed. For example,</p>
                   1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1633: <p>will show all the commands that are invoked, up to and
1.23      wiz      1634:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1635: </li>
1.23      wiz      1636: <li class="listitem">
1.207     leot     1637: <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.1       dsieger  1638:        definition, then the <code class="varname">VARNAME</code> definition
                   1639:        should be used, in conjunction with the show-var
1.207     leot     1640:        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.1       dsieger  1641:        variable <code class="varname">LOCALBASE</code>:</p>
                   1642: <pre class="screen">
                   1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1644: /usr/pkg
                   1645: <code class="prompt">%</code>
                   1646:        </pre>
                   1647: </li>
                   1648: </ol></div>
                   1649: <p>If you want to install a binary package that you've either
                   1650:     created yourself (see next section), that you put into
                   1651:     pkgsrc/packages manually or that is located on a remote FTP
                   1652:     server, you can use the "bin-install" target. This target will
1.207     leot     1653:     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.10      hubertf  1654:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1655:     sites searched is kept in the variable
                   1656:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.207     leot     1657:     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.1       dsieger  1658:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1659:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1660:     details.</p>
                   1661: <p>A final word of warning: If you set up a system that has a
                   1662:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1663:     set that before any packages are installed, as you cannot use
                   1664:     several directories for the same purpose. Doing so will result in
                   1665:     pkgsrc not being able to properly detect your installed packages,
                   1666:     and fail miserably. Note also that precompiled binary packages are
                   1667:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1668:     <code class="filename">/usr/pkg</code>, and that you should
                   1669:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1670:     <code class="varname">LOCALBASE</code>.</p>
                   1671: </div>
                   1672: </div>
                   1673: </div>
1.41      asau     1674: <div class="chapter">
1.1       dsieger  1675: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1       dsieger  1677: <div class="toc">
                   1678: <p><b>Table of Contents</b></p>
1.100     leot     1679: <dl class="toc">
1.154     rillig   1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1682: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1683: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1684: <dd><dl>
                   1685: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1686: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1687: <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.1       dsieger  1688: </dl></dd>
1.154     rillig   1689: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1690: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger  1691: </dl>
                   1692: </div>
1.4       rillig   1693: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  1694: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1695: that file depends on the installation. On NetBSD, when you use
1.207     leot     1696: <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.1       dsieger  1697: <code class="filename">/etc/</code>. In all other cases the default location is
                   1698: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1699: bootstrap program to install the binary packages.</p>
                   1700: <p>The format of the configuration file is that of the usual
                   1701: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1702: is done by setting variables in this file. Note that you can define all
                   1703: kinds of variables, and no special error checking (for example for
1.112     rillig   1704: spelling mistakes) takes place.</p>
1.41      asau     1705: <div class="sect1">
1.1       dsieger  1706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1707: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112     rillig   1708: <p>The following variables apply to all
1.1       dsieger  1709:     pkgsrc packages. A complete list of the variables that can be
                   1710:     configured by the user is available in
                   1711:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1712:     comments that describe each variable's intent.</p>
1.41      asau     1713: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1714: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  1715:            packages will be installed. The default is
                   1716:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   1717:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      1718: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1719:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  1720:            installed. The default is
                   1721:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      1722: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  1723:            X11 is installed on the system. The default is
1.84      wiz      1724:            <code class="filename">/usr/X11R7</code>.</p></li>
1.23      wiz      1725: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  1726:            downloaded copies of the original source distributions used
                   1727:            for building pkgsrc packages. The default is
                   1728:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      1729: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  1730:            database about installed packages is stored.  The default is
1.118     sevan    1731:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23      wiz      1732: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  1733:            If set, override the packages'
                   1734:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      1735: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  1736:            Backup location(s) for distribution files and patch files
                   1737:            if not found locally or in
                   1738:            <code class="filename">${MASTER_SITES}</code> or
                   1739:            <code class="filename">${PATCH_SITES}</code> respectively.
1.118     sevan    1740:            The defaults is
                   1741:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      1742: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  1743:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1744:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      1745:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1746:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1747: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 1748:            List of acceptable licenses. License names are case-sensitive.
                   1749:            Whenever you try to build a package whose license is not in this
                   1750:            list, you will get an error message. If the license condition is
                   1751:            simple enough, the error message will include specific
                   1752:            instructions on how to change this variable.</p></li>
1.1       dsieger  1753: </ul></div>
                   1754: </div>
1.41      asau     1755: <div class="sect1">
1.1       dsieger  1756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1757: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108     rillig   1758: <p>
1.1       dsieger  1759:       </p>
1.41      asau     1760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1761: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  1762:            directory for the binary packages. The default is
                   1763:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      1764: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  1765:            The top level directory where, if defined, the separate
                   1766:            working directories will get created, and symbolically
                   1767:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   1768:            This is useful for building packages on several
                   1769:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1770:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   1771:            is local to every architecture. (It should be noted that
                   1772:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 1773:            &mdash; it is an internal definition which refers to the
1.1       dsieger  1774:            root of the pkgsrc tree. It is possible to have many
                   1775:            pkgsrc tree instances.)</p></li>
1.23      wiz      1776: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  1777:            Directory for local patches that aren't part of pkgsrc.
1.184     rillig   1778:            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.1       dsieger  1779:            information.</p></li>
1.23      wiz      1780: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  1781:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  1782:            BSD-style Makefile. If this is not set,
                   1783:            <code class="varname">MAKECONF</code> is set to
                   1784:            <code class="filename">/dev/null</code> to avoid picking up
                   1785:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
                   1786: </ul></div>
                   1787: </div>
1.41      asau     1788: <div class="sect1">
1.1       dsieger  1789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1790: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.198     leot     1791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.143     maya     1792:                 By default, binary packages of built packages are
1.150     leot     1793:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143     maya     1794:                this variable to "no" prevents this.</p></li></ul></div>
1.107     jnemeth  1795: <p>Packages have to support installation into a
1.4       rillig   1796:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1797:     to be built, before the actual filesystem is touched. DESTDIR
                   1798:     support exists in two variations:</p>
1.41      asau     1799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1800: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      1801:       installation and packaging is still run as root.</p></li>
                   1802: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1803:       build, installation and packaging as normal user. Root
                   1804:       privileges are only needed to add packages.</p></li>
                   1805: </ul></div>
1.4       rillig   1806: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1807:     clean</code></strong> needs to be run as root.</p>
1.17      imil     1808: <p>Considering the <code class="filename">foo/bar</code> package,
                   1809:     DESTDIR full support can be tested using the following commands
                   1810: 
                   1811: </p>
                   1812: <pre class="programlisting">
                   1813: <code class="prompt">$</code> id
                   1814: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1815: <code class="prompt">$</code> mkdir $HOME/packages
                   1816: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1817: </pre>
                   1818: <p>
                   1819: 
                   1820:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1821:     should be needed
                   1822: 
                   1823: </p>
                   1824: <pre class="programlisting">
1.66      asau     1825: <code class="prompt">$</code> make stage-install
1.17      imil     1826: </pre>
                   1827: <p>
                   1828: 
                   1829:     Create a package without root privileges
                   1830: 
                   1831: </p>
                   1832: <pre class="programlisting">
1.66      asau     1833: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17      imil     1834: </pre>
                   1835: <p>
                   1836: 
                   1837:     For the following command, you must be able to gain root
1.207     leot     1838:     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.17      imil     1839: 
                   1840: </p>
                   1841: <pre class="programlisting">
1.66      asau     1842: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17      imil     1843: </pre>
                   1844: <p>
                   1845: 
                   1846:     Then, as a simple user
                   1847: 
                   1848: </p>
                   1849: <pre class="programlisting">
                   1850: <code class="prompt">$</code> make clean
                   1851: </pre>
                   1852: <p>
                   1853: 
                   1854:     </p>
1.4       rillig   1855: </div>
1.41      asau     1856: <div class="sect1">
1.4       rillig   1857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1858: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     1859: <div class="sect2">
1.1       dsieger  1860: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1861: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  1862: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1863:     overridden by setting the following variables in /etc/mk.conf:</p>
1.41      asau     1864: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  1865: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1866: <dd>
                   1867: <p>This is a list of values specifying the chain of
                   1868:          compilers to invoke when building packages.  Valid values
                   1869:          are:</p>
1.41      asau     1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66      asau     1871: <li class="listitem"><p><code class="varname">ccc</code>:
                   1872:            Compaq C Compilers (Tru64)</p></li>
                   1873: <li class="listitem"><p><code class="varname">ccache</code>:
                   1874:            compiler cache (chainable)</p></li>
                   1875: <li class="listitem"><p><code class="varname">clang</code>:
                   1876:            Clang C and Objective-C compiler</p></li>
1.23      wiz      1877: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  1878:            distributed C/C++ (chainable)</p></li>
1.66      asau     1879: <li class="listitem"><p><code class="varname">f2c</code>:
                   1880:            Fortran 77 to C compiler (chainable)</p></li>
                   1881: <li class="listitem"><p><code class="varname">icc</code>:
                   1882:            Intel C++ Compiler (Linux)</p></li>
                   1883: <li class="listitem"><p><code class="varname">ido</code>:
                   1884:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23      wiz      1885: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  1886:            GNU C/C++ Compiler</p></li>
1.66      asau     1887: <li class="listitem"><p><code class="varname">hp</code>:
                   1888:            HP-UX C/aC++ compilers</p></li>
1.23      wiz      1889: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  1890:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66      asau     1891: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger  1892:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      1893: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  1894:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66      asau     1895: <li class="listitem"><p><code class="varname">xlc</code>:
1.118     sevan    1896:            IBM's XL C/C++ compiler suite</p></li>
1.1       dsieger  1897: </ul></div>
                   1898: <p>The default is
1.23      wiz      1899:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  1900:          <code class="varname">ccache</code> and/or
                   1901:          <code class="varname">distcc</code> with an appropriate
                   1902:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      1903:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  1904:          variable should always be terminated with a value for
                   1905:          a real compiler.  Note that only one real compiler
1.23      wiz      1906:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  1907:          is not allowed).</p>
                   1908: </dd>
                   1909: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1910: <dd><p>This specifies the minimum version of GCC to use
                   1911:          when building packages.  If the system GCC doesn't
                   1912:          satisfy this requirement, then pkgsrc will build and
                   1913:          install one of the GCC packages to use instead.</p></dd>
1.153     leot     1914: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114     maya     1915: <dd><p>Specifies which version of python to use when several
                   1916:          options are available.</p></dd>
                   1917: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176     gutterid 1918: <dd><p>Specifies the Fortran compiler to use.
                   1919:          The default is <code class="varname">gfortran</code>.</p></dd>
1.114     maya     1920: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1921: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1922:          <code class="varname">gfortran</code> is used, this option specifies which
                   1923:          version to use.</p></dd>
1.1       dsieger  1924: </dl></div>
                   1925: </div>
1.41      asau     1926: <div class="sect2">
1.1       dsieger  1927: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1928: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1929: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1930:        please make sure to use the <code class="literal">+=</code> operator
                   1931:        instead of the <code class="literal">=</code> operator:</p>
                   1932: <pre class="programlisting">
                   1933: CFLAGS+=        -your -flags
                   1934: </pre>
                   1935: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      1936:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  1937:        need to add their own flags.  You may want to take a look
1.207     leot     1938:        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.23      wiz      1939:        package if you're interested in optimization specifically
                   1940:        for the current CPU. </p>
1.1       dsieger  1941: </div>
1.41      asau     1942: <div class="sect2">
1.1       dsieger  1943: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1944: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1945: <p>If you want to pass flags to the linker, both in the configure
                   1946: step and the build step, you can do this in two ways.  Either set
                   1947: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1948: between the two is that <code class="varname">LIBS</code> will be appended to
                   1949: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1950: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1951: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1952: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1953: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1954: settings, use the <code class="literal">+=</code> operator:</p>
                   1955: <pre class="programlisting">
                   1956: LDFLAGS+=        -your -linkerflags
                   1957: </pre>
                   1958: </div>
                   1959: </div>
1.41      asau     1960: <div class="sect1">
1.1       dsieger  1961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1962: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84      wiz      1963: <p>
1.1       dsieger  1964:       </p>
1.41      asau     1965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1966: <li class="listitem">
1.1       dsieger  1967: <p><code class="varname">PKG_DEVELOPER</code>:
                   1968:            Run some sanity checks that package developers want:
                   1969:            </p>
1.41      asau     1970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      1971: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  1972:              fuzz</p></li>
1.23      wiz      1973: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  1974:              binaries will find their shared libs.</p></li>
                   1975: </ul></div>
                   1976: <p>
                   1977:        </p>
                   1978: </li>
1.23      wiz      1979: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  1980:        of debugging output which is displayed whilst making and
                   1981:        installing the package.  The default value for this is 0,
                   1982:        which will not display the commands as they are executed
                   1983:        (normal, default, quiet operation); the value 1 will display
                   1984:        all shell commands before their invocation, and the value 2
                   1985:        will display both the shell commands before their invocation,
1.112     rillig   1986:        as well as their actual execution progress with <span class="command"><strong>set
                   1987:        -x</strong></span>.</p></li>
1.1       dsieger  1988: </ul></div>
                   1989: <p>
                   1990:     </p>
                   1991: </div>
1.41      asau     1992: <div class="sect1">
1.1       dsieger  1993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1994: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  1995: <p>Some packages have build time options, usually to select
                   1996:     between different dependencies, enable optional support for big
                   1997:     dependencies or enable experimental features.</p>
                   1998: <p>To see which options, if any, a package supports, and which
1.10      hubertf  1999:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2000:     show-options</strong></span>, for example:</p>
                   2001: <pre class="programlisting">
                   2002:     The following options are supported by this package:
                   2003:         ssl      Enable SSL support.
                   2004:     Exactly one of the following gecko options is required:
                   2005:         firefox  Use firefox as gecko rendering engine.
                   2006:         mozilla  Use mozilla as gecko rendering engine.
                   2007:     At most one of the following database options may be selected:
                   2008:         mysql    Enable support for MySQL database.
                   2009:         pgsql    Enable support for PostgreSQL database.
                   2010: 
                   2011:     These options are enabled by default: firefox
                   2012:     These options are currently enabled: mozilla ssl
                   2013: </pre>
                   2014: <p>The following variables can be defined in
1.10      hubertf  2015:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2016:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2017:     which can be used to select or disable options for all packages
                   2018:     that support them, and
                   2019:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2020:     which can be used to select or disable options specifically for
                   2021:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      2022:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2023:     are disabled. A few examples:</p>
                   2024: <pre class="screen">
1.10      hubertf  2025: <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.1       dsieger  2026: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2027: PKG_OPTIONS.kdebase=    debug -sasl
                   2028: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2029: <p>It is important to note that options that were specifically
1.18      snj      2030:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   2031:     you do not wish to include the option.  If you are unsure you can view
                   2032:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2033: <p>The following settings are consulted in the order given, and
                   2034:     the last setting that selects or disables an option is
                   2035:     used:</p>
1.23      wiz      2036: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2037: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2038:       maintainer</p></li>
1.23      wiz      2039: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2040:       variables (see below)</p></li>
1.23      wiz      2041: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2042: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  2043: </ol></div>
                   2044: <p>For groups of mutually exclusive options, the last option
                   2045:     selected is used, all others are automatically disabled.  If an
                   2046:     option of the group is explicitly disabled, the previously
                   2047:     selected option, if any, is used.  It is an error if no option
                   2048:     from a required group of options is selected, and building the
                   2049:     package will fail.</p>
                   2050: <p>Before the options framework was introduced, build options
                   2051:     were selected by setting a variable (often named
                   2052:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2053:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2054:     transition to the options framework for the user, these legacy
                   2055:     variables are converted to the appropriate options setting
                   2056:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2057:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2058:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2059:     directly.  Support for the legacy variables will be removed
                   2060:     eventually.</p>
                   2061: </div>
                   2062: </div>
1.41      asau     2063: <div class="chapter">
1.1       dsieger  2064: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2065: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1       dsieger  2066: <div class="toc">
                   2067: <p><b>Table of Contents</b></p>
1.100     leot     2068: <dl class="toc">
1.154     rillig   2069: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2070: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1       dsieger  2071: </dl>
                   2072: </div>
1.41      asau     2073: <div class="sect1">
1.1       dsieger  2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2075: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1       dsieger  2076: <p>Once you have built and installed a package, you can create
                   2077:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.207     leot     2078:     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.1       dsieger  2079:     the same package on a group of hosts and wasting CPU time. It also
                   2080:     provides a simple means for others to install your package, should
                   2081:     you distribute it.</p>
                   2082: <p>To create a binary package, change into the appropriate
1.10      hubertf  2083:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2084:     package</strong></span>:</p>
                   2085: <pre class="screen">
1.112     rillig   2086: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2087: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2088: </pre>
1.1       dsieger  2089: <p>This will build and install your package (if not already done),
                   2090:     and then build a binary package from what was installed. You can
1.10      hubertf  2091:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2092:     it. Binary packages are created by default in
                   2093:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.207     leot     2094:     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
                   2095:     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.154     rillig   2096: <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.1       dsieger  2097:     such a binary package.</p>
                   2098: </div>
1.41      asau     2099: <div class="sect1">
1.1       dsieger  2100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2101: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184     rillig   2102: <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.6       rillig   2103: </div>
                   2104: </div>
1.41      asau     2105: <div class="chapter">
1.6       rillig   2106: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2107: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig   2108: builds)</h2></div></div></div>
                   2109: <div class="toc">
                   2110: <p><b>Table of Contents</b></p>
1.100     leot     2111: <dl class="toc">
1.154     rillig   2112: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig   2113: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     rillig   2114: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2115: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178     rillig   2116: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2117: <dd><dl>
1.179     rillig   2118: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2119: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181     rillig   2120: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2121: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2122: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2123: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2124: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2125: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2126: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2127: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178     rillig   2128: </dl></dd>
                   2129: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2130: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig   2131: </dl>
                   2132: </div>
1.175     gutterid 2133: <p>For a number of reasons, you may want to build binary packages
                   2134: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71      wiz      2135: For instance, when you have multiple machines that should run the same software,
                   2136: it is wasted time if they all build their packages themselves from source.
                   2137: Or you may want to build a list of packages you want and check them before
1.175     gutterid 2138: deploying onto production systems.
1.71      wiz      2139: There is a way of getting a set of binary packages:
1.175     gutterid 2140: the bulk build system, or pbulk ("p" stands for "parallel").
1.112     rillig   2141: This chapter describes how to set it up.</p>
1.41      asau     2142: <div class="sect1">
1.6       rillig   2143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2144: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71      wiz      2145: <p>First of all, you have to decide whether you build all packages
                   2146: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2147: both space and time, than builds for some practical sets of packages.
1.175     gutterid 2148: A number of particularly heavy packages exist that are not actually
                   2149: interesting to a wide audience. (The approximate resource consumption for a
                   2150: 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>.)
                   2151: For limited bulk builds you need to make a list of packages you want to build.
1.112     rillig   2152: Note that all their dependencies will be built, so you don't need to track them manually.
1.71      wiz      2153: </p>
                   2154: <p>During bulk builds various packages are installed and deinstalled
                   2155: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2156: so make sure that you don't need any package during the builds.
1.112     rillig   2157: Essentially, you should provide a fresh system, either a chroot environment
1.71      wiz      2158: or something even more restrictive, depending on what the operating system provides,
                   2159: or dedicate the whole physical machine.
                   2160: As a useful side effect this makes sure that bulk builds cannot
                   2161: break anything in your system. There have been numerous cases where
1.6       rillig   2162: certain packages tried to install files outside the
                   2163: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71      wiz      2164: <code class="filename">/etc</code>.
                   2165: </p>
1.6       rillig   2166: </div>
1.41      asau     2167: <div class="sect1">
1.6       rillig   2168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     rillig   2169: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2170: <p>Running a bulk build works roughly as follows:</p>
1.41      asau     2171: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2172: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2173: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2174: </ul></div>
1.41      asau     2175: <div class="sect2">
1.15      rillig   2176: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2177: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112     rillig   2178: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68      asau     2179: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2180: Configure network access to fetch distribution files.
1.112     rillig   2181: Create a user with name "pbulk".</p>
1.68      asau     2182: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2183: <pre class="screen">
1.151     sevan    2184: <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>
                   2185: <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.72      wiz      2186: <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.68      asau     2187: </pre>
                   2188: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2189: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2190: <pre class="screen">
1.118     sevan    2191: <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.68      asau     2192: <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>
                   2193: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2194: </pre>
                   2195: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2196: <h3 class="title">Note</h3>
                   2197: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2198: <code class="filename">mk.conf</code> that contains settings you want to
                   2199: apply to packages you build. For instance,</p>
                   2200: <pre class="programlisting">
1.112     rillig   2201: PKG_DEVELOPER=          yes     # perform more checks
                   2202: X11_TYPE=               modular # use pkgsrc X11
                   2203: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2204:                                 # when building all packages)
1.68      asau     2205: </pre>
                   2206: </div>
                   2207: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112     rillig   2208: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68      asau     2209: <pre class="programlisting">
                   2210: www/firefox
                   2211: mail/thunderbird
                   2212: misc/libreoffice4
                   2213: </pre>
1.69      asau     2214: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2215: and make final amendments, if wanted.</p>
1.68      asau     2216: <p>Start it:</p>
                   2217: <pre class="screen">
                   2218: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2219: </pre>
                   2220: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2221: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2222: </p>
                   2223: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2224: <h3 class="title">Note</h3>
                   2225: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2226: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2227: The script is kept small enough for better understanding.</p>
                   2228: </div>
                   2229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2230: <h3 class="title">Note</h3>
                   2231: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205     wiz      2232: unprivileged bulk build and helps configuring distributed bulk builds.
                   2233: Distributed bulk builds support either building in worker chroots
                   2234: (each node is a path to a different chroot)
                   2235: that replicate the target system, including the pbulk prefix,
                   2236: or remote machines (each node is
                   2237: an IP address that must be accessible over SSH without a password).</p>
1.68      asau     2238: </div>
1.6       rillig   2239: </div>
                   2240: </div>
1.41      asau     2241: <div class="sect1">
1.6       rillig   2242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2243: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71      wiz      2244: <p>A complete bulk build requires lots of disk space. Some of the
                   2245: disk space can be read-only, some other must be writable. Some can be on
                   2246: remote filesystems (such as NFS) and some should be local. Some can be
                   2247: temporary filesystems, others must survive a sudden reboot.</p>
                   2248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205     wiz      2249: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2250: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71      wiz      2251: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2252: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2253: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2254: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2255: </ul></div>
                   2256: </div>
                   2257: <div class="sect1">
                   2258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178     rillig   2259: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2260: <p>To ensure that pkgsrc packages work in different configurations, it
                   2261: makes sense to run non-default bulk builds from time to time. This
                   2262: section lists some ideas for bulk builds that intentionally let packages
                   2263: fail if they don't follow the pkgsrc style.</p>
                   2264: <div class="sect2">
                   2265: <div class="titlepage"><div><div><h3 class="title">
1.179     rillig   2266: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178     rillig   2267: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2268: <pre class="programlisting">
                   2269: GNU_CONFIGURE_STRICT=   yes
                   2270: </pre>
                   2271: <p>When a package fails this additional check, the most common cause
                   2272: is that the configure option was valid for an older version of the
                   2273: package but does not apply anymore. In that case, just remove it.</p>
                   2274: </div>
                   2275: <div class="sect2">
                   2276: <div class="titlepage"><div><div><h3 class="title">
1.179     rillig   2277: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178     rillig   2278: <p>The job of a compiler is not restricted to producing executable
1.179     rillig   2279: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2280: compiler wrappers make it easy to force compiler options when the package
                   2281: is built. This can be used to find typical bugs across all packages that
                   2282: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2283: more reliable with the next updates.</p>
                   2284: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.178     rillig   2285: <pre class="programlisting">
                   2286: CFLAGS+=        -Werror=char-subscripts
1.179     rillig   2287: CFLAGS+=        -Werror=implicit-function-declaration
1.178     rillig   2288: </pre>
1.179     rillig   2289: <p>When a package fails to build using these stricter compiler
                   2290: options, document the circumstances in which the compiler produced the
                   2291: error message. This includes:</p>
1.178     rillig   2292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2293: <li class="listitem"><p>The platform
                   2294: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2295: <li class="listitem"><p>The source file</p></li>
                   2296: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2297: part of the diagnostic.</p></li>
1.179     rillig   2298: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178     rillig   2299: </ul></div>
                   2300: <p>If a package produces these error messages, but the package is
1.179     rillig   2301: 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
                   2302: in the next builds:</p>
1.178     rillig   2303: <pre class="programlisting">
1.179     rillig   2304: .if ${PKGPATH} == category/package
1.178     rillig   2305: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2306: # error message
                   2307: # code
1.179     rillig   2308: # Reason why the code does not need to be fixed.
1.178     rillig   2309: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.179     rillig   2310: .endif
1.178     rillig   2311: </pre>
                   2312: <p>If the error messages from the compiler are valid and the code
1.179     rillig   2313: needs to be fixed, prepare a local patch (see
                   2314: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2315: authors of the package, providing them with the information you collected
                   2316: above.</p>
                   2317: <p>Patches that are not essential for the package to work should only
                   2318: be reported upstream but not committed to pkgsrc, to make future updates
                   2319: easier.</p>
1.178     rillig   2320: </div>
                   2321: <div class="sect2">
                   2322: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2323: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2324: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2325: these apply to all phases of the package build process. Especially in the
                   2326: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2327: decisions. The GNU configure scripts feed many small test programs to the
                   2328: C compiler to see whether certain headers are available, functions are
                   2329: defined in a library and programs can be run. In many cases these
                   2330: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2331: -Wextra -Werror</code>.</p>
                   2332: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2333: options being added between the <code class="literal">configure</code> and
                   2334: <code class="literal">build</code> phases. It's a little more complicated than the
                   2335: other examples in this section but still easy enough.</p>
                   2336: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2337: desired compiler options. The compiler wrapper's original task is to hide
                   2338: unwanted directories of include files and to normalize compiler options.
                   2339: It does this by wrapping the compiler command and rewriting the command
                   2340: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2341: package directory and examine the
                   2342: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2343: individual configurations for the C compiler and the related tools. The
                   2344: plan is to find a hook between the configure and build phases, and to
                   2345: modify these configuration files at that point.</p>
                   2346: <p>To find this hook, have a look at
                   2347: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2348: <code class="literal">pre-build-checks-hook</code>. The word
                   2349: <code class="literal">checks</code> doesn't quite fit, but the
                   2350: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2351: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2352: <pre class="programlisting">
                   2353: # Just a few example options.
                   2354: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2355: 
                   2356: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2357: pre-build-checks-hook: add-build-only-cflags
                   2358: 
                   2359: add-build-only-cflags: .PHONY
                   2360:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2361:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2362:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2363:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2364:         done;                                   \
                   2365:         &gt; ${.TARGET}
                   2366: .endif
                   2367: </pre>
                   2368: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2369: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2370: not with spaces.)</p>
                   2371: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2372: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2373: should be undefined, possibly because it is only defined for a subset of
                   2374: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2375: at least one compiler option, to prevent a syntax error in the shell
                   2376: parser.</p>
                   2377: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2378: that the additional compiler options are only appended once, even if
                   2379: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2380: creates a marker file.</p>
                   2381: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2382: configure</strong></span> in a package directory. Up to now, everything works
                   2383: as usual. Examine the directory
                   2384: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2385: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2386: the file <code class="filename">cc</code>. Examine the tail of the
                   2387: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2388: options are used.</p>
                   2389: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2390: options to the file <code class="filename">cc</code> and will create the marker
                   2391: file in the same directory. After that, the build starts as usual, but
                   2392: with the added compiler options. Examine the tail of the file
                   2393: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2394: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2395: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2396: with these options.</p>
                   2397: <p>Building packages using this setup variant and fixing the resulting
                   2398: 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>
                   2399: </div>
                   2400: <div class="sect2">
                   2401: <div class="titlepage"><div><div><h3 class="title">
                   2402: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178     rillig   2403: <p>Some directories like <code class="varname">PREFIX</code>,
                   2404: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2405: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2406: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2407: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2408: <pre class="programlisting">
                   2409: PREFIX=         /a-random-uuid
                   2410: PKG_SYSCONFDIR= /a-random-uuid
                   2411: VARBASE=        /a-random-uuid
                   2412: PKGMANDIR=     a-random-uuid
                   2413: PKG_INFODIR=   a-random-uuid
                   2414: </pre>
                   2415: </div>
                   2416: <div class="sect2">
                   2417: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2418: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178     rillig   2419: <p>When building a package, warnings are typically ignored since they
                   2420: just flow by and do not cause the build to fail immediately. To find
                   2421: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2422: <pre class="programlisting">
                   2423: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2424: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2425: </pre>
                   2426: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2427: them can be redefined with a simple definition like above.</p>
1.179     rillig   2428: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178     rillig   2429: the package Makefile, research whether the package actually needs Perl.
                   2430: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2431: Makefile, and if it doesn't, add
                   2432: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2433: </div>
                   2434: <div class="sect2">
                   2435: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2436: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178     rillig   2437: <p>Using pkglint as part of the regular build process is mostly a
                   2438: waste of time. If you want to fix some of the warnings, just run pkglint
                   2439: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2440: 10), which is much faster than a complete bulk build.</p>
                   2441: </div>
                   2442: <div class="sect2">
                   2443: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2444: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178     rillig   2445: <p>To ensure that the binary packages don't contain references to the
                   2446: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2447: that variable includes the item <code class="literal">extra</code>, it is
                   2448: possible to define additional patterns that must not appear in any
                   2449: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2450: <pre class="programlisting">
                   2451: CHECK_WRKREF=                   extra
                   2452: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2453: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2454: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2455: </pre>
                   2456: <p>The above patterns will probably generate many false positives,
                   2457: therefore the results need to be taken with a grain of salt.</p>
                   2458: </div>
                   2459: <div class="sect2">
                   2460: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2461: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178     rillig   2462: <p>To run the test suites that come with each package, add this line
                   2463: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2464: <pre class="programlisting">
                   2465: PKGSRC_RUN_TEST=        yes
                   2466: </pre>
                   2467: <p>Be prepared that even the most basic packages fail this test. When
                   2468: doing a bulk build with this, it will often abort in the early phase
                   2469: where the packages are scanned for their dependencies since there are
                   2470: cyclic dependencies. There is still a lot to do in this area.</p>
                   2471: </div>
                   2472: <div class="sect2">
                   2473: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2474: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178     rillig   2475: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2476: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2477: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2478: <pre class="programlisting">
                   2479: RUN=    @set -eu;
                   2480: </pre>
1.181     rillig   2481: <p>After that, ensure that none of the bulk build log files (even
                   2482: those for successfully built packages) contains the string
                   2483: <code class="literal">parameter not set</code> or whatever error message the
                   2484: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178     rillig   2485: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2486: definition.</p>
                   2487: </div>
                   2488: <div class="sect2">
                   2489: <div class="titlepage"><div><div><h3 class="title">
1.181     rillig   2490: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178     rillig   2491: <p>The build logs of a package are often quite long. This allows error
                   2492: messages or other interesting details to hide between the noise. To make
                   2493: the actual error message stand out more, add these lines to
                   2494: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2495: <pre class="programlisting">
                   2496: GNU_CONFIGURE_QUIET=    yes
                   2497: MAKE_FLAGS+=            -s
                   2498: </pre>
                   2499: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2500: Make. On exotic platforms with their own make, it may be a little
                   2501: different.</p>
                   2502: </div>
                   2503: </div>
                   2504: <div class="sect1">
                   2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2506: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2507: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2508:     create a CD-ROM set of the resulting binary packages to assist
                   2509:     in installing packages on other machines.  The
1.207     leot     2510:     <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.1       dsieger  2511:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2512:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2513:     way that keeps all the dependencies for a given package on the same
                   2514:     CD as that package.</p>
1.41      asau     2515: <div class="sect2">
1.1       dsieger  2516: <div class="titlepage"><div><div><h3 class="title">
1.178     rillig   2517: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2518: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2519:       man page. The following short example assumes that the binary
                   2520:       packages are left in
                   2521:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2522:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2523:       hold the ISO 9660 images.</p>
                   2524: <pre class="screen">
                   2525: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2526: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2527: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2528:       </pre>
                   2529: <p>If you wish to include a common set of files
                   2530:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2531:       etc.) on each CD in the collection, then you need to create a
1.175     gutterid 2532:       directory which contains these files, e.g.:</p>
1.1       dsieger  2533: <pre class="screen">
                   2534: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2535: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2536: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2537: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2539: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2540: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2541:       </pre>
                   2542: <p>Now create the images:</p>
                   2543: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   2544: <p>Each image will contain <code class="filename">README</code>,
                   2545:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2546:       in their root directories.</p>
                   2547: </div>
                   2548: </div>
                   2549: </div>
1.41      asau     2550: <div class="chapter">
1.1       dsieger  2551: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2552: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2553: <div class="toc">
                   2554: <p><b>Table of Contents</b></p>
1.100     leot     2555: <dl class="toc">
1.154     rillig   2556: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2557: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1       dsieger  2558: </dl>
                   2559: </div>
                   2560: <p>The files that are installed by pkgsrc are organized in a way that
                   2561: is similar to what you find in the <code class="filename">/usr</code> directory
                   2562: of the base system. But some details are different. This is because
                   2563: pkgsrc initially came from FreeBSD and had adopted its file system
                   2564: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2565: which operating system you are using pkgsrc with, you can expect the
                   2566: same layout for pkgsrc.</p>
                   2567: <p>There are mainly four root directories for pkgsrc, which are all
                   2568: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2569: When pkgsrc has been installed as root, the default locations
                   2570: are:</p>
                   2571: <pre class="programlisting">
                   2572: LOCALBASE=              /usr/pkg
                   2573: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2574: VARBASE=                /var
1.119     sevan    2575: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  2576: </pre>
                   2577: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2578: user), the default locations are:</p>
                   2579: <pre class="programlisting">
                   2580: LOCALBASE=              ${HOME}/pkg
                   2581: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2582: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2583: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2584: </pre>
                   2585: <p>What these four directories are for, and what they look like is
                   2586: explained below.</p>
1.41      asau     2587: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2588: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  2589: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      2590: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  2591: the well-known subdirectories like <code class="filename">bin</code>,
                   2592: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2593: <code class="filename">share</code> and
                   2594: <code class="filename">sbin</code>.</p></li>
1.23      wiz      2595: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  2596: <code class="filename">/var</code> in the base system. Some programs (especially
                   2597: games, network daemons) need write access to it during normal
                   2598: operation.</p></li>
1.23      wiz      2599: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  2600: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  2601: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  2602: itself.</p></li>
                   2603: </ul></div>
1.41      asau     2604: <div class="sect1">
1.1       dsieger  2605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2606: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  2607: </h2></div></div></div>
                   2608: <p>The following directories exist in a typical pkgsrc installation
                   2609: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     2610: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2611: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2612: <dd><p>Contains executable programs that are intended to be
                   2613: directly used by the end user.</p></dd>
                   2614: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2615: <dd><p>Contains files for the emulation layers of various other
                   2616: operating systems, especially for
                   2617: NetBSD.</p></dd>
                   2618: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2619: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2620: <dd><p>Contains
                   2621: the configuration files.</p></dd>
                   2622: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2623: <dd><p>Contains headers for the C and C++ programming
                   2624: languages.</p></dd>
                   2625: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2626: <dd><p>Contains GNU info files of various
                   2627: packages.</p></dd>
                   2628: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2629: <dd><p>Contains shared and static
                   2630: libraries.</p></dd>
                   2631: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2632: <dd><p>Contains data files that don't change after
                   2633: installation. Other data files belong into
                   2634: <code class="filename">${VARBASE}</code>.</p></dd>
                   2635: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2636: <dd><p>Contains programs that are not intended to be used by
                   2637: end users, such as helper programs or network
                   2638: daemons.</p></dd>
                   2639: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2640: <dd><p>Contains programs that are intended to be executed as
                   2641: CGI scripts by a web server.</p></dd>
                   2642: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2643: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2644: <dd><p>Contains brief
                   2645: documentation in form of manual pages.</p></dd>
                   2646: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2647: <dd><p>Contains programs that are intended to be used only by
                   2648: the super-user.</p></dd>
                   2649: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2650: <dd><p>Contains platform-independent data files that don't
                   2651: change after installation.</p></dd>
                   2652: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2653: <dd><p>Contains documentation files provided by the
                   2654: packages.</p></dd>
                   2655: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2656: <dd><p>Contains example files provided by the packages. Among
                   2657: others, the original configuration files are saved here and copied to
                   2658: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2659: installation.</p></dd>
                   2660: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2661: <dd><p>Contains the original files for rc.d
                   2662: scripts.</p></dd>
                   2663: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2664: <code class="filename">${VARBASE}</code>)</span></dt>
                   2665: <dd><p>Contains files
                   2666: that may be modified after
                   2667: installation.</p></dd>
                   2668: </dl></div>
                   2669: </div>
1.41      asau     2670: <div class="sect1">
1.1       dsieger  2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2672: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  2673: </h2></div></div></div>
1.41      asau     2674: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2675: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2676: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2677: <dd><p>Contains
                   2678: information about the currently installed
                   2679: packages.</p></dd>
                   2680: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2681: <dd><p>Contains highscore
                   2682: files.</p></dd>
                   2683: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2684: <dd><p>Contains log files.</p></dd>
                   2685: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2686: <dd><p>Contains informational files about daemons that are
                   2687: currently running.</p></dd>
                   2688: </dl></div>
                   2689: </div>
                   2690: </div>
1.41      asau     2691: <div class="chapter">
1.1       dsieger  2692: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2693: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  2694: <div class="toc">
                   2695: <p><b>Table of Contents</b></p>
1.100     leot     2696: <dl class="toc">
1.154     rillig   2697: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2698: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2699: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2700: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2701: <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>
                   2702: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2703: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2704: <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>
                   2705: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2706: <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.23      wiz      2707: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig   2708: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.221     nia      2709: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154     rillig   2710: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2711: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2712: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2713: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2714: <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.1       dsieger  2715: </dl>
                   2716: </div>
                   2717: <p>This section contains hints, tips &amp; tricks on special things in
                   2718: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2719: it contains items for both pkgsrc users and developers.</p>
1.41      asau     2720: <div class="sect1">
1.1       dsieger  2721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2722: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  2723: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     2724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2725: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  2726:          This is a general purpose list for most issues regarding
                   2727:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2728:          for pkgsrc configuration, unexpected build failures, using
                   2729:          particular packages, upgrading pkgsrc installations,
                   2730:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2731:          proposals for changes that impact the pkgsrc user community,
                   2732:          e.g. major infrastructure changes, new features, package
                   2733:          removals, etc., may also be posted.</p></li>
1.174     leot     2734: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  2735:          A list where the results of pkgsrc bulk builds are sent and
                   2736:          discussed.</p></li>
1.174     leot     2737: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  2738:          This list is for those who are interested in getting a
                   2739:          commit message for every change committed to pkgsrc. It is
                   2740:          also available in digest form, meaning one daily message
                   2741:          containing all commit messages for changes to the package
                   2742:          source tree in that 24 hour period.</p></li>
                   2743: </ul></div>
                   2744: <p>To subscribe, do:</p>
                   2745: <pre class="programlisting">
                   2746: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   2747: </pre>
                   2748: <p>Archives for all these mailing lists are available from
1.174     leot     2749: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  2750: </div>
1.41      asau     2751: <div class="sect1">
1.1       dsieger  2752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2753: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  2754: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   2755: a number of useful utilities for both users and developers of pkgsrc.  This
1.121     sevan    2756: section attempts only to make the reader aware of some of the utilities and when
1.1       dsieger  2757: they might be useful, and not to duplicate the documentation that comes
                   2758: with each package.</p>
                   2759: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207     leot     2760: <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.1       dsieger  2761:       Symlinks for use by buildlink.</p></li></ul></div>
                   2762: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     2764: <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.121     sevan    2765:       Calculates various kinds of checksums (including SHA3).</p></li>
1.207     leot     2766: <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.1       dsieger  2767:       Compatibility library for pkgsrc tools.</p></li>
1.207     leot     2768: <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.1       dsieger  2769:       non-BSD systems due to lack of native mtree.</p></li>
1.207     leot     2770: <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.1       dsieger  2771:       Up-to-date replacement for
                   2772:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   2773:       systems where pkg_install is not present.</p></li>
                   2774: </ul></div>
                   2775: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     2776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     2777: <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.1       dsieger  2778:       Create a binary package from an
1.10      hubertf  2779:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  2780:       save the old package.</p></li>
1.207     leot     2781: <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.1       dsieger  2782:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2783:       from multiple locations. It currently supports the following
                   2784:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207     leot     2785: <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.16      jnemeth  2786:       the best compiler flags to optimise code for your current
1.23      wiz      2787:       CPU and compiler. </p></li>
1.1       dsieger  2788: </ul></div>
                   2789: <p>Utilities for keeping track of installed packages, being up to date,
                   2790: etc:</p>
1.41      asau     2791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     2792: <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.65      wiz      2793:     update tool similar to apt(1). Download, install, and upgrade
                   2794:     binary packages easily.</p></li>
1.207     leot     2795: <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.1       dsieger  2796:       packages whose installed versions do not match the latest pkgsrc
                   2797:       entries.</p></li>
1.207     leot     2798: <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.1       dsieger  2799:       dependency graphs of packages, to aid in choosing a strategy for
                   2800:       updating.</p></li>
1.207     leot     2801: <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
                   2802:       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>
                   2803: <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.12      weinem   2804:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207     leot     2805: <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.1       dsieger  2806:       does various checks on the complete pkgsrc system.</p></li>
1.207     leot     2807: <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.1       dsieger  2808:       packages you have installed.</p></li>
                   2809: </ul></div>
                   2810: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     2811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     2812: <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.1       dsieger  2813:       making and maintaining patches for a package (includes pkgdiff,
                   2814:       pkgvi, mkpatches, etc.).</p></li>
1.207     leot     2815: <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.1       dsieger  2816:       converting to pkgsrc.</p></li>
                   2817: </ul></div>
                   2818: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2819: utilities)</p>
1.41      asau     2820: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     2821: <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.1       dsieger  2822:       packages in a chrooted area.</p></li>
1.207     leot     2823: <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.1       dsieger  2824:       kernel version for chrooted cross builds.</p></li>
                   2825: </ul></div>
                   2826: </div>
1.41      asau     2827: <div class="sect1">
1.1       dsieger  2828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2829: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108     rillig   2830: <p>To install packages from source as a non-root user, download
1.154     rillig   2831: 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.108     rillig   2832: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2833: --unprivileged</strong></span>.</p>
                   2834: <p>This will install the binary part of pkgsrc to
                   2835: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2836: into <code class="filename">~/pkg/etc</code>.</p>
                   2837: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1       dsieger  2838: </div>
1.41      asau     2839: <div class="sect1">
1.1       dsieger  2840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2841: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  2842: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2843: enable this feature by adding the option
                   2844: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  2845: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  2846: distfile is found, pkgsrc will try to resume it.</p>
                   2847: <p>You can also
1.61      wiz      2848: use a different program than the platform default program by changing the
1.16      jnemeth  2849: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2850: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2851: by using the value manual.  A value of custom disables the system defaults
                   2852: and dependency tracking for the fetch program.  In that case you have to
                   2853: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2854: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2855: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  2856: <p>For example, if you want to use
1.16      jnemeth  2857: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  2858: like:</p>
                   2859: <pre class="programlisting">
1.112     rillig   2860: FETCH_USING=    wget
1.1       dsieger  2861: </pre>
                   2862: </div>
1.41      asau     2863: <div class="sect1">
1.1       dsieger  2864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2865: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   2866: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  2867: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   2868: you will have to add the following line into
1.10      hubertf  2869: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  2870: <pre class="programlisting">
1.4       rillig   2871: X11_TYPE=modular
1.1       dsieger  2872: </pre>
                   2873: </div>
1.41      asau     2874: <div class="sect1">
1.1       dsieger  2875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2876: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  2877: <p>If you are sitting behind a firewall which does not allow direct
                   2878: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2879: relevant proxy hosts.  This is done using an environment variable in the
                   2880: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      2881: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  2882: port 80 as the proxy port number.  So the proxy environment variables
                   2883: are:</p>
                   2884: <pre class="programlisting">
                   2885: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2886: http_proxy=http://orpheus.amdahl.com:80/
                   2887: </pre>
                   2888: </div>
1.41      asau     2889: <div class="sect1">
1.1       dsieger  2890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2891: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65      wiz      2892: <p>Some fetch tools are not prepared to support HTTPS by default
                   2893: (for example, the one in NetBSD 6.0), or the one installed by the
                   2894: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2895: dependency graph).</p>
                   2896: <p>Usually you won't notice, because distribution files are
                   2897: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2898: be often enough if you are following pkgsrc-current. In that case, set
                   2899: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2900: <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
                   2901: with HTTPS support by default. Of course, these tools need to be
                   2902: installed before you can use them this way.</p>
                   2903: </div>
                   2904: <div class="sect1">
                   2905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2906: <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.1       dsieger  2907: <p>This depends on which utility is used to retrieve distfiles.  From
                   2908: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   2909: the first available command from the following list:</p>
1.41      asau     2910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2911: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2912: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  2913: </ul></div>
                   2914: <p>On a default NetBSD installation, this will be
                   2915: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   2916: connections first, and falls back to active connections if the server
                   2917: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  2918: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  2919: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2920: <p>Having that option present will prevent
                   2921: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   2922: transfers.</p>
                   2923: </div>
1.41      asau     2924: <div class="sect1">
1.1       dsieger  2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2926: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  2927: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  2928: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      2929: 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.1       dsieger  2930: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  2931: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  2932: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   2933: resulting list to your machine at work/school and use it there.  If you
1.207     leot     2934: 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.1       dsieger  2935: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2936: URL:</p>
                   2937: <p>At home:</p>
                   2938: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2939: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2940: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2941: <p>At work:</p>
                   2942: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   2943: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   2944: home.</p>
                   2945: <p>If you have a machine running NetBSD, and you want to get
                   2946: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2947: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  2948: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  2949: directly by running:</p>
                   2950: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2951: <p>If you even decide to ignore
                   2952: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2953: by running:</p>
                   2954: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2955: </div>
1.41      asau     2956: <div class="sect1">
1.1       dsieger  2957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2958: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz      2959: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.207     leot     2960: <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.1       dsieger  2961: package, you get the error from make that it doesn't know how to make
                   2962: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      2963: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  2964: the NetBSD base distribution on your machine.  It is recommended to do
                   2965: that to format man pages.</p>
1.207     leot     2966: <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.1       dsieger  2967: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  2968: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  2969: </div>
1.41      asau     2970: <div class="sect1">
1.1       dsieger  2971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2972: <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.1       dsieger  2973: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   2974: when you installed your NetBSD machine.  Please get and install it, by
                   2975: extracting it in <code class="filename">/</code>:</p>
                   2976: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2977: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   2978: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  2979: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  2980: -r</strong></span>).</p>
                   2981: </div>
1.41      asau     2982: <div class="sect1">
1.1       dsieger  2983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221     nia      2984: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1       dsieger  2985: <p>When installing packages as non-root user and using the just-in-time
1.207     leot     2986: <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.1       dsieger  2987: password for each required package installed.  To avoid this, the sudo
                   2988: package can be used, which does password caching over a limited time.  To
1.221     nia      2989: use it, install <span class="command"><strong>sudo</strong></span> or
                   2990: <span class="command"><strong>priv</strong></span> (either as binary package, from
                   2991: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.207     leot     2992: <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.10      hubertf  2993: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  2994: <span class="emphasis"><em>after</em></span> the definition of the
                   2995: <code class="varname">LOCALBASE</code> variable:</p>
                   2996: <pre class="programlisting">
                   2997: .if exists(${LOCALBASE}/bin/sudo)
                   2998: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2999: .endif
                   3000: </pre>
                   3001: </div>
1.41      asau     3002: <div class="sect1">
1.1       dsieger  3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3004: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3005: <p>As the system administrator, you can choose where configuration files
                   3006: are installed.  The default settings make all these files go into
                   3007: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3008: be suboptimal depending on your expectations (e.g., a read-only,
                   3009: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3010: configuration of the provided packages).</p>
                   3011: <p>In order to change the defaults, you can modify the
                   3012: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3013: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3014: directory; some common examples include <code class="filename">/etc</code> or
                   3015: <code class="filename">/etc/pkg</code>.</p>
                   3016: <p>Furthermore, you can change this value on a per-package basis by
                   3017: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3018: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3019: package you would like to modify, that is, the contents of
                   3020: <code class="varname">PKGBASE</code>.</p>
                   3021: <p>Note that after changing these settings, you must rebuild and
                   3022: reinstall any affected packages.</p>
                   3023: </div>
1.41      asau     3024: <div class="sect1">
1.1       dsieger  3025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3026: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3027: <p>Please be aware that there can often be bugs in third-party software,
                   3028: and some of these bugs can leave a machine vulnerable to exploitation by
                   3029: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3030: maintains a database of known-exploits to packages which have at one time
                   3031: been included in pkgsrc.  The database can be downloaded automatically, and
                   3032: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3033: do this, refer to the following two tools (installed as part of the
1.207     leot     3034: <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.23      wiz      3035: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3036: <li class="listitem">
1.20      snj      3037: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3038:     download a list of the security vulnerabilities information.  This list
1.25      spz      3039:     is kept up to date by the pkgsrc security team, and is distributed
                   3040:     from the NetBSD ftp server:</p>
1.177     leot     3041: <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.1       dsieger  3042: </li>
1.23      wiz      3043: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3044:     current machine, checking each known vulnerability.  If a
1.1       dsieger  3045:     vulnerable package is installed, it will be shown by output to stdout,
                   3046:     including a description of the type of vulnerability, and a URL
                   3047:     containing more information.</p></li>
                   3048: </ol></div>
1.121     sevan    3049: <p>Use of these tools is strongly recommended!
1.202     nia      3050: 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.121     sevan    3051: reporting.</p>
                   3052: <p>If this database is installed, pkgsrc builds will use it to
                   3053: perform a security check before building any package.</p>
1.1       dsieger  3054: </div>
1.41      asau     3055: <div class="sect1">
1.1       dsieger  3056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3057: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  3058: <p>When you add your own preferences to the
                   3059:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3060:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3061:        environment variables to the <code class="filename">./configure</code>
1.207     leot     3062:        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.1       dsieger  3063:        <code class="varname">CFLAGS</code> from the environment variable by
                   3064:        overriding them in the <code class="filename">Makefile</code>s of their
                   3065:        package.</p>
                   3066: <p>Currently there is no solution to this problem. If you
                   3067:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3068:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3069:        directory and then inspect any <code class="filename">Makefile</code> and
                   3070:        <code class="filename">Makefile.in</code> for whether they define
                   3071:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3072:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  3073:        programmers write so bad code that it only works for the
                   3074:        specific combination of <code class="varname">CFLAGS</code> they have
                   3075:        chosen.</p>
1.172     rillig   3076: <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>
                   3077: <pre class="programlisting">
                   3078: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3079: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3080: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3081: </pre>
                   3082: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3083: to see whether the above flags are passed to the actual build
                   3084: commands in general.</p>
                   3085: <p>To find out whether the flags are passed to individual compiler
                   3086: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3087: most cases, the flags from the original command lines (the lines starting
                   3088: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3089: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3090: missing from the actual compiler command, it must have been removed by
1.184     rillig   3091: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1       dsieger  3092: </div>
1.41      asau     3093: <div class="sect1">
1.1       dsieger  3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3095: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3096: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     3097: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  3098:        case that occurs often is that people only update pkgsrc in
                   3099:        parts, because of performance reasons. Since pkgsrc is one large
                   3100:        system, not a collection of many small systems, there are
                   3101:        sometimes changes that only work when the whole pkgsrc tree is
                   3102:        updated.</p></li>
1.41      asau     3103: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      wiz      3104:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3105:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  3106:        files.</p></li>
1.41      asau     3107: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3108:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3109:        verify this.</p></li>
1.108     rillig   3110: <li class="step"><p>If you are a package developer who wants to invest
1.154     rillig   3111:        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.41      asau     3112: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  3113:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3114: </ol></div>
                   3115: </div>
1.41      asau     3116: <div class="sect1">
1.1       dsieger  3117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3118: <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.1       dsieger  3119: <p>You have modified a file from pkgsrc, and someone else has
                   3120: modified that same file afterwards in the CVS repository. Both changes
                   3121: are in the same region of the file, so when you updated pkgsrc, the
                   3122: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3123: file. Because of these markers, the file is no longer a valid
                   3124: <code class="filename">Makefile</code>.</p>
                   3125: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3126: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3127: -dP</strong></span> in that directory to download the current version.</p>
                   3128: </div>
                   3129: </div>
                   3130: </div>
1.41      asau     3131: <div class="part">
1.1       dsieger  3132: <div class="titlepage"><div><div><h1 class="title">
                   3133: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41      asau     3134: <div class="partintro">
1.1       dsieger  3135: <div></div>
                   3136: <p>This part of the book deals with creating and
1.23      wiz      3137:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3138:        guide on creating a new package. The remaining chapters are more
                   3139:        like a reference manual for pkgsrc.</p>
                   3140: <div class="toc">
                   3141: <p><b>Table of Contents</b></p>
1.100     leot     3142: <dl class="toc">
1.154     rillig   3143: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184     rillig   3144: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1       dsieger  3145: <dd><dl>
1.184     rillig   3146: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3147: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3148: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1       dsieger  3149: <dd><dl>
1.184     rillig   3150: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3151: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3152: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3153: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3154: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1       dsieger  3155: </dl></dd>
1.184     rillig   3156: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3157: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3158: <dd><dl>
                   3159: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3160: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3161: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3162: </dl></dd>
                   3163: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3164: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   3165: </dl></dd>
1.184     rillig   3166: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6       rillig   3167: <dd><dl>
1.184     rillig   3168: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3169: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3170: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3171: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3172: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   3173: <dd><dl>
1.184     rillig   3174: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3175: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6       rillig   3176: </dl></dd>
1.184     rillig   3177: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3178: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3179: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3180: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3181: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3182: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3183: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3184: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3185: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3186: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3187: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3188: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3189: </dl></dd>
                   3190: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3191: <dd><dl>
                   3192: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6       rillig   3193: <dd><dl>
1.219     nia      3194: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   3195: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   3196: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6       rillig   3197: </dl></dd>
1.184     rillig   3198: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3199: <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.6       rillig   3200: </dl></dd>
1.184     rillig   3201: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3202: <dd><dl>
1.184     rillig   3203: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3204: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3205: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3206: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6       rillig   3207: <dd><dl>
1.184     rillig   3208: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3209: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3210: <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>
                   3211: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig   3212: </dl></dd>
                   3213: </dl></dd>
1.184     rillig   3214: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6       rillig   3215: <dd><dl>
1.184     rillig   3216: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3217: <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>
                   3218: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3219: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3220: </dl></dd>
1.184     rillig   3221: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6       rillig   3222: <dd><dl>
1.184     rillig   3223: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3224: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3225: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3226: </dl></dd>
                   3227: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3228: <dd><dl>
                   3229: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3230: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3231: <dd><dl>
1.184     rillig   3232: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3233: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26      wiz      3234:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3235:       and
                   3236:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3237:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3238: </dl></dd>
1.184     rillig   3239: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3240: <dd><dl>
                   3241: <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>
                   3242: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3243: </dl></dd>
                   3244: </dl></dd>
                   3245: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6       rillig   3246: <dd><dl>
1.184     rillig   3247: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3249: <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>
                   3250: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3251: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3252: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3253: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3254: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3255: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6       rillig   3256: </dl></dd>
1.184     rillig   3257: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3258: <dd><dl>
                   3259: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3260: <dd><dl>
                   3261: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3262: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6       rillig   3263: </dl></dd>
1.184     rillig   3264: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6       rillig   3265: <dd><dl>
1.184     rillig   3266: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3267: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   3268: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   3269: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   3270: </dl></dd>
                   3271: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3272: <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>
                   3273: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3274: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3275: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3276: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3277: <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.154     rillig   3278: </dl></dd>
                   3279: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3280: <dd><dl>
                   3281: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3282: <dd><dl>
                   3283: <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>
                   3284: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3285: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3286: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3287: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3288: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3289: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3290: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3291: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3292: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3293: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3294: </dl></dd>
                   3295: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3296: <dd><dl>
                   3297: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3298: <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>
                   3299: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3300: </dl></dd>
                   3301: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3302: <dd><dl>
                   3303: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3304: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3305: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223     nia      3306: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154     rillig   3307: </dl></dd>
                   3308: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3309: <dd><dl>
                   3310: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3311: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205     wiz      3312: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223     nia      3313: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   3314: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   3315: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   3316: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154     rillig   3317: </dl></dd>
                   3318: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3319: <dd><dl>
                   3320: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3321: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172     rillig   3322: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3323: <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>
                   3324: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154     rillig   3325: </dl></dd>
                   3326: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3327: <dd><dl>
                   3328: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3329: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3330: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3331: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3332: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203     nia      3333: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig   3334: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3335: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203     nia      3336: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   3337: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   3338: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   3339: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   3340: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   3341: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   3342: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger  3343:     emulation</a></span></dt>
1.203     nia      3344: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   3345: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger  3346: </dl></dd>
1.154     rillig   3347: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3348: </dl></dd>
1.184     rillig   3349: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3350: <dd><dl>
                   3351: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3352: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3353: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3354: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3355: </dl></dd>
1.154     rillig   3356: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger  3357: <dd><dl>
1.154     rillig   3358: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3359: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3360: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3361: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3362: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3363: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3364: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3365: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3366: </dl></dd>
                   3367: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1       dsieger  3368: </dl>
                   3369: </div>
                   3370: </div>
1.41      asau     3371: <div class="chapter">
1.1       dsieger  3372: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3373: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3374: <p>
                   3375:        To get help when developing pkgsrc, the definitive source is this
                   3376:        document, the pkgsrc guide. If you don't find anything here,
                   3377:        there are alternatives:
                   3378: </p>
                   3379: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3380: <li class="listitem">
                   3381: <p>
                   3382:        The built-in pkgsrc help, which is available after bootstrapping
                   3383:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3384:        help for any topic, such as a variable name like
                   3385:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3386:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3387:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207     leot     3388: <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.154     rillig   3389: </li>
                   3390: <li class="listitem"><p>
1.163     rillig   3391:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3392:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3393: </p></li>
                   3394: <li class="listitem"><p>
                   3395:        To see the values of the most common variables, run
                   3396:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3397:        topic. To see the variables for a single topic, run
                   3398:        <span class="command"><strong>bmake
                   3399:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3400:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3401: </p></li>
                   3402: <li class="listitem"><p>
1.154     rillig   3403:        The tech-pkg mailing list, to which
                   3404:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3405:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3406:        questions</a>.</p></li>
                   3407: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3408:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3409:        or by using a specialized chat program such as
                   3410:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3411:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3412: </ul></div>
                   3413: </div>
                   3414: <div class="chapter">
                   3415: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   3416: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  3417: <div class="toc">
                   3418: <p><b>Table of Contents</b></p>
1.100     leot     3419: <dl class="toc">
1.184     rillig   3420: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3421: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3422: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3423: <dd><dl>
                   3424: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3425: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3426: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3427: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3428: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3429: </dl></dd>
                   3430: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3431: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3432: <dd><dl>
                   3433: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3434: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3435: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  3436: </dl></dd>
1.184     rillig   3437: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3438: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  3439: </dl>
                   3440: </div>
1.184     rillig   3441: <p>Whenever you're preparing a package, there are a number of
                   3442: files involved which are described in the following
                   3443: sections.</p>
                   3444: <div class="sect1">
                   3445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3446: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3447: </h2></div></div></div>
                   3448: <p>Building, installation and creation of a binary package are all
                   3449:   controlled by the package's <code class="filename">Makefile</code>.
                   3450:   The <code class="filename">Makefile</code> describes various things about
                   3451:   a package, for example from where to get it, how to configure,
                   3452:   build, and install it.</p>
                   3453: <p>A package <code class="filename">Makefile</code> contains several
                   3454:   sections that describe the package.</p>
                   3455: <p>In the first section there are the following variables, which
                   3456:   should appear exactly in the order given here.  The order and
                   3457:   grouping of the variables is mostly historical and has no further
                   3458:   meaning.</p>
                   3459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3460: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3461:     distribution file to be downloaded from the package's
                   3462:     website.</p></li>
                   3463: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3464:     package, as used by pkgsrc. You need to provide it if
                   3465:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3466:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3467:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3468:     directory name together with the version number. It must match the
                   3469:     regular expression
                   3470:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3471:     starts with a letter or digit, and contains only letters, digits,
1.204     nia      3472:     dashes, underscores, dots and plus signs.
                   3473:     New packages should have entirely lower-case names, with the exception
                   3474:     of some that must follow pre-existing conventions
                   3475:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3476:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3477:     the package name.</p></li>
1.184     rillig   3478: <li class="listitem">
                   3479: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3480:     which the package fits in. You can choose any of the top-level
                   3481:     directories of pkgsrc for it.</p>
                   3482: <p>Currently the following values are available for
                   3483:     <code class="varname">CATEGORIES</code>. If more than
                   3484:     one is used, they need to be separated by spaces:</p>
1.1       dsieger  3485: <pre class="programlisting">
1.184     rillig   3486: archivers     cross         geography     meta-pkgs     security
                   3487: audio         databases     graphics      misc          shells
                   3488: benchmarks    devel         ham           multimedia    sysutils
                   3489: biology       editors       inputmethod   net           textproc
                   3490: cad           emulators     lang          news          time
                   3491: chat          finance       mail          parallel      wm
                   3492: comms         fonts         math          pkgtools      www
                   3493: converters    games         mbone         print         x11
1.1       dsieger  3494: </pre>
                   3495: </li>
1.184     rillig   3496: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3497:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3498:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3499:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3500:     <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>
                   3501: </ul></div>
                   3502: <p>The second section contains information about separately
                   3503:   downloaded patches, if any.
                   3504:   </p>
                   3505: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3506: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3507:     Name(s) of additional files that contain distribution patches.
                   3508:     There is no default. pkgsrc will look for them at
                   3509:     <code class="varname">PATCH_SITES</code>.
                   3510:     They will automatically be uncompressed before patching if
                   3511:     the names end with <code class="filename">.gz</code> or
                   3512:     <code class="filename">.Z</code>.</p></li>
                   3513: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3514:     Primary location(s) for distribution patch files (see
                   3515:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3516: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.207     leot     3517:     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.184     rillig   3518:     help find the correct files to patch. It defaults to
                   3519:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3520: </ul></div>
                   3521: <p>The third section contains the following variables.
                   3522:   </p>
                   3523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3524: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3525:     address of the person who feels responsible for this package,
                   3526:     and who is most likely to look at problems or questions regarding
1.207     leot     3527:     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.184     rillig   3528:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3529:     before making changes to the package, but are not required to
                   3530:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3531:     to yourself. If you really can't maintain the package for future
                   3532:     updates, set it to
                   3533:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3534: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3535:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3536:     developers to update or change the package without contacting
                   3537:     you first. A package Makefile should contain one of
                   3538:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3539:     not both.  </p></li>
                   3540: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3541:     find more information about the package.</p></li>
                   3542: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3543:     description of the package (should not include the package
                   3544:     name).</p></li>
                   3545: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3546:     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>
                   3547: </ul></div>
                   3548: <p>Other variables that affect the build:
                   3549:   </p>
                   3550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3551: <p><code class="varname">WRKSRC</code>: The directory where the
                   3552:       interesting distribution files of the package are found. The
                   3553:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3554:       works for most packages.</p>
                   3555: <p>If a package doesn't create a subdirectory for itself
                   3556:       (most GNU software does, for instance), but extracts itself in
                   3557:       the current directory, you should set
                   3558:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3559: <p>If a package doesn't create a subdirectory with the
                   3560:       name of <code class="varname">DISTNAME</code> but some different name,
                   3561:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3562:       <code class="filename">${WRKDIR}</code>, for example
                   3563:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207     leot     3564:       <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.184     rillig   3565: <p>The name of the working directory created by pkgsrc is
                   3566:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3567:       variable. By default, its value is
                   3568:       <code class="filename">work</code>. If you want to use the same
                   3569:       pkgsrc tree for building different kinds of binary packages,
                   3570:       you can change the variable according to your needs. Two
                   3571:       other variables handle common cases of setting
                   3572:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3573:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3574:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3575:       the host's name is attached to the directory name. If
                   3576:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3577:       is attached, which might look like
                   3578:       <code class="filename">work.i386</code> or
                   3579:       <code class="filename">work.sparc</code>.</p>
                   3580: </li></ul></div>
                   3581: <p>Please pay attention to the following gotchas:</p>
                   3582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3583: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3584:       installed in compressed form by the package.  For packages using
                   3585:       BSD-style makefiles which honor MANZ, there is
                   3586:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3587: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3588:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3589:       below).</p></li>
                   3590: <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>
                   3591: </ul></div>
                   3592: </div>
1.41      asau     3593: <div class="sect1">
1.1       dsieger  3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   3595: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3596: </h2></div></div></div>
                   3597: <p>The <code class="filename">distinfo</code> file contains the message
                   3598:   digest, or checksum, of each distfile needed for the package. This
                   3599:   ensures that the distfiles retrieved from the Internet have not been
                   3600:   corrupted during transfer or altered by a malign force to introduce
                   3601:   a security hole. To provide maximum security, all distfiles are
                   3602:   protected using three different message digest algorithms (SHA1,
                   3603:   RMD160, SHA512), as well as the file size.</p>
                   3604: <p>The <code class="filename">distinfo</code> file also contains the
                   3605:   checksums for all the patches found in the
                   3606:   <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
                   3607:   are only applied intentionally and that they don't accidentally change,
                   3608:   e.g. when merging different changes together. They also make sure that
                   3609:   new patches are actually added to CVS and old ones are removed.
                   3610:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3611:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3612: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3613:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3614: <p>Some packages have different sets of distfiles depending on
1.207     leot     3615:   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.184     rillig   3616:   <code class="filename">distinfo</code> file and care should be taken when
                   3617:   upgrading such a package to ensure distfile information is not
                   3618:   lost.</p>
                   3619: </div>
                   3620: <div class="sect1">
                   3621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3622: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3623: </h2></div></div></div>
                   3624: <p>Some packages don't work out-of-the box on the various
                   3625:   platforms that are supported by pkgsrc. These packages need
                   3626:   to be patched to make them work. The patch files can be
                   3627:   found in the <code class="filename">patches/</code> directory.</p>
                   3628: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3629:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3630:   extracting them, in alphabetic order.</p>
1.41      asau     3631: <div class="sect2">
1.1       dsieger  3632: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3633: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3634: <p>The <code class="filename">patch-*</code> files should be in
                   3635:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3636:   problems. (To force patches to apply with fuzz you can set
                   3637:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3638:   should contain only changes for a single file, and no file should be
                   3639:   patched by more than one patch file. This helps to keep future
                   3640:   modifications simple.</p>
                   3641: <p>Each patch file is structured as follows: In the first line,
                   3642:   there is the RCS Id of the patch itself. The second line should be
                   3643:   empty for aesthetic reasons. After that, there should be a comment for
                   3644:   each change that the patch does. There are a number of standard
                   3645:   cases:</p>
                   3646: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3647: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3648:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3649: <li class="listitem"><p>Patches that change source code should mention the
                   3650:   platform and other environment (for example, the compiler) that the
                   3651:   patch is needed for.</p></li>
                   3652: </ul></div>
                   3653: <p>The patch should be commented so that any
                   3654:   developer who knows the code of the application can make some use of
                   3655:   the patch. Special care should be taken for the upstream developers,
                   3656:   since we generally want that they accept our patches, so we have less
                   3657:   work in the future.</p>
1.1       dsieger  3658: </div>
1.41      asau     3659: <div class="sect2">
1.1       dsieger  3660: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3661: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3662: <p>One important thing to mention is to pay attention that no RCS
                   3663:   IDs get stored in the patch files, as these will cause problems when
                   3664:   later checked into the NetBSD CVS tree. Use the
1.207     leot     3665:   <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.184     rillig   3666:   problems.</p>
                   3667: <p>For even more automation, we recommend using
                   3668:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222     gutterid 3669:   whole set of patches. You just have to back up files before you
                   3670:   edit them to <code class="filename">filename.orig</code>, e.g., with
1.184     rillig   3671:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3672:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3673:   you upgrade a package this way, you can easily compare the new
                   3674:   set of patches with the previously existing one with
                   3675:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3676:   are replaced by new files, so carefully check if you want to take all
                   3677:   the changes.</p>
                   3678: <p>When you have finished a package, remember to generate
                   3679:   the checksums for the patch files by using the <span class="command"><strong>make
                   3680:   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>
                   3681: <p>When adding a patch that corrects a problem in the
                   3682:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3683:   man pages should go), send the patch as a bug report to the
                   3684:   maintainer.  This benefits non-pkgsrc users of the package,
                   3685:   and usually makes it possible to remove the patch in future
                   3686:   version.</p>
                   3687: <p>The file names of the patch files are usually of the form
                   3688:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3689:   Many packages still use the previous convention
                   3690:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3691:   but new patches should be of the form containing the filename.
1.207     leot     3692:   <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.184     rillig   3693:   automatically.</p>
1.222     gutterid 3694: <p>When updating pre-existing patch files, if a file uses the old
                   3695:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
                   3696:   convention, it's best not to change it to the new form, as that will
                   3697:   just cause churn that makes it harder to track changes to patching
                   3698:   over time. Similarly, if a patch now applies at different line offsets,
                   3699:   but still applies cleanly as-is, there's no need to update it, as that
                   3700:   also unnecessarily complicates the patch history.</p>
1.17      imil     3701: </div>
1.160     brook    3702: <div class="sect2">
                   3703: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3704: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3705: <p>If you want to share patches between multiple packages
                   3706:   in pkgsrc, e.g. because they use the same distfiles, set
                   3707:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3708:   can be found, e.g.:</p>
                   3709: <pre class="programlisting">
                   3710: PATCHDIR=       ../../editors/xemacs/patches
                   3711: </pre>
                   3712: <p>Patch files that are distributed by the author or other
                   3713:     maintainers can be listed in
                   3714:     <code class="varname">PATCHFILES</code>.</p>
                   3715: <p>If it is desired to store any patches that should not be
                   3716:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3717:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3718:     directory tree there is expected to have the same
                   3719:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3720:     patches are expected to be stored inside these dirs (also
                   3721:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3722:     example, if you want to keep a private patch for
                   3723:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3724:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3725:     files in the named directory are expected to be patch files,
                   3726:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3727:     applied</em></span>.</p>
1.160     brook    3728: </div>
                   3729: <div class="sect2">
                   3730: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3731: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3732: <p>When fixing a portability issue in the code do not use
                   3733:       preprocessor magic to check for the current operating system nor
                   3734:       platform.  Doing so hurts portability to other platforms because
                   3735:       the OS-specific details are not abstracted appropriately.</p>
                   3736: <p>The general rule to follow is: instead of checking for the
                   3737:       operating system the application is being built on, check for the
                   3738:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3739:       instead of assuming that kqueue is available under NetBSD and
                   3740:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3741:       kqueue support, add a check that detects kqueue itself &mdash;
                   3742:       yes, this generally involves patching the
                   3743:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3744:       that prevents some OSes from adopting interfaces from other OSes
                   3745:       (e.g. Linux implementing kqueue), something that the above checks
                   3746:       cannot take into account.</p>
                   3747: <p>Of course, checking for features generally involves more
                   3748:       work on the developer's side, but the resulting changes are
                   3749:       cleaner and there are chances they will work on many other
                   3750:       platforms.  Not to mention that there are higher chances of being
                   3751:       later integrated into the mainstream sources.  Remember:
                   3752:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3753: <p>Some typical examples:</p>
                   3754: <div class="table">
                   3755: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3756: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3757: <colgroup>
                   3758: <col>
                   3759: <col>
                   3760: <col>
                   3761: </colgroup>
                   3762: <thead><tr>
                   3763: <th>Where</th>
                   3764: <th>Incorrect</th>
                   3765: <th>Correct</th>
                   3766: </tr></thead>
                   3767: <tbody>
                   3768: <tr>
                   3769: <td>configure script</td>
                   3770: <td>
1.160     brook    3771: <pre class="programlisting">
1.184     rillig   3772: case ${target_os} in
                   3773: netbsd*) have_kvm=yes ;;
                   3774: *)       have_kvm=no  ;;
                   3775: esac
1.160     brook    3776: </pre>
1.184     rillig   3777:              </td>
                   3778: <td>
1.160     brook    3779: <pre class="programlisting">
1.184     rillig   3780: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160     brook    3781: </pre>
1.184     rillig   3782:              </td>
                   3783: </tr>
                   3784: <tr>
                   3785: <td>C source file</td>
                   3786: <td>
1.1       dsieger  3787: <pre class="programlisting">
1.184     rillig   3788: #if defined(__NetBSD__)
                   3789: #  include &lt;sys/event.h&gt;
                   3790: #endif
1.1       dsieger  3791: </pre>
1.184     rillig   3792:              </td>
                   3793: <td>
1.1       dsieger  3794: <pre class="programlisting">
1.184     rillig   3795: #if defined(HAVE_SYS_EVENT_H)
                   3796: #  include &lt;sys/event.h&gt;
                   3797: #endif
1.1       dsieger  3798: </pre>
1.184     rillig   3799:              </td>
                   3800: </tr>
                   3801: <tr>
                   3802: <td>C source file</td>
                   3803: <td>
1.1       dsieger  3804: <pre class="programlisting">
1.184     rillig   3805: int
                   3806: monitor_file(...)
                   3807: {
                   3808: #if defined(__NetBSD__)
                   3809:         int fd = kqueue();
                   3810:         ...
                   3811: #else
                   3812:         ...
                   3813: #endif
                   3814: }
1.1       dsieger  3815: </pre>
1.184     rillig   3816:              </td>
                   3817: <td>
1.1       dsieger  3818: <pre class="programlisting">
1.184     rillig   3819: int
                   3820: monitor_file(...)
                   3821: {
                   3822: #if defined(HAVE_KQUEUE)
                   3823:         int fd = kqueue();
                   3824:         ...
                   3825: #else
                   3826:         ...
                   3827: #endif
                   3828: }
1.1       dsieger  3829: </pre>
1.184     rillig   3830:              </td>
                   3831: </tr>
                   3832: </tbody>
                   3833: </table></div>
                   3834: </div>
                   3835: <br class="table-break">
                   3836: </div>
                   3837: <div class="sect2">
                   3838: <div class="titlepage"><div><div><h3 class="title">
                   3839: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3840: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3841:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3842:       improvements you do to a package to the mainstream developers.
                   3843:       This is the only way to get their attention on portability issues
                   3844:       and to ensure that future versions can be built out-of-the box on
                   3845:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3846:       the fixes straight from the packaged code.</p>
                   3847: <p>This generally involves cleaning up the patches
                   3848:       (because sometimes the patches that are
                   3849:       added to pkgsrc are quick hacks), filing bug reports in the
                   3850:       appropriate trackers for the projects and working with the
                   3851:       mainstream authors to accept your changes.  It is
                   3852:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3853:       the packages in pkgsrc are kept simple and thus further changes
                   3854:       can be done without much hassle.</p>
                   3855: <p>When you have done this, please add a URL to the upstream
                   3856:       bug report to the patch comment.</p>
                   3857: <p>Support the idea of free software!</p>
                   3858: </div>
1.1       dsieger  3859: </div>
1.184     rillig   3860: <div class="sect1">
                   3861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3862: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3863: <div class="variablelist"><dl class="variablelist">
                   3864: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3865: <dd><p>A multi-line description of the piece of software.  This should include
                   3866:          any credits where they are due.  Please bear in mind that others do not
                   3867:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3868:          will read everything that you write here.</p></dd>
                   3869: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3870: <dd><p>This file governs the files that are installed on your
                   3871:          system: all the binaries, manual pages, etc. There are other
                   3872:          directives which may be entered in this file, to control the
                   3873:          creation and deletion of directories, and the location of
                   3874:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3875:          information.</p></dd>
                   3876: </dl></div>
                   3877: </div>
                   3878: <div class="sect1">
                   3879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3880: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3881: <div class="sect2">
                   3882: <div class="titlepage"><div><div><h3 class="title">
                   3883: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3884: <div class="variablelist"><dl class="variablelist">
                   3885: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3886: <dd>
1.207     leot     3887: <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.184     rillig   3888:            First time after package extraction and before files are
                   3889:            moved in place, the second time after the files to install
                   3890:            are moved in place. This can be used to do any custom
                   3891:            procedures not possible with @exec commands in
1.207     leot     3892:            <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
                   3893:            <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.184     rillig   3894:            Please note that you can modify variables in it easily by using
                   3895:            <code class="varname">FILES_SUBST</code> in the package's
                   3896:            <code class="filename">Makefile</code>:</p>
1.1       dsieger  3897: <pre class="programlisting">
1.184     rillig   3898: FILES_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3899: </pre>
1.184     rillig   3900: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3901:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3902:            performed for <code class="varname">PREFIX</code>,
                   3903:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3904:            <code class="varname">VARBASE</code>, and a few others, type
                   3905:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3906:            complete list.</p>
                   3907: </dd>
                   3908: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3909: <dd><p>This script is executed before and after any files are removed.  It is
                   3910:            this script's responsibility to clean up any additional messy details
                   3911:            around the package's installation, since all pkg_delete knows is how to
                   3912:            delete the files created in the original distribution.
1.207     leot     3913:            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>
                   3914:            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.184     rillig   3915:            The same methods to replace variables can be used as for
                   3916:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3917: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3918: <dd>
                   3919: <p>This file is displayed after installation of the package.
1.198     leot     3920:            While this was used often in the past, it has two
                   3921:            problems: the display will be missed if many packages are
                   3922:            intalled at once, and the person installing the package
                   3923:            and the one using or configuring it may be different.  It
                   3924:            should therefore be used only in exceptional circumstances
                   3925:            where lasting negative consequences would result from
                   3926:            someone not reading it.</p>
                   3927: <p>MESSAGE should not be used for:</p>
                   3928: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3929: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   3930: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   3931: <li class="listitem"><p>anything that should be explained in the
                   3932:              installation/configuration documentation that should
                   3933:              come with the package</p></li>
                   3934: </ul></div>
                   3935: <p>If the documentation provided by upstream needs
                   3936:            enhancing, create e.g. files/README.pkgsrc and install it
                   3937:            in the package's documentation directory.
                   3938:            </p>
                   3939: <p>Note that MESSAGE is shown for all operating
                   3940:            systems and all init systems.  If a MESSAGE is necessary,
                   3941:            it should be narrowed to only those operating systems and
                   3942:            init systems to which it applies.</p>
                   3943: <p>Note that you can modify variables in it easily by using
1.184     rillig   3944:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3945:            <code class="filename">Makefile</code>:</p>
1.1       dsieger  3946: <pre class="programlisting">
1.184     rillig   3947: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3948: </pre>
1.184     rillig   3949: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3950:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3951:            performed for <code class="varname">PKGNAME</code>,
                   3952:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3953:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3954:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3955:            <code class="varname">ROOT_GROUP</code>, and
                   3956:            <code class="varname">ROOT_USER</code>.</p>
                   3957: <p>You can display a different or additional files by
                   3958:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3959:            default is <code class="filename">MESSAGE</code>, if the file
                   3960:            exists.</p>
                   3961: </dd>
                   3962: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3963: <dd>
                   3964: <p>This file is used by the alternatives framework.
                   3965:            It creates, configures, and destroys generic wrappers used to
                   3966:            run programs with similar interfaces.
                   3967:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3968:             for more information.</p>
                   3969: <p>Each line of the file contains two filenames, first
                   3970:            the wrapper and then the alternative provided by the package.
                   3971:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3972: </dd>
                   3973: </dl></div>
                   3974: </div>
                   3975: <div class="sect2">
                   3976: <div class="titlepage"><div><div><h3 class="title">
                   3977: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3978: <div class="variablelist"><dl class="variablelist">
                   3979: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3980: <dd><p>This file contains arbitrary things that could
                   3981:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3982:        to be used by more than one package. This file should only be
                   3983:        used when the packages that will use the file are known in
                   3984:        advance. For other purposes it is often better to write a
                   3985:        <code class="filename">*.mk</code> file and give it a good name that
                   3986:        describes what it does.</p></dd>
                   3987: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3988: <dd><p>This file contains the dependency information
                   3989:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3990: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3991: <dd><p>This file contains workarounds for compiler bugs
                   3992:        and similar things. It is included automatically by the pkgsrc
                   3993:        infrastructure, so you don't need an extra
                   3994:        <code class="literal">.include</code> line for
                   3995:        it.</p></dd>
                   3996: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3997: <dd><p>This file contains the code for the
                   3998:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3999:        selected by the user. If a package has only one or two options,
                   4000:        it is equally acceptable to put the code directly into the
                   4001:        <code class="filename">Makefile</code>.</p></dd>
                   4002: </dl></div>
                   4003: </div>
                   4004: <div class="sect2">
                   4005: <div class="titlepage"><div><div><h3 class="title">
                   4006: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   4007: <div class="variablelist"><dl class="variablelist">
                   4008: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4009: <dd><p>These files do not take place in the creation of
                   4010:        a package and thus are purely informative to the package
                   4011:        developer.</p></dd>
                   4012: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4013: <dd><p>This file contains things that need to be done
                   4014:        to make the package even
                   4015:        better.</p></dd>
                   4016: </dl></div>
                   4017: </div>
                   4018: </div>
                   4019: <div class="sect1">
                   4020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4021: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   4022: </h2></div></div></div>
                   4023: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4024:     unpacked into the directory denoted by
                   4025:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4026:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4027:     directory is also used to keep various timestamp files.
                   4028:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4029:     The default is <code class="filename">${.CURDIR}/work</code>
                   4030:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4031:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.1       dsieger  4032: </div>
1.184     rillig   4033: <div class="sect1">
                   4034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4035: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   4036: </h2></div></div></div>
                   4037: <p>If you have any files that you wish to be placed in the package
                   4038:     prior to configuration or building, you can place these files here
                   4039:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4040:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   4041: <p>If you want to share files in this way with other
                   4042:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4043:     to the other package's <code class="filename">files</code> directory,
                   4044:     e.g.:</p>
1.1       dsieger  4045: <pre class="programlisting">
1.184     rillig   4046: FILESDIR=       ../../editors/xemacs/files
1.1       dsieger  4047: </pre>
                   4048: </div>
                   4049: </div>
1.41      asau     4050: <div class="chapter">
1.1       dsieger  4051: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   4052: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1       dsieger  4053: <div class="toc">
                   4054: <p><b>Table of Contents</b></p>
1.100     leot     4055: <dl class="toc">
1.184     rillig   4056: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4057: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4058: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4059: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4060: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4061: <dd><dl>
                   4062: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4063: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4064: </dl></dd>
                   4065: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4066: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4067: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4068: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4069: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4070: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4071: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4072: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4073: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4074: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4075: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4076: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1       dsieger  4077: </dl>
                   4078: </div>
1.41      asau     4079: <div class="sect1">
1.1       dsieger  4080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4081: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4082: <p>This chapter gives a detailed description on how a package is
                   4083:     built. Building a package is separated into different
                   4084:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4085:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4086:     described in the following sections. Each phase is split into
                   4087:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4088:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4089:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4090:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4091:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4092: <p>Never override the regular targets (like
                   4093:     <code class="varname">fetch</code>), if you have to, override the
                   4094:     <code class="varname">do-*</code> ones instead.</p>
                   4095: <p>The basic steps for building a program are always the same.  First
                   4096:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4097:     the local system and then extracted. After any pkgsrc-specific patches
                   4098:     to compile properly are applied, the software can be configured, then
                   4099:     built (usually by compiling), and finally the generated binaries, etc.
                   4100:     can be put into place on the system.</p>
                   4101: <p>To get more details about what is happening at each step,
                   4102:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4103:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4104:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4105: </div>
                   4106: <div class="sect1">
                   4107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4108: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4109: <p>Before outlining the process performed by the NetBSD package system in
                   4110:     the next section, here's a brief discussion on where programs are
                   4111:     installed, and which variables influence this.</p>
                   4112: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4113:     where all files of the final program shall be installed. It is
                   4114:     usually set to <code class="varname">LOCALBASE</code>
                   4115:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4116:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4117:     <code class="varname">PREFIX</code> needs to be put
                   4118:     into the various places in the program's source where paths to
                   4119:     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>
                   4120: <p>When choosing which of these variables to use,
                   4121:     follow the following rules:</p>
1.41      asau     4122: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184     rillig   4123: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4124:        where the current pkg will be installed.  When referring to a
                   4125:        pkg's own installation path, use
                   4126:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
1.223     nia      4127: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184     rillig   4128:        are installed.  If you need to construct a -I or -L argument
                   4129:        to the compiler to find includes and libraries installed by
1.223     nia      4130:        another pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.184     rillig   4131:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4132:        installed all packages in <code class="filename">/usr/local</code>. As
                   4133:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4134:        administrator, this variable is a misnomer.</p></li>
                   4135: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4136:        distribution (from xsrc, etc.) is installed. When looking for
                   4137:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4138:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4139: <li class="listitem"><p>X11-based packages using imake must set
                   4140:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4141:        <code class="varname">LOCALBASE</code>.</p></li>
                   4142: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.207     leot     4143:        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.184     rillig   4144:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4145:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4146: </ul></div>
                   4147: </div>
                   4148: <div class="sect1">
                   4149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4150: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4151: <p>When building a package, various directories are used to store
                   4152:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4153:     directories are explained here.</p>
                   4154: <p>Some of the directory variables contain relative pathnames. There
                   4155:     are two common base directories for these relative directories:
                   4156:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4157:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4158:     inside the package itself.</p>
                   4159: <div class="variablelist"><dl class="variablelist">
                   4160: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4161: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4162:       root directory. Generally, you don't need
                   4163:       it.</p></dd>
                   4164: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4165: <dd><p>This is an absolute pathname that points to the
                   4166:       current package.</p></dd>
                   4167: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4168: <dd><p>This is a pathname relative to
                   4169:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4170:       package.</p></dd>
                   4171: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4172: <dd><p>This is an absolute pathname pointing to the directory
                   4173:       where all work takes place. The distfiles are extracted to this
                   4174:       directory. It also contains temporary directories and log files used by
                   4175:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4176:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4177: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4178: <dd><p>This is an absolute pathname pointing to the directory
                   4179:       where the distfiles are extracted. It is usually a direct subdirectory
                   4180:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4181:       that isn't hidden. This variable may be changed by a package
                   4182:       <code class="filename">Makefile</code>.</p></dd>
                   4183: </dl></div>
                   4184: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4185:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4186:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4187:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4188:     If users would like to have their pkgsrc trees behave in a
                   4189:     read-only manner, then the value of
                   4190:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4191:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  4192: </div>
1.41      asau     4193: <div class="sect1">
1.1       dsieger  4194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4195: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4196: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4197:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4198:     phase. This will automatically run all phases that are required for this
                   4199:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4200:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4201:     the package will be built, but not installed.</p>
1.1       dsieger  4202: </div>
1.41      asau     4203: <div class="sect1">
1.1       dsieger  4204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4205: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4206: <p>The first step in building a package is to fetch the
                   4207:     distribution files (distfiles) from the sites that are providing
                   4208:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4209:     phase.</p>
1.41      asau     4210: <div class="sect2">
1.1       dsieger  4211: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   4212: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4213: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4214:       defines all URLs from where the distfile, whose name is
                   4215:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4216:       fetched. The more complicated cases are described
                   4217:       below.</p>
                   4218: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4219:       the list of distfiles that have to be fetched. Its value
                   4220:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4221:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4222:       so that most packages don't need to define it at all.
                   4223:       <code class="varname">EXTRACT_SUFX</code> is
                   4224:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4225:       freely. Note that if your package requires additional
                   4226:       distfiles to the default one, you cannot just append the
                   4227:       additional filenames using the <code class="literal">+=</code>
                   4228:       operator, but you have write for example:</p>
                   4229: <pre class="programlisting">
                   4230: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4231: </pre>
                   4232: <p>Each distfile is fetched from a list of sites, usually
                   4233:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4234:       <code class="varname">DISTFILES</code> or multiple
                   4235:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4236:       set
                   4237:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4238:       to the list of URLs where the file
                   4239:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4240:       (including the suffix) can be found.</p>
                   4241: <pre class="programlisting">
                   4242: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4243: DISTFILES+=     foo-file.tar.gz
                   4244: SITES.foo-file.tar.gz= \
                   4245: https://www.somewhere.com/somehow/ \
                   4246: https://www.somewhereelse.com/mirror/somehow/
                   4247: </pre>
                   4248: <p>When actually fetching the distfiles, each item from
                   4249:       <code class="varname">MASTER_SITES</code> or
                   4250:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4251:       appended to it, without an intermediate slash. Therefore,
                   4252:       all site values have to end with a slash or other separator
                   4253:       character. This allows for example to set
                   4254:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4255:       that gets the name of the distfile as a parameter. In this
                   4256:       case, the definition would look like:</p>
                   4257: <pre class="programlisting">
                   4258: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4259: </pre>
                   4260: <p> The exception to this rule are URLs starting with a dash.
                   4261:       In that case the URL is taken as is, fetched and the result
                   4262:       stored under the name of the distfile. You can use this style
                   4263:       for the case when the download URL style does not match the
                   4264:       above common case. For example, if permanent download URL is a
                   4265:       redirector to the real download URL, or the download file name
                   4266:       is offered by an HTTP Content-Disposition header. In the
                   4267:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4268:       created instead of the default
                   4269:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4270: <pre class="programlisting">
                   4271: DISTNAME=       foo-1.0.0
                   4272: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4273: </pre>
                   4274: <p>There are some predefined values for
                   4275:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4276:       packages.  The names of the variables should speak for
                   4277:       themselves.</p>
                   4278: <table border="0" summary="Simple list" class="simplelist">
                   4279: <tr>
                   4280: <td>MASTER_SITE_APACHE</td>
                   4281: <td>MASTER_SITE_BACKUP</td>
                   4282: </tr>
                   4283: <tr>
                   4284: <td>MASTER_SITE_CRATESIO</td>
                   4285: <td>MASTER_SITE_CYGWIN</td>
                   4286: </tr>
                   4287: <tr>
                   4288: <td>MASTER_SITE_DEBIAN</td>
                   4289: <td>MASTER_SITE_FREEBSD</td>
                   4290: </tr>
                   4291: <tr>
                   4292: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4293: <td>MASTER_SITE_GENTOO</td>
                   4294: </tr>
                   4295: <tr>
                   4296: <td>MASTER_SITE_GITHUB</td>
1.225     gutterid 4297: <td>MASTER_SITE_GITLAB</td>
                   4298: </tr>
                   4299: <tr>
1.184     rillig   4300: <td>MASTER_SITE_GNOME</td>
1.225     gutterid 4301: <td>MASTER_SITE_GNU</td>
1.184     rillig   4302: </tr>
                   4303: <tr>
                   4304: <td>MASTER_SITE_GNUSTEP</td>
1.225     gutterid 4305: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184     rillig   4306: </tr>
                   4307: <tr>
                   4308: <td>MASTER_SITE_IFARCHIVE</td>
1.225     gutterid 4309: <td>MASTER_SITE_KDE</td>
1.184     rillig   4310: </tr>
                   4311: <tr>
                   4312: <td>MASTER_SITE_MOZILLA</td>
1.225     gutterid 4313: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184     rillig   4314: </tr>
                   4315: <tr>
                   4316: <td>MASTER_SITE_MYSQL</td>
1.225     gutterid 4317: <td>MASTER_SITE_NETLIB</td>
1.184     rillig   4318: </tr>
                   4319: <tr>
                   4320: <td>MASTER_SITE_OPENBSD</td>
1.225     gutterid 4321: <td>MASTER_SITE_OPENOFFICE</td>
1.184     rillig   4322: </tr>
                   4323: <tr>
                   4324: <td>MASTER_SITE_OSDN</td>
1.225     gutterid 4325: <td>MASTER_SITE_PERL_CPAN</td>
1.184     rillig   4326: </tr>
                   4327: <tr>
                   4328: <td>MASTER_SITE_PGSQL</td>
1.225     gutterid 4329: <td>MASTER_SITE_PYPI</td>
1.184     rillig   4330: </tr>
                   4331: <tr>
                   4332: <td>MASTER_SITE_RUBYGEMS</td>
1.225     gutterid 4333: <td>MASTER_SITE_R_CRAN</td>
1.184     rillig   4334: </tr>
                   4335: <tr>
                   4336: <td>MASTER_SITE_SOURCEFORGE</td>
1.225     gutterid 4337: <td>MASTER_SITE_SUNSITE</td>
1.184     rillig   4338: </tr>
1.1       dsieger  4339: <tr>
1.184     rillig   4340: <td>MASTER_SITE_SUSE</td>
1.225     gutterid 4341: <td>MASTER_SITE_TEX_CTAN</td>
1.1       dsieger  4342: </tr>
                   4343: <tr>
1.184     rillig   4344: <td>MASTER_SITE_XCONTRIB</td>
1.225     gutterid 4345: <td>MASTER_SITE_XEMACS</td>
1.1       dsieger  4346: </tr>
                   4347: <tr>
1.184     rillig   4348: <td>MASTER_SITE_XORG</td>
1.225     gutterid 4349: <td> </td>
1.184     rillig   4350: </tr>
                   4351: </table>
                   4352: <p>Some explanations for the less self-explaining ones:
                   4353:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4354:       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
                   4355:       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>
                   4356: <p>If you choose one of these predefined sites, you may
                   4357:       want to specify a subdirectory of that site. Since these
                   4358:       macros may expand to more than one actual site, you
                   4359:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4360:       specify a subdirectory:</p>
1.1       dsieger  4361: <pre class="programlisting">
1.184     rillig   4362: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4363: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1       dsieger  4364: </pre>
1.184     rillig   4365: <p>Note the trailing slash after the subdirectory
                   4366:       name.</p>
                   4367: </div>
                   4368: <div class="sect2">
                   4369: <div class="titlepage"><div><div><h3 class="title">
                   4370: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4371: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4372:       all the distfiles exist in a local directory
                   4373:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4374:       user). If the files do not exist, they are fetched using
                   4375:       commands of the form</p>
1.1       dsieger  4376: <pre class="programlisting">
1.184     rillig   4377: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4378: </pre>
                   4379: <p>where <code class="literal">${site}</code> varies through
                   4380:       several possibilities in turn: first,
                   4381:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4382:       sites specified in either <code class="varname">SITES.file</code> if
                   4383:       defined, else <code class="varname">MASTER_SITES</code> or
                   4384:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4385:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4386:       all except the first and the last can be optionally sorted
                   4387:       by the user, via setting either
                   4388:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4389:       <code class="varname">MASTER_SORT_AWK</code> or
                   4390:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4391: <p> The specific command and arguments used depend on the
                   4392:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4393:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4394: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4395:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4396:       distfiles, if they are freely distributable.  Packages setting
                   4397:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4398:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4399:       mirrored.</p>
1.1       dsieger  4400: </div>
                   4401: </div>
1.184     rillig   4402: <div class="sect1">
                   4403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4404: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4405: <p>After the distfile(s) are fetched, their checksum is
                   4406:     generated and compared with the checksums stored in the
                   4407:     distinfo file. If the checksums don't match, the build is
                   4408:     aborted. This is to ensure the same distfile is used for
                   4409:     building, and that the distfile wasn't changed, e.g. by some
                   4410:     malign force, deliberately changed distfiles on the master
                   4411:     distribution site or network lossage.</p>
1.1       dsieger  4412: </div>
1.41      asau     4413: <div class="sect1">
1.1       dsieger  4414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4415: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4416: <p>When the distfiles are present on the local system, they
                   4417:     need to be extracted, as they usually come in the form of some
                   4418:     compressed archive format.</p>
                   4419: <p>By default, all <code class="varname">DISTFILES</code> are
                   4420:     extracted. If you only need some of them, you can set the
                   4421:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4422:     files.</p>
                   4423: <p>Extracting the files is usually done by a little
                   4424:     program, <code class="filename">mk/extract/extract</code>, which
                   4425:     already knows how to extract various archive formats, so most
                   4426:     likely you will not need to change anything here. But if you
                   4427:     need, the following variables may help you:</p>
1.41      asau     4428: <div class="variablelist"><dl class="variablelist">
1.184     rillig   4429: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4430: <dd><p>Use these variables to override the default
                   4431:       options for an extract command, which are defined in
                   4432:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4433: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4434: <dd><p>This variable can be set to
                   4435:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4436:       (which is the default value), <code class="literal">pax</code>, or an
                   4437:       absolute pathname pointing to the command with which tar
                   4438:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4439:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  4440: </dl></div>
1.184     rillig   4441: <p>If the <code class="filename">extract</code> program doesn't
                   4442:     serve your needs, you can also override the
                   4443:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4444:     command used for extracting the files. This command is
                   4445:     executed in the <code class="filename">${WRKSRC}</code>
                   4446:     directory. During execution of this command, the shell
                   4447:     variable <code class="varname">extract_file</code> holds the absolute
                   4448:     pathname of the file that is going to be extracted.</p>
                   4449: <p>And if that still does not suffice, you can override the
                   4450:     <code class="varname">do-extract</code> target in the package
                   4451:     Makefile.</p>
1.1       dsieger  4452: </div>
1.41      asau     4453: <div class="sect1">
1.1       dsieger  4454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4455: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4456: <p>After extraction, all the patches named by the
                   4457:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4458:     subdirectory of the package as well as in
                   4459:     $LOCALPATCHES/$PKGPATH (e.g.
                   4460:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4461:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4462:     <code class="filename">.gz</code> are uncompressed before they are
                   4463:     applied, files ending in <code class="filename">.orig</code> or
                   4464:     <code class="filename">.rej</code> are ignored. Any special options to
1.207     leot     4465:     <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.184     rillig   4466:     <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.207     leot     4467: <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.184     rillig   4468:     fail if the expected text from the patch context is not found in the
                   4469:     patched file. If that happens, fix the patch file by comparing it
                   4470:     with the actual text in the file to be patched.</p>
1.1       dsieger  4471: </div>
1.41      asau     4472: <div class="sect1">
1.1       dsieger  4473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4474: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4475: <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>.
                   4476:     </p>
1.1       dsieger  4477: </div>
1.41      asau     4478: <div class="sect1">
1.1       dsieger  4479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4480: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4481: <p>This phase creates wrapper programs for the compilers and
                   4482:     linkers. The following variables can be used to tweak the
                   4483:     wrappers.</p>
                   4484: <div class="variablelist"><dl class="variablelist">
                   4485: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4486: <dd><p>The command used to print progress
                   4487:       messages. Does nothing by default. Set to
                   4488:       <code class="literal">${ECHO}</code> to see the progress
                   4489:       messages.</p></dd>
                   4490: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4491: <dd><p>This variable can be set to
                   4492:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4493:       depending on whether you want additional information in the
                   4494:       wrapper log file.</p></dd>
                   4495: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4496: <dd><p>This variable can be set to
                   4497:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4498:       on whether the wrapper should use its cache, which will
                   4499:       improve the speed. The default value is
                   4500:       <code class="literal">yes</code>, but is forced to
                   4501:       <code class="literal">no</code> if the platform does not support
                   4502:       it.</p></dd>
                   4503: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4504: <dd><p>A list of reordering commands. A reordering
                   4505:       command has the form
                   4506:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4507:       It ensures that that
                   4508:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4509:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4510:       </p></dd>
                   4511: </dl></div>
                   4512: </div>
                   4513: <div class="sect1">
                   4514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4515: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4516: <p>Most pieces of software need information on the header
                   4517:     files, system calls, and library routines which are available
                   4518:     on the platform they run on. The process of determining this
                   4519:     information is known as configuration, and is usually
                   4520:     automated. In most cases, a script is supplied with the
                   4521:     distfiles, and its invocation results in generation of header
                   4522:     files, Makefiles, etc.</p>
                   4523: <p>If the package contains a configure script, this can be
                   4524:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4525:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4526:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187     rillig   4527:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4528: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4529:     equivalent of the following command is run. See
                   4530:     <code class="filename">mk/configure/configure.mk</code>, target
                   4531:     <code class="literal">do-configure-script</code> for the exact
                   4532:     definition.</p>
                   4533: <pre class="programlisting">
                   4534: .for dir in ${CONFIGURE_DIRS}
                   4535:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4536:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4537:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184     rillig   4538: .endfor
1.1       dsieger  4539: </pre>
1.184     rillig   4540: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4541:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4542:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4543:     configure script is run with the environment
                   4544:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4545:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4546:     <code class="varname">CONFIGURE_ENV</code>,
                   4547:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4548:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4549:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4550:     package.</p>
                   4551: <p>If the program uses the Perl way of configuration (mainly Perl
                   4552:     modules, but not only), i.e. a file called
                   4553:     <code class="filename">Makefile.PL</code>, it should include
                   4554:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4555:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4556:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4557: <p>If the program uses an <code class="filename">Imakefile</code>
                   4558:     for configuration, the appropriate steps can be invoked by
                   4559:     setting <code class="varname">USE_IMAKE</code> to
                   4560:     <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>.
                   4561:     You can add variables to xmkmf's environment by adding them to the
                   4562:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4563: <p>If the program uses <code class="filename">cmake</code>
                   4564:     for configuration, the appropriate steps can be invoked by
                   4565:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4566:     You can add variables to cmake's environment by adding them to the
                   4567:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4568:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4569:     The top directory argument is given by the
                   4570:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4571:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4572: <p>If there is no configure step at all, set
                   4573:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  4574: </div>
1.41      asau     4575: <div class="sect1">
1.1       dsieger  4576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4577: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187     rillig   4578: <p>For building a package, a rough equivalent of the following
                   4579:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4580:     <code class="literal">do-build</code> for the exact definition.</p>
1.1       dsieger  4581: <pre class="programlisting">
1.187     rillig   4582: .for dir in ${BUILD_DIRS}
                   4583:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.184     rillig   4584:         &amp;&amp; env ${MAKE_ENV} \
1.187     rillig   4585:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184     rillig   4586:                 -f ${MAKE_FILE} \
                   4587:                 ${BUILD_TARGET}
                   4588: .endfor
1.1       dsieger  4589: </pre>
1.184     rillig   4590: <p><code class="varname">BUILD_DIRS</code> (default:
                   4591:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4592:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4593:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4594:     <code class="varname">MAKE_ENV</code> and arguments
                   4595:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4596:     <code class="varname">MAKE_ENV</code>,
                   4597:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4598:     <code class="varname">MAKE_FILE</code> and
                   4599:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4600:     package.</p>
                   4601: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4602:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4603:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4604:     default value of <code class="varname">MAKE_FILE</code> is
                   4605:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4606:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4607: <p>If there is no build step at all, set
                   4608:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  4609: </div>
1.41      asau     4610: <div class="sect1">
1.1       dsieger  4611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4612: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4613: <p>[TODO]</p>
1.1       dsieger  4614: </div>
1.41      asau     4615: <div class="sect1">
1.1       dsieger  4616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4617: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4618: <p>Once the build stage has completed, the final step is to
                   4619:     install the software in public directories, so users can
                   4620:     access the programs and files.</p>
1.187     rillig   4621: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4622:     of the following code is executed; see
                   4623:     <code class="filename">mk/install/install.mk</code>, target
                   4624:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4625:     before and after this code, several consistency checks are run
                   4626:     against the files-to-be-installed, see
                   4627:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4628: <pre class="programlisting">
                   4629: .for dir in ${INSTALL_DIRS}
                   4630:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4631:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4632:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4633:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184     rillig   4634: .endfor
1.1       dsieger  4635: </pre>
1.184     rillig   4636: <p>The variable's meanings are analogous to the ones in the
                   4637:     <span class="emphasis"><em>build</em></span> phase.
                   4638:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4639:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4640:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4641:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4642:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4643:     defined.</p>
                   4644: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4645:     variables are useful. They are all variations of the
1.207     leot     4646:     <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.184     rillig   4647:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4648:     install command. The specialized variants, together with their
                   4649:     intended use, are:</p>
                   4650: <div class="variablelist"><dl class="variablelist">
                   4651: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4652: <dd><p>directories that contain
                   4653:       binaries</p></dd>
                   4654: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4655: <dd><p>directories that contain
                   4656:       scripts</p></dd>
                   4657: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4658: <dd><p>directories that contain shared and static
                   4659:       libraries</p></dd>
                   4660: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4661: <dd><p>directories that contain data
                   4662:       files</p></dd>
                   4663: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4664: <dd><p>directories that contain man
                   4665:       pages</p></dd>
                   4666: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4667: <dd><p>directories that contain data files for games
                   4668:       </p></dd>
                   4669: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4670: <dd><p>binaries that can be stripped from debugging
                   4671:       symbols</p></dd>
                   4672: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4673: <dd><p>binaries that cannot be
                   4674:       stripped</p></dd>
                   4675: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4676: <dd><p>game
                   4677:       binaries</p></dd>
                   4678: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4679: <dd><p>shared and static
                   4680:       libraries</p></dd>
                   4681: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4682: <dd><p>data files</p></dd>
                   4683: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4684: <dd><p>data files for
                   4685:       games</p></dd>
                   4686: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4687: <dd><p>man pages</p></dd>
                   4688: </dl></div>
                   4689: <p>Some other variables are:</p>
                   4690: <div class="variablelist"><dl class="variablelist">
                   4691: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.207     leot     4692: <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.184     rillig   4693:       when installing binaries. Any debugging sections and symbols present in
                   4694:       binaries will be preserved.
                   4695:       </p></dd>
                   4696: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4697: <dd><p>A list of directories relative to
                   4698:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4699:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4700:       The package is supposed to create all needed directories itself
                   4701:       before installing files to it and list all other directories here.
                   4702:       </p></dd>
                   4703: </dl></div>
                   4704: <p>In the rare cases that a package shouldn't install anything,
                   4705:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4706:     mostly relevant for packages in the <code class="filename">regress</code>
                   4707:     category.</p>
1.1       dsieger  4708: </div>
1.41      asau     4709: <div class="sect1">
1.1       dsieger  4710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4711: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4712: <p>Once the install stage has completed, a binary package of
                   4713:     the installed files can be built.  These binary packages can be
                   4714:     used for quick installation without previous compilation, e.g. by
                   4715:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4716:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4717: <p>By default, the binary packages are created in
                   4718:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4719:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4720:     one for each category in the <code class="varname">CATEGORIES</code>
                   4721:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4722:     <code class="filename">pkgsrc/packages</code>.</p>
1.1       dsieger  4723: </div>
1.41      asau     4724: <div class="sect1">
1.1       dsieger  4725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4726: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4727: <p>Once you're finished with a package, you can clean the work
                   4728:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4729:     to clean the work directories of all dependencies too, use
                   4730:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  4731: </div>
1.41      asau     4732: <div class="sect1">
1.1       dsieger  4733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4734: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41      asau     4735: <div class="variablelist"><dl class="variablelist">
1.184     rillig   4736: <dt><span class="term">pre/post-*</span></dt>
                   4737: <dd>
                   4738: <p>For any of the main targets described in the previous
                   4739:          section (configure, build, install, etc.), two auxiliary
                   4740:          targets exist with
                   4741:          <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
                   4742:          prefix for the main target's name.  These targets are
                   4743:          invoked before and after the main target is called,
                   4744:          allowing extra configuration or installation steps be
                   4745:          performed from a package's Makefile, for example, which
                   4746:          a program's configure script or install target
                   4747:          omitted.</p>
                   4748: <p>About 5% of the pkgsrc packages define their custom
                   4749:          post-extract target, another 5% define pre-configure, and 10%
                   4750:          define post-install. The other pre/post-* targets are defined
                   4751:          even less often.</p>
                   4752: </dd>
                   4753: <dt><span class="term">do-*</span></dt>
1.1       dsieger  4754: <dd>
1.184     rillig   4755: <p>Should one of the main targets do the wrong thing,
                   4756:          and should there be no variable to fix this, you can
                   4757:          redefine it with the do-* target.  (Note that redefining
                   4758:          the target itself instead of the do-* target is a bad
                   4759:          idea, as the pre-* and post-* targets won't be called
                   4760:          anymore, etc.)</p>
                   4761: <p>About 15% of the pkgsrc packages override the default
                   4762:          do-install, the other do-* targets are overridden even less
                   4763:          often.</p>
1.1       dsieger  4764: </dd>
1.184     rillig   4765: <dt><span class="term">reinstall</span></dt>
1.1       dsieger  4766: <dd>
1.184     rillig   4767: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4768:          you noticed some file was not installed properly, you
                   4769:          can repeat the installation with this target, which will
                   4770:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4771: <p>This is the default value of
                   4772:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4773:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4774:          package</strong></span>, where the defaults are
                   4775:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4776:          respectively.</p>
1.1       dsieger  4777: </dd>
1.184     rillig   4778: <dt><span class="term">deinstall</span></dt>
                   4779: <dd>
1.207     leot     4780: <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.184     rillig   4781:          current directory, effectively de-installing the
                   4782:          package. The following variables can be used to tune the
                   4783:          behaviour:</p>
                   4784: <div class="variablelist"><dl class="variablelist">
                   4785: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.207     leot     4786: <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.184     rillig   4787: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4788: <dd><p>Remove all packages that require (depend on)
                   4789:                the given package.  This can be used to remove any
                   4790:                packages that may have been pulled in by a given
                   4791:                package, e.g. if <span class="command"><strong>make deinstall
                   4792:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4793:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4794:                likely to remove whole KDE. Works by adding
1.207     leot     4795:                <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.184     rillig   4796:                command line.</p></dd>
                   4797: </dl></div>
                   4798: </dd>
                   4799: <dt><span class="term">bin-install</span></dt>
                   4800: <dd><p>Install a binary package from local disk and via FTP
                   4801:          from a list of sites (see the
                   4802:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4803:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4804:          available anywhere.  The arguments given to
                   4805:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4806:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4807:          operation, etc.</p></dd>
                   4808: <dt><span class="term">install-clean</span></dt>
                   4809: <dd><p>This target removes the state files for the "install" and later
                   4810:          phases so that the "install" target may be re-invoked. This can be
                   4811:          used after editing the PLIST to install the package without
                   4812:          rebuilding it.</p></dd>
                   4813: <dt><span class="term">build-clean</span></dt>
                   4814: <dd><p>This target removes the state files for the "build" and later
                   4815:          phases so that the "build" target may be re-invoked.</p></dd>
                   4816: <dt><span class="term">update</span></dt>
                   4817: <dd>
                   4818: <p>This target causes the current package to be
                   4819:          updated to the latest version.  The package and all
                   4820:          depending packages first get de-installed, then current
                   4821:          versions of the corresponding packages get compiled and
                   4822:          installed.  This is similar to manually noting which
                   4823:          packages are currently installed, then performing a
                   4824:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4825:          <span class="command"><strong>make install</strong></span> (or whatever
                   4826:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4827:          packages.</p>
                   4828: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4829:          resume package updating in case a previous <span class="command"><strong>make
                   4830:          update</strong></span> was interrupted for some reason.
                   4831:          However, in this case, make sure you don't call
                   4832:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4833:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4834:          Otherwise, you lose the ability to automatically update
                   4835:          the current package along with the dependent packages
                   4836:          you have installed.</p>
                   4837: <p>Resuming an interrupted <span class="command"><strong>make
                   4838:          update</strong></span> will only work as long as the package
                   4839:          tree remains unchanged.  If the source code for one of
                   4840:          the packages to be updated has been changed, resuming
                   4841:          <span class="command"><strong>make update</strong></span> will most certainly
                   4842:          fail!</p>
                   4843: <p>The following variables can be used either on the
                   4844:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4845:          alter the behaviour of <span class="command"><strong>make
                   4846:          update</strong></span>:</p>
                   4847: <div class="variablelist"><dl class="variablelist">
                   4848: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4849: <dd><p>Install target to recursively use for the
                   4850:                updated package and the dependent packages.
                   4851:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4852:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4853:                <span class="command"><strong>make update</strong></span>.  Other good
                   4854:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4855:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4856:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4857:                endless loop!</p></dd>
                   4858: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4859: <dd><p>Don't clean up after updating.  Useful if
                   4860:                you want to leave the work sources of the updated
                   4861:                packages around for inspection or other purposes.
                   4862:                Be sure you eventually clean up the source tree
                   4863:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4864:                or you may run into troubles with old source code
                   4865:                still lying around on your next
                   4866:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4867:                update</strong></span>.</p></dd>
                   4868: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4869: <dd><p>Deinstall each package before installing
                   4870:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4871:                may be necessary if the
                   4872:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4873:                called after interrupting a running <span class="command"><strong>make
                   4874:                update</strong></span>.</p></dd>
                   4875: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4876: <dd><p>Allows you to disable recursion and hardcode
                   4877:                the target for packages.  The default is
                   4878:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4879:                facilitating a recursive update of prerequisite
                   4880:                packages.  Only set
                   4881:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4882:                disable recursive updates. Use
                   4883:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4884:                set a specific target for each package to be
                   4885:                installed during <span class="command"><strong>make update</strong></span>
                   4886:                (see above).</p></dd>
                   4887: </dl></div>
                   4888: </dd>
                   4889: <dt><span class="term">clean-update</span></dt>
                   4890: <dd>
                   4891: <p>Clean the source tree for all packages that would
                   4892:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4893:          from the current directory.  This target should not be
                   4894:          used if the current package (or any of its depending
                   4895:          packages) have already been de-installed (e.g., after
                   4896:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4897:          some packages you intended to update. As a rule of
                   4898:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4899:          the first time you run <span class="command"><strong>make update</strong></span>
                   4900:          and only if you have a dirty package tree (e.g., if you
                   4901:          used <code class="varname">NOCLEAN</code>).</p>
                   4902: <p>If you are unsure about whether your tree is
                   4903:          clean, you can either perform a <span class="command"><strong>make
                   4904:          clean</strong></span> at the top of the tree, or use the
                   4905:          following sequence of commands from the directory of the
                   4906:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4907:          running <span class="command"><strong>make update</strong></span> for the first
                   4908:          time, otherwise you lose all the packages you wanted to
                   4909:          update!):</p>
                   4910: <pre class="screen">
                   4911: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4912: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4913: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4914:          </pre>
                   4915: <p>The following variables can be used either on the
                   4916:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4917:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4918: <div class="variablelist"><dl class="variablelist">
                   4919: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4920: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4921:                reconstruct the list of directories to update for
                   4922:                this package.  Only use this if <span class="command"><strong>make
                   4923:                update</strong></span> successfully installed all
                   4924:                packages you wanted to update.  Normally, this is
                   4925:                done automatically on <span class="command"><strong>make
                   4926:                update</strong></span>, but may have been suppressed by
                   4927:                the <code class="varname">NOCLEAN</code> variable (see
                   4928:                above).</p></dd>
                   4929: </dl></div>
                   4930: </dd>
                   4931: <dt><span class="term">replace</span></dt>
                   4932: <dd>
                   4933: <p>Update the installation of the current package.  This
                   4934:          differs from update in that it does not replace dependent
1.207     leot     4935:          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.184     rillig   4936:          target to work.</p>
                   4937: <p><span class="emphasis"><em>Be careful when using this
                   4938:          target!</em></span> There are no guarantees that dependent
                   4939:          packages will still work, in particular they will most
                   4940:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4941:          library package whose shared library major version changed
                   4942:          between your installed version and the new one.  For this
                   4943:          reason, this target is not officially supported and only
                   4944:          recommended for advanced users.</p>
                   4945: </dd>
                   4946: <dt><span class="term">info</span></dt>
1.207     leot     4947: <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.184     rillig   4948:          package. You can use this to check which version of a
                   4949:          package is installed.</p></dd>
                   4950: <dt><span class="term">index</span></dt>
                   4951: <dd>
                   4952: <p>This is a top-level command, i.e. it should be used in
                   4953:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4954:          database of all packages in the local pkgsrc tree, including
                   4955:          dependencies, comment, maintainer, and some other useful
                   4956:          information.  Individual entries are created by running
                   4957:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4958:          directories.  This index file is saved as
                   4959:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4960:          verbose format by running <span class="command"><strong>make
                   4961:          print-index</strong></span>.  You can search in it with
                   4962:          <span class="command"><strong>make search
                   4963:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4964:          extract a list of all packages that depend on a particular
                   4965:          one by running <span class="command"><strong>make show-deps
                   4966:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4967: <p>Running this command takes a very long time, some
                   4968:          hours even on fast machines!</p>
                   4969: </dd>
                   4970: <dt><span class="term">readme</span></dt>
                   4971: <dd>
                   4972: <p>This target generates a
1.199     nia      4973:          <code class="filename">index.html</code> file, which can be
1.207     leot     4974:          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.184     rillig   4975:          contain references to any packages which are in the
                   4976:          <code class="varname">PACKAGES</code> directory on the local
                   4977:          host. The generated files can be made to refer to URLs
                   4978:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4979:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199     nia      4980:          wanted to generate <code class="filename">index.html</code>
1.184     rillig   4981:          files which pointed to binary packages on the local
                   4982:          machine, in the directory
                   4983:          <code class="filename">/usr/packages</code>, set
                   4984:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4985:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4986:          <code class="varname">${PACKAGES}</code> directory and its
                   4987:          subdirectories will be searched for all the binary
                   4988:          packages.</p>
                   4989: <p>The target can be run at the toplevel or in category
                   4990:          directories, in which case it descends recursively.</p>
                   4991: </dd>
                   4992: <dt><span class="term">readme-all</span></dt>
                   4993: <dd><p>This is a top-level command, run it in
                   4994:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4995:          file <code class="filename">README-all.html</code> which contains a
                   4996:          list of all packages currently available in the NetBSD
                   4997:          Packages Collection, together with the category they belong
                   4998:          to and a short description. This file is compiled from the
1.199     nia      4999:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184     rillig   5000:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   5001:          readme</strong></span>.</p></dd>
                   5002: <dt><span class="term">cdrom-readme</span></dt>
                   5003: <dd><p>This is very much the same as the
                   5004:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   5005:          used when generating a pkgsrc tree to be written to a
                   5006:          CD-ROM.  This target also produces
1.199     nia      5007:          <code class="filename">index.html</code> files, and can be made
1.184     rillig   5008:          to refer to URLs based on
                   5009:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   5010:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   5011: <dt><span class="term">show-distfiles</span></dt>
                   5012: <dd><p>This target shows which distfiles and patchfiles
                   5013:          are needed to build the package
                   5014:          (<code class="varname">ALLFILES</code>, which contains all
                   5015:          <code class="varname">DISTFILES</code> and
                   5016:          <code class="varname">PATCHFILES</code>, but not
                   5017:          <code class="filename">patches/*</code>).</p></dd>
                   5018: <dt><span class="term">show-downlevel</span></dt>
                   5019: <dd><p>This target shows nothing if the package is not
                   5020:          installed. If a version of this package is installed,
                   5021:          but is not the version provided in this version of
                   5022:          pkgsrc, then a warning message is displayed. This target
                   5023:          can be used to show which of your installed packages are
                   5024:          downlevel, and so the old versions can be deleted, and
                   5025:          the current ones added.</p></dd>
                   5026: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5027: <dd><p>This target shows the directory in the pkgsrc
                   5028:          hierarchy from which the package can be built and
                   5029:          installed. This may not be the same directory as the one
                   5030:          from which the package was installed. This target is
                   5031:          intended to be used by people who may wish to upgrade
                   5032:          many packages on a single host, and can be invoked from
                   5033:          the top-level pkgsrc Makefile by using the
                   5034:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   5035: <dt><span class="term">show-installed-depends</span></dt>
                   5036: <dd><p>This target shows which installed packages match
                   5037:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5038:          if out of date dependencies are causing build
                   5039:          problems.</p></dd>
                   5040: <dt><span class="term">print-build-depends-list</span></dt>
                   5041: <dd><p>This target shows the list of packages that the current package
                   5042:            depends on for building.</p></dd>
                   5043: <dt><span class="term">print-run-depends-list</span></dt>
                   5044: <dd><p>This target shows the list of packages that the current package
                   5045:            depends on for running.</p></dd>
                   5046: <dt><span class="term">check-shlibs</span></dt>
                   5047: <dd><p>After a package is installed, check all its
                   5048:          binaries and (on ELF platforms) shared libraries to see
                   5049:          if they find the shared libs they need.  Run by default
                   5050:          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>
                   5051: <dt><span class="term">print-PLIST</span></dt>
                   5052: <dd>
                   5053: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5054:          upgraded pkg, this prints out an attempt to generate a
                   5055:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5056:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5057:          to care for shared libs etc., but it is
                   5058:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5059:          result before putting it into
                   5060:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5061:          diff the output of this command against an already
                   5062:          existing <code class="filename">PLIST</code> file.</p>
1.207     leot     5063: <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.184     rillig   5064:          other methods that don't update file access times, be
                   5065:          sure to add these files manually to your
                   5066:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5067:          -newer</span>&#8221;</span> command used by this target won't catch
                   5068:          them!</p>
                   5069: <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
                   5070:          information on this target.</p>
                   5071: </dd>
                   5072: </dl></div>
                   5073: </div>
                   5074: </div>
                   5075: <div class="chapter">
                   5076: <div class="titlepage"><div><div><h2 class="title">
                   5077: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5078: <div class="toc">
                   5079: <p><b>Table of Contents</b></p>
                   5080: <dl class="toc">
                   5081: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5082: <dd><dl>
1.219     nia      5083: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   5084: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   5085: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184     rillig   5086: </dl></dd>
                   5087: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5088: <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>
                   5089: </dl>
                   5090: </div>
                   5091: <p>When you find a package that is not yet in pkgsrc, you
                   5092: most likely have a URL from where you can download the source
                   5093: code. Starting with this URL, creating a package involves only a
                   5094: few steps.</p>
                   5095: <div class="procedure"><ol class="procedure" type="1">
                   5096: <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
                   5097: enable the basic quality checks.</p></li>
                   5098: <li class="step">
1.207     leot     5099: <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.184     rillig   5100: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5101: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5102: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5103: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5104: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5105: </li>
                   5106: <li class="step">
                   5107: <p>Choose one of the top-level directories as the category in
                   5108: which you want to place your package. You can also create a directory of
1.219     nia      5109: your own (maybe called <code class="filename">local</code>). Change into that
                   5110: category directory:</p>
                   5111: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.184     rillig   5112: </li>
                   5113: <li class="step">
1.219     nia      5114: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
                   5115: argument the URL of the distribution file (in most cases a
                   5116: <code class="filename">.tar.gz</code> file). This will download the distribution
                   5117: file and create the necessary files of the package, based on what's in
                   5118: the distribution file:</p>
1.184     rillig   5119: <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>
                   5120: </li>
                   5121: <li class="step">
                   5122: <p>Examine the extracted files to determine the dependencies of
                   5123: your package. Ideally, this is mentioned in some
                   5124: <code class="filename">README</code> file, but things may differ. For each of
                   5125: these dependencies, look where it exists in pkgsrc, and if there is a
                   5126: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5127: line to your package <code class="filename">Makefile</code> which includes that
                   5128: file just before the last line. If the
                   5129: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5130: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5131: that the package's include files and libraries are provided.</p>
1.219     nia      5132: <p>If you just need binaries from a dependent package, add a
1.184     rillig   5133: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5134: version of the dependency and where it can be found in pkgsrc. This line
                   5135: should be placed in the third paragraph. If the dependency is only
                   5136: needed for building the package, but not when using it, use
                   5137: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5138: instead of <code class="varname">DEPENDS</code>.
                   5139: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5140: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5141: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219     nia      5142: packages, i.e. packages for the platform where the package is built;
1.184     rillig   5143: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219     nia      5144: packages, i.e. packages for the platform for which the package
                   5145: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
                   5146: specifies a dependency used only for testing the resulting package
                   5147: built, using the upstream project's included test suite, on the native
                   5148: platform.
1.184     rillig   5149: Your package may then look like this:</p>
                   5150: <pre class="programlisting">
                   5151: [...]
                   5152: 
                   5153: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5154: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5155: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5156: 
                   5157: [...]
                   5158: 
                   5159: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5160: .include "../../devel/glib2/buildlink3.mk"
                   5161: .include "../../mk/bsd.pkg.mk"
                   5162: </pre>
                   5163: </li>
                   5164: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5165: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5166: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5167: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5168: additional explanations.</p></li>
                   5169: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5170: 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
                   5171: over there, you can hopefully continue here.</p></li>
                   5172: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5173: directory from the extracted files. Besides these files, a lot of cache
1.219     nia      5174: files and other system information have been saved in the working
                   5175: directory, which may have become outdated after you edited the
1.184     rillig   5176: <code class="filename">Makefile</code>.</p></li>
                   5177: <li class="step">
                   5178: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5179: 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.219     nia      5180: <p>If the extracted files from the package need to be fixed, run
                   5181: multiple rounds of these commands:</p>
                   5182: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184     rillig   5183: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5184: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219     nia      5185: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
                   5186: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184     rillig   5187: </li>
                   5188: <li class="step"><p>When the package builds fine, the next step is to install
                   5189: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5190: everything works.</p></li>
                   5191: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5192: contains a list of the files that are installed by the package, is
                   5193: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5194: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5195: the file using your preferred text editor to see if the list of
                   5196: files looks plausible.</p></li>
                   5197: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5198: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5199: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5200: had been registered in the database of installed files, but with an
                   5201: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5202: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5203: registered with the list of files from
                   5204: <code class="filename">PLIST</code>.</p></li>
                   5205: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5206: from above again in a single step, making sure that the PLIST is correct
                   5207: and the whole package is created as intended.</p></li>
1.219     nia      5208: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
                   5209: left to do.</p></li>
1.184     rillig   5210: <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>
                   5211: </ol></div>
                   5212: <div class="sect1">
                   5213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5214: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5215: <div class="sect2">
                   5216: <div class="titlepage"><div><div><h3 class="title">
1.219     nia      5217: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184     rillig   5218: <p>Python modules and programs packages are easily created using a
                   5219: set of predefined variables.</p>
                   5220: <p>
                   5221: If some Python versions are not supported by the software, set the
                   5222: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5223: that are not supported, e.g.
                   5224: </p>
                   5225: <pre class="programlisting">
                   5226: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5227: </pre>
                   5228: <p>
                   5229: If the packaged software is a Python module, include one of
1.215     wiz      5230: <code class="filename">../../lang/python/egg.mk</code> or
1.184     rillig   5231: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.215     wiz      5232: <p>Most Python packages use setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
1.184     rillig   5233: If the packaged software is using setuptools, you only need
                   5234: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
1.215     wiz      5235: </p>
1.184     rillig   5236: <p>Either way, the package directory should be called
                   5237: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5238: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5239: </p>
                   5240: <pre class="programlisting">
                   5241: DISTNAME=   foopymodule-1.2.10
                   5242: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5243: </pre>
1.226     gutterid 5244: <p>
                   5245: For software in PyPi, the name should match what PyPi specifies for
                   5246: "pip install software".
                   5247: </p>
1.184     rillig   5248: <p>If it is an application, include
                   5249: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5250: In order to correctly set the path to the Python interpreter, use the
                   5251: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5252: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5253: For example:
                   5254: </p>
                   5255: <pre class="programlisting">
                   5256: REPLACE_PYTHON=   *.py
                   5257: </pre>
                   5258: <p>Some Python modules have separate distributions for Python-2.x
                   5259: and Python-3.x support. In pkgsrc this is handled by the
                   5260: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5261: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5262: packages that should be depended upon and include
                   5263: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5264: then the pkgsrc infrastructure will depend on the appropriate package
                   5265: version. For example:
                   5266: </p>
                   5267: <pre class="programlisting">
                   5268: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5269: </pre>
                   5270: <p>
                   5271: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5272: of supported packages.</p>
                   5273: </div>
                   5274: <div class="sect2">
                   5275: <div class="titlepage"><div><div><h3 class="title">
1.219     nia      5276: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184     rillig   5277: <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>
                   5278: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207     leot     5279: 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.184     rillig   5280: Individual packages (and optionally their dependencies) may be created
                   5281: and updated.  R packages generally follow the same form, and most of
                   5282: the relevant information needed is contained in a
                   5283: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5284: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5285: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5286: creates or updates a package in the canonical form.  The resulting
                   5287: package should be reviewed for correctness.</p>
                   5288: </div>
                   5289: <div class="sect2">
                   5290: <div class="titlepage"><div><div><h3 class="title">
1.219     nia      5291: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184     rillig   5292: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207     leot     5293: <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.184     rillig   5294: <p>If the TeXlive package name is not known, it may be useful to
                   5295: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5296: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5297: 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
                   5298: archive</a>.</p>
                   5299: <p>If the TeXlive package name is known, download the files from
                   5300: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5301: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5302: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5303: also have associated documentation packages, so download
                   5304: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5305: should be placed in the appropriate category directory, which is often
                   5306: but not always <code class="filename">print</code>.  Then run the following
                   5307: command in the category directory.</p>
                   5308: <pre class="programlisting">
                   5309: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5310: </pre>
                   5311: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5312: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5313: are correct.</p>
                   5314: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5315: currently does not include version information in package filenames
                   5316: and changes their contents periodically when updates occur.
                   5317: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5318: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5319: main one and the corresponding documentation, upload the distfiles
                   5320: with the following command in each package directory.</p>
                   5321: <pre class="programlisting">
                   5322: make upload-distfiles
                   5323: </pre>
                   5324: </div>
                   5325: </div>
                   5326: <div class="sect1">
                   5327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5328: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5329: <div class="sect2">
                   5330: <div class="titlepage"><div><div><h3 class="title">
                   5331: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5332: <div class="sect3">
                   5333: <div class="titlepage"><div><div><h4 class="title">
                   5334: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5335: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5336: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5337: pkgsrc. As the description says it has to do with the web, the obvious
                   5338: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5339: <pre class="programlisting">
                   5340: <code class="prompt">$</code> mkdir www/nvu
                   5341: <code class="prompt">$</code> cd www/nvu
                   5342: </pre>
                   5343: <p>The web site says that the sources are available as a tar file, so
                   5344: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5345: <pre class="programlisting">
                   5346: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5347: </pre>
                   5348: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5349: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5350: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5351: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5352: <code class="varname">COMMENT</code> fields. Then the package
                   5353: <code class="filename">Makefile</code> looked like that:</p>
                   5354: <pre class="programlisting">
                   5355: # $NetBSD $
                   5356: #
                   5357: 
                   5358: DISTNAME=       nvu-1.0-sources
                   5359: PKGNAME=        nvu-1.0
                   5360: CATEGORIES=     www
                   5361: MASTER_SITES=   http://cvs.nvu.com/download/
                   5362: EXTRACT_SUFX=   .tar.bz2
                   5363: 
                   5364: MAINTAINER=     rillig@NetBSD.org
                   5365: HOMEPAGE=       http://cvs.nvu.com/
                   5366: COMMENT=        Web Authoring System
                   5367: 
                   5368: # url2pkg-marker (please do not remove this line.)
                   5369: .include "../../mk/bsd.pkg.mk"
                   5370: </pre>
                   5371: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5372: this is a workaround to prevent CVS expanding to the filename of the
                   5373: guide.</p>
                   5374: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5375: source archive:</p>
                   5376: <pre class="programlisting">
                   5377: url2pkg&gt; Running "make makesum" ...
                   5378: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5379: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5380: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5381: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5382: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5383: url2pkg&gt; Running "make extract" ...
                   5384: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5385: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5386: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5387: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5388: ===&gt; Installing dependencies for nvu-1.0
                   5389: ===&gt; Overriding tools for nvu-1.0
                   5390: ===&gt; Extracting for nvu-1.0
                   5391: url2pkg&gt; Adjusting the Makefile.
                   5392: 
                   5393: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5394: 
                   5395: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5396: </pre>
                   5397: </div>
                   5398: <div class="sect3">
                   5399: <div class="titlepage"><div><div><h4 class="title">
                   5400: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5401: <p>Now that the package has been extracted, let's see what's inside
                   5402: it. The package has a <code class="filename">README.txt</code>, but that only
                   5403: says something about mozilla, so it's probably useless for seeing what
                   5404: dependencies this package has. But since there is a GNU configure script
                   5405: in the package, let's hope that it will complain about everything it
                   5406: needs.</p>
                   5407: <pre class="programlisting">
                   5408: <code class="prompt">$</code> bmake
                   5409: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5410: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5411: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5412: ===&gt; Patching for nvu-1.0
                   5413: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5414: ===&gt; Configuring for nvu-1.0
                   5415: [...]
                   5416: configure: error: Perl 5.004 or higher is required.
                   5417: [...]
                   5418: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5419: [...]
                   5420: </pre>
                   5421: <p>That worked quite well. So I opened the package Makefile in my
                   5422: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5423: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5424: package have changed now, and since a perl wrapper is automatically
                   5425: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5426: from scratch.</p>
                   5427: <pre class="programlisting">
                   5428: <code class="prompt">$</code> bmake clean
                   5429: ===&gt; Cleaning for nvu-1.0
                   5430: <code class="prompt">$</code> bmake
                   5431: [...]
                   5432: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5433: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5434: [...]
                   5435: </pre>
                   5436: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5437: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5438: <pre class="programlisting">
                   5439: [...]
                   5440: checking for GTK - version &gt;= 1.2.0... no
                   5441: *** Could not run GTK test program, checking why...
                   5442: [...]
                   5443: </pre>
                   5444: <p>Now to the other dependencies. The first question is: Where is the
                   5445: GTK package hidden in pkgsrc?</p>
                   5446: <pre class="programlisting">
                   5447: <code class="prompt">$</code> echo ../../*/gtk*
                   5448: [many packages ...]
                   5449: <code class="prompt">$</code> echo ../../*/gtk
                   5450: ../../x11/gtk
                   5451: <code class="prompt">$</code> echo ../../*/gtk2
                   5452: ../../x11/gtk2
                   5453: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5454: ../../x11/gtk2/buildlink3.mk
                   5455: </pre>
                   5456: <p>The first try was definitely too broad. The second one had exactly
                   5457: one result, which is very good. But there is one pitfall with GNOME
                   5458: packages. Before GNOME 2 had been released, there were already many
                   5459: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5460: packages, the GNOME 2 packages were imported as separate packages, and
                   5461: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5462: whether this was the case here, and indeed it was.</p>
                   5463: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5464: file, adding the dependency is very easy. I just inserted an
                   5465: <code class="literal">.include</code> line before the last line of the package
                   5466: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5467: <pre class="programlisting">
                   5468: [...]
                   5469: .include "../../x11/gtk2/buildlink3.mk"
                   5470: .include "../../mk/bsd.pkg.mk
                   5471: </pre>
                   5472: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5473: was:</p>
1.1       dsieger  5474: <pre class="programlisting">
1.184     rillig   5475: [...]
                   5476: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5477: checking for GTK - version &gt;= 1.2.0... no
                   5478: *** Could not run GTK test program, checking why...
                   5479: *** The test program failed to compile or link. See the file config.log for the
                   5480: *** exact error that occured. This usually means GTK was incorrectly installed
                   5481: *** or that you have moved GTK since it was installed. In the latter case, you
                   5482: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5483: configure: error: Test for GTK failed.
                   5484: [...]
1.111     sevan    5485: </pre>
1.184     rillig   5486: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5487: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5488: told me that this package really wanted to have the GNOME 1 version of
                   5489: GTK. If the package had looked for GTK2, it would have looked for
                   5490: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5491: So I changed the <code class="literal">x11/gtk2</code> to
                   5492: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5493: and tried again.</p>
1.18      snj      5494: <pre class="programlisting">
1.184     rillig   5495: [...]
                   5496: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5497: In file included from xpidl.c:42:
                   5498: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5499: In file included from xpidl.c:42:
                   5500: xpidl.h:132: error: parse error before "IDL_ns"
                   5501: [...]
1.111     sevan    5502: </pre>
1.184     rillig   5503: <p>The package still does not find all of its dependencies. Now the
                   5504: question is: Which package provides the
                   5505: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18      snj      5506: <pre class="programlisting">
1.184     rillig   5507: <code class="prompt">$</code> echo ../../*/*idl*
                   5508: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5509: <code class="prompt">$</code> echo ../../*/*IDL*
                   5510: ../../net/libIDL
1.111     sevan    5511: </pre>
1.184     rillig   5512: <p>Let's take the one from the second try. So I included the
                   5513: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5514: again. But the error didn't change. After digging through some of the
                   5515: code, I concluded that the build process of the package was broken and
                   5516: couldn't have ever worked, but since the Mozilla source tree is quite
                   5517: large, I didn't want to fix it. So I added the following to the package
                   5518: <code class="filename">Makefile</code> and tried again:</p>
1.86      wiz      5519: <pre class="programlisting">
1.184     rillig   5520: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5521: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.111     sevan    5522: </pre>
1.184     rillig   5523: <p>The latter line is needed because the package expects the library
                   5524: <code class="filename">libIDL.so</code>, but only
                   5525: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5526: wrapper to rewrite that on the fly.</p>
                   5527: <p>The next problem was related to a recent change of the FreeType
1.207     leot     5528: 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.184     rillig   5529: which patch files were relevant for this issue and copied them to the
                   5530: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5531: patches so that they applied cleanly and retried again. This time,
                   5532: everything worked.</p>
1.86      wiz      5533: </div>
1.184     rillig   5534: <div class="sect3">
                   5535: <div class="titlepage"><div><div><h4 class="title">
                   5536: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  5537: <pre class="programlisting">
1.184     rillig   5538: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5539: [...]
                   5540: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5541: <code class="prompt">$</code> bmake deinstall
                   5542: <code class="prompt">$</code> bmake install
1.111     sevan    5543: </pre>
1.184     rillig   5544: </div>
                   5545: </div>
1.1       dsieger  5546: </div>
                   5547: </div>
1.41      asau     5548: <div class="chapter">
1.1       dsieger  5549: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   5550: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  5551: <div class="toc">
                   5552: <p><b>Table of Contents</b></p>
1.100     leot     5553: <dl class="toc">
1.184     rillig   5554: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5555: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5556: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5557: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5558: <dd><dl>
                   5559: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5560: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5561: <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>
                   5562: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.1       dsieger  5563: </dl></dd>
                   5564: </dl>
                   5565: </div>
1.184     rillig   5566: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5567:   each of which forms a well-defined part of the pkgsrc system. Using
1.207     leot     5568:   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.184     rillig   5569:   like pkgsrc requires some discipline to keep the code correct and
                   5570:   understandable.</p>
                   5571: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5572:   programming are variables and shell
                   5573:   commands. Among these shell commands may even be more complex ones
1.207     leot     5574:   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.184     rillig   5575:   as intended it is necessary to quote all variables correctly when they
                   5576:   are used.</p>
                   5577: <p>This chapter describes some patterns that appear quite often in
                   5578:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5579:   with them.</p>
1.41      asau     5580: <div class="sect1">
1.1       dsieger  5581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   5582: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5584: <p>When you are creating a file as a
                   5585:     target of a rule, always write the data to a temporary file first
                   5586:     and finally rename that file. Otherwise there might occur an error
                   5587:     in the middle of generating the file, and when the user runs
1.207     leot     5588:     <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.184     rillig   5589:     regenerated properly. Example:</p>
1.1       dsieger  5590: <pre class="programlisting">
1.184     rillig   5591: wrong:
                   5592:         @echo "line 1" &gt; ${.TARGET}
                   5593:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5594:         @false
                   5595: 
                   5596: correct:
                   5597:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5598:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5599:         @false
                   5600:         @mv ${.TARGET}.tmp ${.TARGET}
1.1       dsieger  5601: </pre>
1.184     rillig   5602: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5603:     <code class="filename">wrong</code> will exist, although there was an error
                   5604:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5605:     correct</strong></span> gives an error message twice, as expected.</p>
1.207     leot     5606: <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.184     rillig   5607:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5608:     happens when it is interrupted, for example by pressing
                   5609:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.207     leot     5610:     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.184     rillig   5611: </li></ul></div>
                   5612: </div>
                   5613: <div class="sect1">
                   5614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5615: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5616: <p><code class="filename">Makefile</code> variables contain strings that
                   5617:     can be processed using the five operators <code class="code">=</code>,
                   5618:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.207     leot     5619:     <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.184     rillig   5620:     page.</p>
                   5621: <p>When a variable's value is parsed from a
                   5622:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5623:     the backslash character <code class="code">\</code> are handled specially. If a
                   5624:     backslash is the last character in a line, that backslash is removed
                   5625:     from the line and the line continues with the next line of the file.</p>
                   5626: <p>The <code class="code">#</code> character starts a comment that reaches
                   5627:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5628:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5629: <p>The evaluation of variables either happens immediately or lazy.
                   5630:     It happens immediately when the variable occurs on the right-hand
                   5631:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5632:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5633:     In the other cases, it is evaluated lazily.</p>
                   5634: <p>Some of the modifiers split the string into words and then
                   5635:     operate on the words, others operate on the string as a whole. When a
                   5636:     string is split into words, double quotes and single quotes are
1.207     leot     5637:     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.184     rillig   5638: <div class="sect2">
                   5639: <div class="titlepage"><div><div><h3 class="title">
                   5640: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5642: <li class="listitem"><p>All variable names starting with an underscore
                   5643:        are reserved for use by the pkgsrc infrastructure. They shall
                   5644:        not be used by packages.</p></li>
                   5645: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5646:        lowercase variable names for the iteration
                   5647:        variables.</p></li>
                   5648: <li class="listitem"><p>All list variables should have a plural name,
                   5649:        such as <code class="varname">PKG_OPTIONS</code> or
                   5650:        <code class="varname">DISTFILES</code>.</p></li>
                   5651: </ul></div>
                   5652: </div>
                   5653: </div>
                   5654: <div class="sect1">
                   5655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5656: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5657: <div class="sect2">
                   5658: <div class="titlepage"><div><div><h3 class="title">
                   5659: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5660: <p>When adding a string that possibly contains whitespace or quotes to
                   5661: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5662: modifier.</p>
                   5663: <p>When adding another list to a list (example 2), it must not be
                   5664: quoted, since its elements are already quoted.</p>
1.1       dsieger  5665: <pre class="programlisting">
1.184     rillig   5666: STRING=         foo * bar `date`
                   5667: LIST=           # empty
                   5668: ANOTHER_LIST=   a=b c=d
                   5669: 
                   5670: LIST+=          ${STRING:Q}       # 1
                   5671: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  5672: </pre>
1.184     rillig   5673: </div>
                   5674: <div class="sect2">
                   5675: <div class="titlepage"><div><div><h3 class="title">
                   5676: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5677: <p>Echoing a string containing special characters needs special
                   5678: work.</p>
1.1       dsieger  5679: <pre class="programlisting">
1.184     rillig   5680: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5681: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5682: 
                   5683: all:
                   5684:         echo ${STRING}                  # 1
                   5685:         echo ${STRING:Q}                # 2
                   5686:         printf '%s\n' ${STRING:Q}''     # 3
                   5687:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       dsieger  5688: </pre>
1.184     rillig   5689: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5690: are just copied.</p>
                   5691: <p>Example 2 quotes the string so that the shell interprets it
                   5692: correctly. But the echo command may additionally interpret strings with a
                   5693: leading dash or those containing backslashes.</p>
1.207     leot     5694: <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.184     rillig   5695: interprets the format string, but not the next argument. The trailing
                   5696: single quotes handle the case when the string is empty. In that case, the
                   5697: :Q modifier would result in an empty string too, which would then be
1.207     leot     5698: 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.184     rillig   5699: but other programs may care.</p>
                   5700: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5701: need to be quoted because the quoting has already been done
                   5702: when adding elements to the list.</p>
1.1       dsieger  5703: </div>
1.41      asau     5704: <div class="sect2">
1.1       dsieger  5705: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   5706: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5707: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5708: GNU-style configure script (especially those that call other configure
                   5709: scripts), it must not have leading or trailing whitespace, since
                   5710: otherwise the configure script gets confused. To trim leading and
                   5711: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5712: following example:</p>
1.1       dsieger  5713: <pre class="programlisting">
1.184     rillig   5714: CPPFLAGS=               # empty
                   5715: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5716: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       dsieger  5717: 
1.184     rillig   5718: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       dsieger  5719: 
1.184     rillig   5720: all:
                   5721:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5722:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5723: </pre>
                   5724: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5725: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5726: space.</p>
                   5727: </div>
                   5728: <div class="sect2">
                   5729: <div class="titlepage"><div><div><h3 class="title">
                   5730: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5731: <p>When a possibly empty variable is used in a shell program, it may
                   5732: lead to a syntax error.</p>
                   5733: <pre class="programlisting">
                   5734: EGFILES=        # empty
1.1       dsieger  5735: 
1.184     rillig   5736: install-examples:   # produces a syntax error in the shell
                   5737:         for egfile in ${EGFILES}; do            \
                   5738:                 echo "Installing $$egfile";     \
                   5739:         done
                   5740: </pre>
                   5741: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.207     leot     5742: <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.184     rillig   5743: To fix this syntax error, use one of the snippets below.</p>
                   5744: <pre class="programlisting">
                   5745: EMPTY=          # empty
1.1       dsieger  5746: 
1.184     rillig   5747: install-examples:
                   5748:         for egfile in ${EGFILES} ""; do         \
                   5749:                 [ -n "$$egfile" ] || continue;  \
                   5750:                 echo "Installing $$egfile";     \
                   5751:         done
                   5752: </pre>
                   5753: <p>In this case, an empty string is appended to the iteration list (to
                   5754: prevent the syntax error) and filtered out later.</p>
                   5755: <pre class="programlisting">
                   5756: EGFILES=        # empty
1.1       dsieger  5757: 
1.184     rillig   5758: install-examples:
                   5759: .for egfile in ${EGFILES}
                   5760:         echo "Installing ${egfile}"
                   5761: .endfor
1.1       dsieger  5762: </pre>
1.184     rillig   5763: <p>If one of the filenames contains special characters, it should be
                   5764: enclosed in single or double quotes.</p>
                   5765: <p>To have a shell command test whether a make variable is empty, use
                   5766: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5767: </div>
                   5768: </div>
                   5769: </div>
                   5770: <div class="chapter">
                   5771: <div class="titlepage"><div><div><h2 class="title">
                   5772: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5773: <div class="toc">
                   5774: <p><b>Table of Contents</b></p>
                   5775: <dl class="toc">
                   5776: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5777: <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>
                   5778: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5779: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5780: </dl>
1.1       dsieger  5781: </div>
1.184     rillig   5782: <p>Many packages have the ability to be built to support different
                   5783: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5784: in pkgsrc that provides generic handling of those options that
                   5785: determine different ways in which the packages can be built.  It's
                   5786: possible for the user to specify exactly which sets of options will be
                   5787: built into a package or to allow a set of global default options
                   5788: apply.</p>
                   5789: <p>There are two broad classes of behaviors that one might want to
                   5790: control via options.  One is whether some particular feature is
                   5791: enabled in a program that will be built anyway, often by including or
                   5792: not including a dependency on some other package.  The other is
                   5793: whether or not an additional program will be built as part of the
                   5794: package.  Generally, it is better to make a split package for such
                   5795: additional programs instead of using options, because it enables
                   5796: binary packages to be built which can then be added separately.  For
                   5797: example, the foo package might have minimal dependencies (those
                   5798: packages without which foo doesn't make sense), and then the foo-gfoo
                   5799: package might include the GTK frontend program gfoo.  This is better
                   5800: than including a gtk option to foo that adds gfoo, because either that
                   5801: option is default, in which case binary users can't get foo without
                   5802: gfoo, or not default, in which case they can't get gfoo.  With split
                   5803: packages, they can install foo without having GTK, and later decide to
                   5804: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5805: source users too, avoiding the need for rebuilds.</p>
                   5806: <p>Plugins with widely varying dependencies should usually be split
                   5807: instead of options.</p>
                   5808: <p>It is often more work to maintain split packages, especially if
                   5809: the upstream package does not support this.  The decision of split
                   5810: vs. option should be made based on the likelihood that users will want
                   5811: or object to the various pieces, the size of the dependencies that are
                   5812: included, and the amount of work.</p>
                   5813: <p>A further consideration is licensing.  Non-free parts, or parts
                   5814: that depend on non-free dependencies (especially plugins) should
                   5815: almost always be split if feasible.</p>
                   5816: <div class="sect1">
                   5817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5818: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5819: <p>Global default options are listed in
                   5820: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5821: that should be built into every package if that option is supported.
                   5822: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  5823: </div>
1.41      asau     5824: <div class="sect1">
1.1       dsieger  5825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   5826: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5827: </h2></div></div></div>
                   5828: <p>The following example shows how
                   5829: <code class="filename">bsd.options.mk</code> should be used
                   5830: by the hypothetical ``wibble'' package, either in the package
                   5831: <code class="filename">Makefile</code>, or in a file,
                   5832: e.g. <code class="filename">options.mk</code>, that is included by the
                   5833: main package <code class="filename">Makefile</code>.</p>
1.1       dsieger  5834: <pre class="programlisting">
1.184     rillig   5835: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5836: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5837: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5838: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5839: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5840: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5841: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5842: 
                   5843: .include "../../mk/bsd.prefs.mk"
                   5844: 
                   5845: # this package was previously named wibble2
                   5846: .if defined(PKG_OPTIONS.wibble2)
                   5847: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5848: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5849:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5850: .endif
                   5851: 
                   5852: .include "../../mk/bsd.options.mk"
                   5853: 
                   5854: # Package-specific option-handling
1.1       dsieger  5855: 
1.184     rillig   5856: ###
                   5857: ### FOO support
                   5858: ###
                   5859: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5860: CONFIGURE_ARGS+=    --enable-foo
                   5861: .endif
1.1       dsieger  5862: 
1.184     rillig   5863: ###
                   5864: ### LDAP support
                   5865: ###
                   5866: .if !empty(PKG_OPTIONS:Mldap)
                   5867: .  include "../../databases/openldap-client/buildlink3.mk"
                   5868: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5869: .endif
1.1       dsieger  5870: 
1.184     rillig   5871: ###
                   5872: ### database support
                   5873: ###
                   5874: .if !empty(PKG_OPTIONS:Mmysql)
                   5875: .  include "../../mk/mysql.buildlink3.mk"
                   5876: .endif
                   5877: .if !empty(PKG_OPTIONS:Mpgsql)
                   5878: .  include "../../mk/pgsql.buildlink3.mk"
                   5879: .endif
                   5880: </pre>
                   5881: <p>The first section contains the information about which build
                   5882: options are supported by the package, and any default options settings
                   5883: if needed.</p>
                   5884: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5885: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.207     leot     5886: <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.184     rillig   5887: options.  It should be set to
                   5888: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5889: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5890: at the point where the options are processed.</p></li>
                   5891: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5892: build options supported by the package.</p></li>
                   5893: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5894: list of names of groups of mutually exclusive options.  The options in
                   5895: each group are listed in
                   5896: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5897: The most specific setting of any option from the group takes
                   5898: precedence over all other options in the group.  Options from the
                   5899: groups will be automatically added to
                   5900: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5901: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5902: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5903: packages will fail if no option from the group is
                   5904: selected.</p></li>
                   5905: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5906: of names of sets of options.  At least one option from each set must
                   5907: be selected.  The options in each set are listed in
                   5908: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5909: Options from the sets will be automatically added to
                   5910: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5911: fail if no option from the set is selected.</p></li>
                   5912: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5913: build options which are enabled by default.</p></li>
                   5914: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5915: of
                   5916: <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>
                   5917: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5918: their option counterparts.  Pairs should be added with
                   5919: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5920: warning will be issued if the user uses a legacy
                   5921: variable.</p></li>
                   5922: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5923: of
                   5924: <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>
                   5925: pairs that map options that have been renamed to their new
                   5926: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5927: the listing of global legacy options.  A warning will be issued if
                   5928: the user uses a legacy option.</p></li>
                   5929: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5930: options implied by deprecated variables used.  This can be used for
                   5931: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5932: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5933: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5934: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5935: a list of warnings about deprecated variables or options used, and
                   5936: what to use instead.</p></li>
                   5937: </ol></div>
                   5938: <p>A package should never modify
                   5939: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5940: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5941: To suggest a default set of options, use
                   5942: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5943: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5944: including <code class="filename">bsd.options.mk</code>.  If none of
                   5945: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5946: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5947: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5948: happen with platform-specific options if none of them is supported on
                   5949: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5950: empty list and the package is otherwise treated as not using the
                   5951: options framework.</p>
                   5952: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5953: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5954: build options, properly filtered to remove unsupported and duplicate
                   5955: options.</p>
                   5956: <p>The remaining sections contain the logic that is specific to
                   5957: each option.  The correct way to check for an option is to check
                   5958: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5959: <pre class="programlisting">
                   5960: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1       dsieger  5961: </pre>
                   5962: </div>
1.184     rillig   5963: <div class="sect1">
                   5964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5965: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5966: <p>Options that enable similar features in different packages (like
                   5967: optional support for a library) should use a common name in all
                   5968: packages that support it (like the name of the library).  If another
                   5969: package already has an option with the same meaning, use the same
                   5970: name.</p>
                   5971: <p>Options that enable features specific to one package, where it's
                   5972: unlikely that another (unrelated) package has the same (or a similar)
                   5973: optional feature, should use a name prefixed with
                   5974: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5975: <p>If a group of related packages share an optional feature
                   5976: specific to that group, prefix it with the name of the
                   5977: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5978: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5979: <p>For new options, add a line to
                   5980: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5981: fields, separated by tab.  The first field is the option name, the
                   5982: second its description.  The description should be a whole sentence
                   5983: (starting with an uppercase letter and ending with a period) that
                   5984: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5985: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5986: </div>
                   5987: <div class="sect1">
                   5988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5989: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5990: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5991: different dependencies based on the options with which the package was
                   5992: built. For querying these options, the file
                   5993: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5994: typical example looks like this:</p>
1.1       dsieger  5995: <pre class="programlisting">
1.184     rillig   5996: pkgbase := libpurple
                   5997: .include "../../mk/pkg-build-options.mk"
                   5998: 
                   5999: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6000: ...
                   6001: .endif
1.117     sevan    6002: </pre>
1.184     rillig   6003: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6004: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6005: options of the libpurple package, which can then be queried like
                   6006: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6007: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6008: details.</p>
1.1       dsieger  6009: </div>
                   6010: </div>
1.41      asau     6011: <div class="chapter">
1.1       dsieger  6012: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   6013: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  6014: <div class="toc">
                   6015: <p><b>Table of Contents</b></p>
1.100     leot     6016: <dl class="toc">
1.184     rillig   6017: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   6018: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   6019: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1       dsieger  6020: </dl>
                   6021: </div>
1.184     rillig   6022: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6023: by pkgsrc and also for individual packages to define what commands
                   6024: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6025: or for later run-time of an installed packaged (such as
                   6026: <code class="varname">DEPENDS</code>).
                   6027: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6028: package will not be used.</p>
                   6029: <p>When building a package, the replacement tools are
                   6030: made available in a directory (as symlinks or wrapper scripts)
                   6031: that is early in the executable search path. Just like the buildlink
                   6032: system, this helps with consistent builds.</p>
                   6033: <p>A tool may be needed to help build a specific package. For example,
                   6034: perl, GNU make (gmake) or yacc may be needed.</p>
                   6035: <p>Also a tool may be needed, for example, because the native system's supplied
                   6036: tool may be inefficient for building a package with pkgsrc.
                   6037: For example, a package may need GNU awk, bison (instead of
                   6038: yacc) or a better sed.</p>
                   6039: <p>The tools used by a package can be listed by running
                   6040: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     6041: <div class="sect1">
1.1       dsieger  6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6043: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6044: <p>The default set of tools used by pkgsrc is defined in
                   6045: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6046: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6047: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6048: These can be seen by running:
                   6049: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6050: <p>If a package needs a specific program to build
                   6051: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6052: to define the tools needed.</p>
1.1       dsieger  6053: </div>
1.184     rillig   6054: <div class="sect1">
                   6055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6056: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6057: <p>In the following examples, the :run means that it is needed at
                   6058: run-time (and becomes a DEPENDS).
                   6059: The default is a build dependency which can be set with
                   6060: :build. (So in this example, it is the same as gmake:build
                   6061: and pkg-config:build.)</p>
1.1       dsieger  6062: <pre class="programlisting">
1.184     rillig   6063: USE_TOOLS+=     gmake perl:run pkg-config
1.1       dsieger  6064: </pre>
1.184     rillig   6065: <p>When using the tools framework, a
                   6066: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6067: which contains the full path to the appropriate tool. For example,
                   6068: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6069: on Linux systems.</p>
                   6070: <p>If you always need a pkgsrc version of the
                   6071: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6072: </p>
1.1       dsieger  6073: </div>
1.184     rillig   6074: <div class="sect1">
                   6075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6076: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6077: <p>When improving or porting pkgsrc to a new platform, have a look
                   6078: at (or create) the corresponding platform specific make file fragment under
                   6079: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6080: the name of the common tools. For example:</p>
1.1       dsieger  6081: <pre class="programlisting">
1.184     rillig   6082: .if exists(/usr/bin/bzcat)
                   6083: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6084: .elif exists(/usr/bin/bzip2)
                   6085: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6086: .endif
                   6087: 
                   6088: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       dsieger  6089: </pre>
                   6090: </div>
                   6091: </div>
1.184     rillig   6092: <div class="chapter">
                   6093: <div class="titlepage"><div><div><h2 class="title">
                   6094: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6095: <div class="toc">
                   6096: <p><b>Table of Contents</b></p>
                   6097: <dl class="toc">
                   6098: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6099: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6100: <dd><dl>
                   6101: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6102: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6103:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6104:       and
                   6105:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6106:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6107: </dl></dd>
                   6108: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6109: <dd><dl>
                   6110: <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>
                   6111: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6112: </dl></dd>
                   6113: </dl>
1.1       dsieger  6114: </div>
1.184     rillig   6115: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6116:   are seen by a package's configure and build processes.  This is implemented
                   6117:   in a two step process:</p>
                   6118: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6119: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6120:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6121:       of <code class="varname">WRKDIR</code>.</p></li>
                   6122: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6123:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6124:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6125:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6126:       native compiler on some operating systems look like GCC, so that
                   6127:       packages that expect GCC won't require modifications to build with
                   6128:       those native compilers.</p></li>
                   6129: </ol></div>
                   6130: <p>This normalizes the environment in which a package is built so that the
                   6131:   package may be built consistently despite what other software may be
                   6132:   installed. Please note that the normal system header and library paths,
                   6133:   e.g. <code class="filename">/usr/include</code>,
                   6134:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6135:   designed to insulate the package build from non-system-supplied
                   6136:   software.</p>
1.41      asau     6137: <div class="sect1">
1.1       dsieger  6138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6139: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6140: <p>The process of converting packages to use the buildlink3
                   6141:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6142:     The things to keep in mind are:</p>
1.23      wiz      6143: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184     rillig   6144: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6145:        instead of the actual toolchain.  Some packages are tricky,
                   6146:        and the only way to know for sure is the check
                   6147:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6148:        wrappers are being invoked.</p></li>
                   6149: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6150:        the package Makefile, e.g. Java VMs, standalone shells,
                   6151:        etc., because the code to symlink files into
                   6152:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6153:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6154:        </p></li>
                   6155: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6156:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6157:        package's Makefile are added as dependencies for that package.
                   6158:        </p></li>
                   6159: </ol></div>
                   6160: <p>If a dependency on a particular package is required for its libraries and
                   6161:     headers, then we replace:</p>
                   6162: <pre class="programlisting">
                   6163: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6164: </pre>
                   6165: <p>with</p>
                   6166: <pre class="programlisting">
                   6167: .include "../../category/foo/buildlink3.mk"
                   6168: </pre>
                   6169: <p>The buildlink3.mk files usually define the required dependencies.
                   6170:     If you need a newer version of the dependency when using buildlink3.mk
                   6171:     files, then you can define it in your Makefile; for example:</p>
1.1       dsieger  6172: <pre class="programlisting">
1.184     rillig   6173: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6174: .include "../../category/foo/buildlink3.mk"
1.1       dsieger  6175: </pre>
1.184     rillig   6176: <p>There are several <code class="filename">buildlink3.mk</code>
                   6177:     files in <code class="filename">pkgsrc/mk</code>
                   6178:     that handle special package issues:</p>
                   6179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6180: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6181:        the native or a pkgsrc Berkeley DB implementation based on
                   6182:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6183:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6184: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6185:        comes with neither Curses nor NCurses, this will take care
1.207     leot     6186:        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.184     rillig   6187: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6188:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6189:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6190:        require a Kerberos 5 implementation.</p></li>
                   6191: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6192:        system-provided Motif installation or adds a dependency on
1.207     leot     6193:        <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.184     rillig   6194:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6195:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6196:        to choose which Motif version will be used.</p></li>
                   6197: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6198:        system-provided GNU readline or editline (libedit) installation,
1.207     leot     6199:        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>,
                   6200:        <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.184     rillig   6201:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6202:        If your package really needs GNU readline library, its Makefile
                   6203:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6204:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6205: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6206:        variables that may be used by packages that use the
                   6207:        Open Sound System (OSS) API.</p></li>
                   6208: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6209:        any of the Postgres versions in the variable
                   6210:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6211:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6212:        the file for more information.</p></li>
                   6213: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6214:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207     leot     6215:        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.184     rillig   6216: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6217:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6218:        library.</p></li>
                   6219: </ul></div>
                   6220: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6221:     files provide a more complete
                   6222:     description of how to use them properly.</p>
1.1       dsieger  6223: </div>
1.41      asau     6224: <div class="sect1">
1.1       dsieger  6225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6226: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6227: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6228:     included by Makefiles to indicate the need to compile and link
                   6229:     against header files and libraries provided by the package.  A
                   6230:     <code class="filename">buildlink3.mk</code> file should always provide
                   6231:     enough information to add the correct type of dependency
                   6232:     relationship and include any other
                   6233:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6234:     headers and libraries that it needs in turn.</p>
                   6235: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207     leot     6236:     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.184     rillig   6237:     package is highly recommended.  For most packages, the following
                   6238:     command will generate a good starting point for
                   6239:     <code class="filename">buildlink3.mk</code> files:</p>
                   6240: <pre class="screen">
                   6241: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6242: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6243:     </pre>
1.41      asau     6244: <div class="sect2">
1.1       dsieger  6245: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   6246: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6247: <p>The following real-life example
                   6248:       <code class="filename">buildlink3.mk</code> is taken
                   6249:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1       dsieger  6250: <pre class="programlisting">
1.184     rillig   6251: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6252: 
                   6253: BUILDLINK_TREE+=        tiff
                   6254: 
                   6255: .if !defined(TIFF_BUILDLINK3_MK)
                   6256: TIFF_BUILDLINK3_MK:=
                   6257: 
                   6258: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6259: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6260: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6261: 
                   6262: .include "../../devel/zlib/buildlink3.mk"
                   6263: .include "../../graphics/jpeg/buildlink3.mk"
                   6264: .endif # TIFF_BUILDLINK3_MK
                   6265: 
                   6266: BUILDLINK_TREE+=        -tiff
1.1       dsieger  6267: </pre>
1.184     rillig   6268: <p>The header and footer manipulate
                   6269:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6270:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6271:       the dependency tree.</p>
                   6272: <p>The main section is protected from multiple inclusion
                   6273:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6274:       added.  Several important variables are set in the section:</p>
                   6275: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6276: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6277:          is the dependency version recorded in the installed
1.184     rillig   6278:          package; this should always be set using
                   6279:          <span class="command"><strong>+=</strong></span> to ensure that
                   6280:          we're appending to any pre-existing list of values.  This
1.185     wiz      6281:          variable should be set to the last version of the
1.184     rillig   6282:          package that had an backwards-incompatible API change.
                   6283:          </p></li>
                   6284: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6285:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6286:          pkgsrc directory.</p></li>
                   6287: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6288:          (not shown above) controls whether we use
                   6289:          <code class="varname">BUILD_DEPENDS</code> or
                   6290:          <code class="varname">DEPENDS</code> to add the dependency on
                   6291:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6292:          selected by setting
                   6293:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6294:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6295:          used.</p></li>
                   6296: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6297:            and
                   6298:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6299:            (not shown above) are lists of subdirectories of
                   6300:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6301:            to add to the header and library search paths.  These
                   6302:            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>
                   6303:          respectively.</p></li>
                   6304: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6305:            (not shown above) is the list of preprocessor flags to add
                   6306:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6307:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6308:            should be avoided and instead be handled using
                   6309:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6310:          above.</p></li>
                   6311: </ul></div>
                   6312: <p>The following variables are all optionally defined within
                   6313:       this second section (protected against multiple inclusion) and
                   6314:       control which package files are symlinked into
                   6315:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6316:       transformed during the symlinking:</p>
                   6317: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6318: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6319:            (not shown above) is a shell glob pattern relative to
                   6320:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6321:            to be symlinked into
                   6322:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6323:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6324: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6325:            (not shown above) is a shell pipeline that
                   6326:            outputs to stdout a list of files relative to
                   6327:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6328:            The resulting files are to be symlinked
                   6329:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6330:            this takes the <code class="filename">+CONTENTS</code> of a
                   6331:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6332:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6333: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6334:            (not shown above) is a filter command that filters
                   6335:            <code class="filename">+CONTENTS</code> input into a list of files
                   6336:            relative to
                   6337:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6338:            on stdout.  By default,
                   6339:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6340:            outputs the contents of the <code class="filename">include</code>
                   6341:            and <code class="filename">lib</code> directories in the package
                   6342:            <code class="filename">+CONTENTS</code>.</p></li>
                   6343: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6344:            (not shown above) is a list of sed arguments used to
                   6345:            transform the name of the source filename into a
                   6346:            destination filename, e.g. <span class="command"><strong>-e
                   6347:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6348: </ul></div>
                   6349: <p>This section can additionally include any
                   6350:       <code class="filename">buildlink3.mk</code> needed for
                   6351:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6352:       Including these <code class="filename">buildlink3.mk</code> files
                   6353:       means that the headers and libraries for these
                   6354:       dependencies are also symlinked into
                   6355:       <code class="filename">${BUILDLINK_DIR}</code>
                   6356:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6357:       <code class="filename">buildlink3.mk</code>
                   6358:       file is included. Dependencies are only added for directly
                   6359:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6360: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6361:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6362:       please only add necessary ones, i.e., those whose libraries or
                   6363:       header files are automatically exposed when the package is
                   6364:       use.</p>
                   6365: <p>In particular, if only an executable
                   6366:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6367:       library does not need to be propagated in the
                   6368:       <code class="filename">buildlink3.mk</code> file.</p>
                   6369: <p>The following steps should help you decide if a
                   6370:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6371:       </p>
                   6372: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6373: <li class="listitem"><p>Look at the installed header files: What
                   6374:        headers do they include? The packages providing these files
                   6375:        must be buildlinked.</p></li>
                   6376: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6377:        libraries and look against what other libraries they link.
                   6378:        Some of the packages providing these probably need to be
                   6379:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6380:        some systems pulls in the X libraries, so they will show up in
                   6381:        the <code class="filename">ldd</code> output, while on others (like OS
                   6382:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6383:        used as a hint.</p></li>
                   6384: </ul></div>
                   6385: <p>
                   6386:       </p>
                   6387: </div>
1.41      asau     6388: <div class="sect2">
1.1       dsieger  6389: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   6390: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6391:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6392:       and
                   6393:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6394:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185     wiz      6395: <p>Both variables set lower bounds for a version of this package.
                   6396:       The two variables differ in that one describes source
1.184     rillig   6397:       compatibility (API) and the other binary compatibility (ABI).
                   6398:       The difference is that a change in the API breaks compilation of
                   6399:       programs while changes in the ABI stop compiled programs from
                   6400:       running.</p>
1.185     wiz      6401: <p>The
                   6402:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6403:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6404:       changed very rarely.  (One possible scenario: If all packages
                   6405:       using this package need a higher version than defined in the
                   6406:       <code class="filename">buildlink3.mk</code>,
1.184     rillig   6407:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6408:       could be updated to that higher version.)</p>
                   6409: <p>On the other hand, changes to
1.184     rillig   6410:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6411:       are more common.  The variable will need to be updated every
                   6412:       time the major version of one of its shared libraries is changed,
                   6413:       or any other change where a binary built against the previous
                   6414:       version of the package will not run against the new version any
                   6415:       longer.</p>
                   6416: <p>In such a case, the package's
1.184     rillig   6417:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6418:       must be increased to require the new package version.  Then the
                   6419:       <code class="varname">PKGREVISION</code> of all packages
                   6420:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6421:       to be increased, and if they have
                   6422:       <code class="filename">buildlink3.mk</code> files,
                   6423:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6424:       in their <code class="filename">buildlink3.mk</code> files must be
                   6425:       increased to the new version as well. This is required so that a
                   6426:       package will pull in the versions of the packages that use the
                   6427:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6428:       uniquely identify the packages built against the new ABI. The
1.207     leot     6429:       <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.185     wiz      6430:       help with these updates.</p>
                   6431: <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
                   6432:       about dependencies on other packages, including the
                   6433:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184     rillig   6434: <p>Please take careful consideration before adjusting
                   6435:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6436:       or
                   6437:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6438:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6439:       cause unneeded package deletions and rebuilds.  In many cases,
                   6440:       new versions of packages work just fine with older
                   6441:       dependencies.</p>
1.211     gutterid 6442: <p>Also, it is not needed to set
1.184     rillig   6443:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6444:       when it is identical to
1.211     gutterid 6445:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6446: <p>Note there is also the distinction that users are able to disable
                   6447:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6448:       variable, but there is no equivalent option for API dependencies.</p>
1.1       dsieger  6449: </div>
                   6450: </div>
1.41      asau     6451: <div class="sect1">
1.1       dsieger  6452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6453: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6454: <p>Some packages in pkgsrc install headers and libraries that
                   6455:       coincide with headers and libraries present in the base system.
                   6456:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6457:       packages should also include a <code class="filename">builtin.mk</code>
                   6458:       file that includes the necessary checks to decide whether using
                   6459:       the built-in software or the pkgsrc software is
                   6460:     appropriate.</p>
                   6461: <p>The only requirements of a builtin.mk file for
                   6462:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6463: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6464: <li class="listitem"><p>It should set
                   6465:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6466:        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>
                   6467:        after it is included.</p></li>
                   6468: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6469:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6470:        which is already set before the
                   6471:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6472: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6473:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6474:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6475: </ol></div>
                   6476: <div class="sect2">
                   6477: <div class="titlepage"><div><div><h3 class="title">
                   6478: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6479: <p>The following is the recommended template for builtin.mk
                   6480:       files:</p>
1.1       dsieger  6481: <pre class="programlisting">
1.184     rillig   6482: .if !defined(IS_BUILTIN.foo)
                   6483: #
                   6484: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6485: # genuinely exists in the system or not.
                   6486: #
                   6487: IS_BUILTIN.foo?=        no
1.1       dsieger  6488: 
1.184     rillig   6489: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6490: # version can be determined.
                   6491: #
                   6492: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6493: BUILTIN_PKG.foo?=       foo-1.0
                   6494: .  endif
                   6495: .endif  # IS_BUILTIN.foo
1.1       dsieger  6496: 
1.184     rillig   6497: .if !defined(USE_BUILTIN.foo)
                   6498: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6499: .  if defined(BUILTIN_PKG.foo)
                   6500: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6501: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6502: USE_BUILTIN.foo!=                                                       \
                   6503:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6504:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6505: .      endif
                   6506: .    endfor
                   6507: .  endif
                   6508: .endif  # USE_BUILTIN.foo
1.1       dsieger  6509: 
1.184     rillig   6510: CHECK_BUILTIN.foo?=     no
                   6511: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6512: #
                   6513: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6514: # "yes" or "no".
                   6515: #
                   6516: .endif  # CHECK_BUILTIN.foo
1.1       dsieger  6517: </pre>
1.184     rillig   6518: <p>The first section sets
                   6519:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6520:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6521:       in the base system.  This should not be a base system software
                   6522:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6523:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6524:       included as part of the base system.  This variable is only
                   6525:       used internally within the <code class="filename">builtin.mk</code>
                   6526:       file.</p>
                   6527: <p>The second section sets
                   6528:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6529:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6530:       system if it exists (if
                   6531:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6532:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6533:       within the <code class="filename">builtin.mk</code> file.</p>
                   6534: <p>The third section sets
                   6535:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6536:       and is <span class="emphasis"><em>required</em></span> in all
                   6537:       <code class="filename">builtin.mk</code> files.  The code in this
                   6538:       section must make the determination whether the built-in
                   6539:       software is adequate to satisfy the dependencies listed in
                   6540:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6541:       This is typically done by comparing
                   6542:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6543:       against each of the dependencies in
                   6544:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6545:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6546:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6547:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6548:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6549:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6550:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6551:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6552:       that the built-in version of the software is similar enough to
                   6553:       be used as a replacement.</p>
                   6554: <p>The last section is guarded by
                   6555:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6556:       and includes code that uses the value of
                   6557:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6558:       set in the previous section.  This typically includes, e.g.,
                   6559:       adding additional dependency restrictions and listing additional
                   6560:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6561:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6562: </div>
                   6563: <div class="sect2">
                   6564: <div class="titlepage"><div><div><h3 class="title">
                   6565: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6566: <p>When building packages, it's possible to choose whether to set
                   6567:        a global preference for using either the built-in (native)
                   6568:        version or the pkgsrc version of software to satisfy a
                   6569:        dependency.  This is controlled by setting
                   6570:        <code class="varname">PREFER_PKGSRC</code> and
                   6571:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6572:        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
                   6573:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6574:        use the pkgsrc versions of software, while
                   6575:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6576:        built-in versions.  Preferences are determined by the most
                   6577:        specific instance of the package in either
                   6578:        <code class="varname">PREFER_PKGSRC</code> or
                   6579:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6580:        in neither or in both variables, then
                   6581:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6582:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6583:        using pkgsrc versions of software for all but the most basic
                   6584:       bits on a NetBSD system, you can set:</p>
1.1       dsieger  6585: <pre class="programlisting">
1.184     rillig   6586: PREFER_PKGSRC=  yes
                   6587: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6588: </pre>
                   6589: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6590:       <code class="filename">builtin.mk</code>
                   6591:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6592:       otherwise it is simply ignored in that list.</p>
1.191     bacon    6593: <p><code class="varname">PREFER_PKGSRC</code> and
                   6594:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6595:       to ensure that the bootstrap process does not use inapropriate
                   6596:       native tools as dependencies for core packages.
                   6597: 
                   6598: </p>
                   6599: <pre class="screen">
                   6600: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6601: </pre>
                   6602: <p>
                   6603: 
1.184     rillig   6604:       Switching between settings globally at a later date can introduce
                   6605:       complications with dependency resolution. This is caused by packages
1.191     bacon    6606:       built with the opposite preference being installed alongside each
                   6607:       other.  Hence, any changes to these variables after bootstrap will
                   6608:       necessitate rebuilding all packages depending on one whose preference
                   6609:       has been changed.  This is not trivial and should be avoided.</p>
                   6610: <p>When using pkgsrc on Linux systems, there is high risk of
                   6611:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6612:       command or library not installed by pkgsrc, e.g. those installed by
                   6613:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6614:       upgraded to a version incompatible with the pkgsrc package at any
                   6615:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6616:       cannot prevent this, as it has no control over other package managers.
                   6617:       Another potential problem is that under Redhat Enterprise and related
                   6618:       Linux systems, yum packages are only patched and never upgraded, so
                   6619:       eventually they may become too outdated for use by pkgsrc.  Even
                   6620:       intentionally using foreign dependencies, not considered leakage, can
                   6621:       lead to these problems, so it is generally discouraged.  In order to
                   6622:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6623:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6624:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6625:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6626:       packages, or by setting --prefer-native to "yes".</p>
1.1       dsieger  6627: </div>
1.7       rillig   6628: </div>
1.1       dsieger  6629: </div>
1.41      asau     6630: <div class="chapter">
1.1       dsieger  6631: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   6632: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1       dsieger  6633: <div class="toc">
                   6634: <p><b>Table of Contents</b></p>
1.100     leot     6635: <dl class="toc">
1.184     rillig   6636: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6637: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6638: <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>
                   6639: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6640: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6641: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6642: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6643: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6644: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1       dsieger  6645: </dl>
                   6646: </div>
1.184     rillig   6647: <p>The <code class="filename">PLIST</code> file contains a package's
                   6648:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6649:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6650:   directory it's been installed in) plus some additional statements
1.207     leot     6651:   - 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.184     rillig   6652:   This chapter addresses some issues that need attention when
                   6653:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6654:   below!).</p>
1.41      asau     6655: <div class="sect1">
1.1       dsieger  6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6657: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6658: <p>Be sure to add a RCS ID line as the first thing in any
                   6659:     <code class="filename">PLIST</code> file you write:</p>
                   6660: <pre class="programlisting">
                   6661: @comment $NetBSD $
                   6662: </pre>
                   6663: <p>An artificial space has been added between NetBSD and $, this is a
                   6664: workaround here to prevent CVS expanding to the filename of the guide. When
                   6665: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  6666: </div>
1.41      asau     6667: <div class="sect1">
1.1       dsieger  6668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6669: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6670: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6671:     to output a PLIST that matches any new files since the package
                   6672:     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
                   6673:     more information on this target.</p>
1.1       dsieger  6674: </div>
1.41      asau     6675: <div class="sect1">
1.1       dsieger  6676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6677: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6678: </h2></div></div></div>
                   6679: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6680:     of AWK patterns and actions that are used to filter the output of
                   6681:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6682:     scripting you like to it, but be careful with quoting.</p>
                   6683: <p>For example, to get all files inside the
                   6684:     <code class="filename">libdata/foo</code> directory removed from the
                   6685:     resulting PLIST:</p>
1.1       dsieger  6686: <pre class="programlisting">
1.184     rillig   6687: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.1       dsieger  6688: </pre>
1.185     wiz      6689: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6690:     evaluated after the file list and directory list are sorted.
                   6691:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6692:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6693:     list and directory list are sorted.</p>
1.184     rillig   6694: </div>
                   6695: <div class="sect1">
                   6696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6697: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6698: <p>A number of variables are substituted automatically in
                   6699:     PLISTs when a package is installed on a system. This includes the
                   6700:     following variables:</p>
                   6701: <div class="variablelist"><dl class="variablelist">
                   6702: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6703: <dd>
                   6704: <p>Some packages like emacs and perl embed information
                   6705:          about which architecture they were built on into the
                   6706:          pathnames where they install their files. To handle this
                   6707:          case, PLIST will be preprocessed before actually used, and
                   6708:          the symbol
                   6709:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6710:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6711:          same is done if the string
                   6712:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6713:          PLIST somewhere - use this on packages that have GNU
                   6714:          autoconf-created configure scripts.</p>
                   6715: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6716: <h3 class="title">Legacy note</h3>
                   6717: <p>There used to be a symbol
                   6718:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6719:            was replaced by the output of <span class="command"><strong>uname
                   6720:            -m</strong></span>, but that's no longer supported and has
                   6721:            been removed.</p>
                   6722: </div>
                   6723: </dd>
                   6724: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6725: <dd>
                   6726: <p>Some packages want to embed the OS name and version
                   6727:          into some paths.  To do this, use these variables in the
                   6728:          <code class="filename">PLIST</code>:
                   6729:          </p>
                   6730: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6731: <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>
                   6732: <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>
                   6733: <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>
                   6734: </ul></div>
                   6735: </dd>
                   6736: </dl></div>
                   6737: <p>For a list of values which are replaced by
                   6738:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6739: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6740: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6741: <p>If you want to change other variables not listed above, you
                   6742:     can add variables and their expansions to this variable in the
                   6743:     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.1       dsieger  6744: <pre class="programlisting">
1.184     rillig   6745: PLIST_SUBST+=   SOMEVAR="somevalue"
1.1       dsieger  6746: </pre>
1.184     rillig   6747: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6748:     in the <code class="filename">PLIST</code> with
                   6749:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6750: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6751:     the common case of conditionally including some
                   6752:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6753:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6754:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6755:     to <code class="literal">yes</code> if the entry should be included.
                   6756:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6757:     in the <code class="filename">PLIST</code> with either
                   6758:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6759:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6760:     For example, in <code class="filename">Makefile</code>:</p>
1.66      asau     6761: <pre class="programlisting">
1.184     rillig   6762: PLIST_VARS+=    foo
                   6763: .if <em class="replaceable"><code>condition</code></em>
                   6764: PLIST.foo=      yes
                   6765: .else
1.66      asau     6766: </pre>
1.184     rillig   6767: <p>And then in <code class="filename">PLIST</code>:</p>
1.1       dsieger  6768: <pre class="programlisting">
1.184     rillig   6769: @comment $NetBSD $
                   6770: bin/bar
                   6771: man/man1/bar.1
                   6772: ${PLIST.foo}bin/foo
                   6773: ${PLIST.foo}man/man1/foo.1
                   6774: ${PLIST.foo}share/bar/foo.data
1.1       dsieger  6775: </pre>
1.184     rillig   6776: <p>An artificial space has been added between NetBSD and $, this is a
                   6777: workaround here to prevent CVS expanding to the filename of the guide. When
1.195     gutterid 6778: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  6779: </div>
1.184     rillig   6780: <div class="sect1">
                   6781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6782: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6783: <p>Man pages should be installed in compressed form if
                   6784:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6785:     and uncompressed otherwise. To handle this in the
                   6786:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6787:     appended/removed automatically for man pages according to
                   6788:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6789:     or not, see above for details. This modification of the
                   6790:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6791:     <code class="filename">PLIST</code> itself.</p>
1.1       dsieger  6792: </div>
1.41      asau     6793: <div class="sect1">
1.1       dsieger  6794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6795: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6796: </h2></div></div></div>
                   6797: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6798:     in generating the binary package, set the variable
                   6799:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.207     leot     6800:     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.184     rillig   6801:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6802:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1       dsieger  6803: </div>
1.41      asau     6804: <div class="sect1">
1.1       dsieger  6805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6806: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6807: <p>Some packages decide to install a different set of files based on
                   6808:     the operating system being used. These differences can be
                   6809:     automatically handled by using the following files:</p>
                   6810: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6811: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6812: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6813: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6814: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6815: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6816: </ul></div>
1.1       dsieger  6817: </div>
1.41      asau     6818: <div class="sect1">
1.1       dsieger  6819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6820: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6821: <p>Some packages decide to generate hard-to-guess file names
                   6822:     during installation that are hard to wire down.</p>
                   6823: <p>In such cases, you can set the
                   6824:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6825:     terminated (with a semicolon) that will output PLIST entries which
                   6826:     will be appended to the PLIST</p>
                   6827: <p>You can find one example in editors/xemacs:</p>
                   6828: <pre class="programlisting">
                   6829: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6830: </pre>
                   6831: <p>which will append something like
                   6832:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6833:     <code class="filename">PLIST</code>.
                   6834:     </p>
1.1       dsieger  6835: </div>
1.41      asau     6836: <div class="sect1">
1.1       dsieger  6837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6838: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6839: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6840:     multiple (and unrelated) packages install files.  These
                   6841:     directories were problematic because you had to add special
                   6842:     tricks in the PLIST to conditionally remove them, or have some
                   6843:     centralized package handle them.</p>
                   6844: <p>In pkgsrc, it is now easy: Each package should create
                   6845:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6846:     will remove any directories left empty after uninstalling a
                   6847:     package.</p>
                   6848: <p>If a package needs an empty directory to work, create
                   6849:     the directory during installation as usual, and also add an
                   6850:     entry to the PLIST:
                   6851: 
                   6852: </p>
                   6853: <pre class="programlisting">
                   6854: @pkgdir path/to/empty/directory
                   6855: </pre>
                   6856: <p>
                   6857: 
                   6858:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6859:     <code class="varname">OWN_DIRS</code>.
1.1       dsieger  6860:     </p>
                   6861: </div>
1.184     rillig   6862: </div>
                   6863: <div class="chapter">
                   6864: <div class="titlepage"><div><div><h2 class="title">
                   6865: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6866: <div class="toc">
                   6867: <p><b>Table of Contents</b></p>
                   6868: <dl class="toc">
                   6869: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6870: <dd><dl>
                   6871: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6872: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6873: </dl></dd>
                   6874: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6875: <dd><dl>
                   6876: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6877: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6878: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6879: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6880: </dl></dd>
                   6881: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6882: <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>
                   6883: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6884: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6885: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6886: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6887: <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>
                   6888: </dl>
                   6889: </div>
                   6890: <p>This chapter describes the framework known as
                   6891: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6892: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6893: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6894:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6895: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6896:     provided that packages are correctly designed.</p></li>
                   6897: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6898: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6899: <li class="listitem"><p>Registration of system shells.</p></li>
                   6900: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6901: </ul></div>
                   6902: <p>The following sections inspect each of the above points in detail.</p>
                   6903: <p>You may be thinking that many of the things described here could be
                   6904: easily done with simple code in the package's post-installation target
                   6905: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6906: as the code in them is only executed when building from source.  Machines
                   6907: using binary packages could not benefit from it at all (as the code itself
                   6908: could be unavailable).  Therefore, the only way to achieve any of the items
                   6909: described above is by means of the installation scripts, which are
                   6910: automatically generated by pkginstall.</p>
1.41      asau     6911: <div class="sect1">
1.1       dsieger  6912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6913: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6914: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6915: of files and directories that belong to a package.  The names used in it
                   6916: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6917: which means that it cannot register files outside this directory (absolute
                   6918: path names are not allowed).  Despite this restriction, some packages need
                   6919: to install files outside this location; e.g., under
                   6920: <code class="filename">${VARBASE}</code> or
                   6921: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6922: is to create such files during installation time by using
                   6923: installation scripts.</p>
                   6924: <p>The generic installation scripts are shell scripts that can
                   6925: contain arbitrary code.  The list of scripts to execute is taken from
                   6926: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6927: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6928: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6929: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6930: commands, so they have the potential to create and manage files
                   6931: anywhere in the file system.</p>
                   6932: <p>Using these general installation files is not recommended, but
                   6933: may be needed in some special cases.  One reason for avoiding them is
                   6934: that the user has to trust the packager that there is no unwanted or
                   6935: simply erroneous code included in the installation script. Also,
                   6936: previously there were many similar scripts for the same functionality,
                   6937: and fixing a common error involved finding and changing all of
                   6938: them.</p>
                   6939: <p>The pkginstall framework offers another, standardized way.  It
                   6940: provides generic scripts to abstract the manipulation of such files
                   6941: and directories based on variables set in the package's
                   6942: <code class="filename">Makefile</code>.  The rest of this section describes
                   6943: these variables.</p>
                   6944: <div class="sect2">
                   6945: <div class="titlepage"><div><div><h3 class="title">
                   6946: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6947: <p>The following variables can be set to request the creation of
                   6948: directories anywhere in the file system:</p>
                   6949: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6950: <li class="listitem">
                   6951: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6952:     contain a list of directories that should be created and should attempt
                   6953:     to be destroyed by the installation scripts.  The difference between
                   6954:     the two is that the latter prompts the administrator to remove any
                   6955:     directories that may be left after deinstallation (because they were
                   6956:     not empty), while the former does not.  Example:</p>
                   6957: <pre class="programlisting">
                   6958: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6959: </pre>
                   6960: </li>
                   6961: <li class="listitem">
                   6962: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6963:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6964:     which directories should be created and should attempt to be destroyed
                   6965:     by the installation scripts.  Each tuple holds the following values,
                   6966:     separated by spaces: the directory name, its owner, its group and its
                   6967:     numerical mode.  For example:</p>
                   6968: <pre class="programlisting">
                   6969: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6970:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6971: </pre>
                   6972: <p>The difference between the two is exactly the same as their
                   6973:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6974: </li>
                   6975: </ul></div>
1.1       dsieger  6976: </div>
1.184     rillig   6977: <div class="sect2">
                   6978: <div class="titlepage"><div><div><h3 class="title">
                   6979: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6980: <p>Creating non-empty files outside the installation prefix is tricky
                   6981: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6982: To overcome this problem, the only solution is to extract the file in the
                   6983: known place (i.e., inside the installation prefix) and copy it to the
                   6984: appropriate location during installation (done by the installation scripts
                   6985: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6986: file</em></span> in the following paragraphs, which describe the variables
                   6987: that can be used to automatically and consistently handle files outside the
                   6988: installation prefix:</p>
                   6989: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6990: <li class="listitem">
                   6991: <p><code class="varname">CONF_FILES</code> and
                   6992:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6993:     During installation time, the master file is copied to the target one
                   6994:     if and only if the latter does not exist.  Upon deinstallation, the
                   6995:     target file is removed provided that it was not modified by the
                   6996:     installation.</p>
                   6997: <p>The difference between the two is that the latter prompts the
                   6998:     administrator to remove any files that may be left after
                   6999:     deinstallation (because they were not empty), while the former does
                   7000:     not.</p>
                   7001: </li>
                   7002: <li class="listitem">
                   7003: <p><code class="varname">CONF_FILES_PERMS</code> and
                   7004:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   7005:     files as well as their target locations.  For each of them, it also
                   7006:     specifies their owner, their group and their numeric permissions, in
                   7007:     this order.  For example:</p>
1.1       dsieger  7008: <pre class="programlisting">
1.184     rillig   7009: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   7010:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  7011: </pre>
1.184     rillig   7012: <p>The difference between the two is exactly the same as their
                   7013:     non-<code class="varname">PERMS</code> counterparts.</p>
                   7014: </li>
                   7015: </ul></div>
                   7016: </div>
1.1       dsieger  7017: </div>
1.41      asau     7018: <div class="sect1">
1.1       dsieger  7019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7020: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   7021: <p>Configuration files are special in the sense that they are installed
                   7022: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   7023: need special treatment during installation (most of which is automated by
                   7024: pkginstall).  The main concept you must bear in mind is that files marked
                   7025: as configuration files are automatically copied to the right place (somewhere
                   7026: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   7027: and only if</em></span> they didn't exist before.  Similarly, they will not
                   7028: be removed if they have local modifications.  This ensures that
                   7029: administrators never lose any custom changes they may have made.</p>
                   7030: <div class="sect2">
                   7031: <div class="titlepage"><div><div><h3 class="title">
                   7032: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   7033: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7034: specifies where configuration files shall be installed.  Its contents are
                   7035: set based upon the following variables:</p>
                   7036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7037: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7038:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7039:     be overridden by the user to point to his preferred location (e.g.,
                   7040:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7041:     Packages must not use it directly.</p></li>
                   7042: <li class="listitem">
                   7043: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7044:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7045:     for the package being built shall be installed.  The definition of this
                   7046:     variable only makes sense in the package's
                   7047:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7048: <p>As an example, consider the Apache package,
1.207     leot     7049:     <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.184     rillig   7050:     configuration files under the
                   7051:     <code class="filename">httpd/</code> subdirectory of
                   7052:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7053:     Makefile.</p>
                   7054: </li>
                   7055: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7056:     variable that holds this package's configuration directory (if
                   7057:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7058:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7059:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7060: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7061:     directory where the configuration files for the package identified by
                   7062:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7063: </ul></div>
                   7064: <p>Based on the above variables, pkginstall determines the value of
                   7065: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7066: variable that can be used within a package to refer to its configuration
                   7067: directory.  The algorithm used to set its value is basically the
                   7068: following:</p>
                   7069: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7070: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7071:     its value is used.</p></li>
                   7072: <li class="listitem"><p>If the previous variable is not defined but
                   7073:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7074:     <code class="filename">Makefile</code>, the resulting value is
                   7075:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7076: <li class="listitem"><p>Otherwise, it is set to
                   7077:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7078: </ol></div>
                   7079: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7080: 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
                   7081: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7082: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7083: </div>
                   7084: <div class="sect2">
                   7085: <div class="titlepage"><div><div><h3 class="title">
                   7086: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7087: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7088: known place, you need to teach each package where it shall install its
                   7089: files.  In some cases you will have to patch the package Makefiles to
                   7090: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7091: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7092: generated files:</p>
1.1       dsieger  7093: <pre class="programlisting">
1.184     rillig   7094: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       dsieger  7095: </pre>
1.184     rillig   7096: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7097: for</em></span> its configuration files, not where they will be originally
                   7098: installed (although the difference is never explicit,
                   7099: unfortunately).</p>
1.1       dsieger  7100: </div>
1.184     rillig   7101: <div class="sect2">
                   7102: <div class="titlepage"><div><div><h3 class="title">
                   7103: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7104: <p>As said before, pkginstall automatically handles configuration files.
                   7105: This means that <span class="strong"><strong>the packages themselves must not
                   7106: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7107: directly</strong></span>.  Bad news is that many software installation scripts
                   7108: will, out of the box, mess with the contents of that directory.  So what is
                   7109: the correct procedure to fix this issue?</p>
                   7110: <p>You must teach the package (usually by manually patching it) to
                   7111: install any configuration files under the examples hierarchy,
                   7112: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7113: <code class="filename">PLIST</code> registers them and the administrator always
                   7114: has the original copies available.</p>
                   7115: <p>Once the required configuration files are in place (i.e., under the
                   7116: examples hierarchy), the pkginstall framework can use them as master copies
                   7117: during the package installation to update what is in
                   7118: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7119: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7120: 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
                   7121: about their syntax and their purpose.  Here is an example, taken from the
1.207     leot     7122: <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.1       dsieger  7123: <pre class="programlisting">
1.184     rillig   7124: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7125: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       dsieger  7126: </pre>
1.184     rillig   7127: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7128: package and has no meaning outside it.</p>
1.1       dsieger  7129: </div>
1.184     rillig   7130: <div class="sect2">
                   7131: <div class="titlepage"><div><div><h3 class="title">
                   7132: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7133: <p>The automatic copying of config files can be toggled by setting the
                   7134: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7135: installation.</p>
1.1       dsieger  7136: </div>
                   7137: </div>
1.41      asau     7138: <div class="sect1">
1.1       dsieger  7139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7140: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7141: <p>System startup scripts are special files because they must be
                   7142: installed in a place known by the underlying OS, usually outside the
                   7143: 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
                   7144: can be used.  However, pkginstall provides a special mechanism to handle
                   7145: these files.</p>
                   7146: <p>In order to provide system startup scripts, the package has
                   7147: to:</p>
                   7148: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7149: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7150:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.223     nia      7151:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups-base/index.html" target="_top"><code class="filename">print/cups-base</code></a> package as an example, it
                   7152:     has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184     rillig   7153: <li class="listitem">
                   7154: <p>Tell pkginstall to handle it, appending the name of the script,
                   7155:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7156:     Continuing the previous example:</p>
                   7157: <pre class="programlisting">
                   7158: RCD_SCRIPTS+=   cupsd
                   7159: </pre>
                   7160: </li>
                   7161: </ol></div>
                   7162: <p>Once this is done, pkginstall will do the following steps for each
                   7163: script in an automated fashion:</p>
                   7164: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7165: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7166:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7167:     variable.</p></li>
                   7168: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7169:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7170:     that this master file must be explicitly registered in the
                   7171:     <code class="filename">PLIST</code>.</p></li>
                   7172: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7173:     from the examples hierarchy into the system-wide startup scripts
                   7174:     directory.</p></li>
                   7175: </ol></div>
                   7176: <div class="sect2">
                   7177: <div class="titlepage"><div><div><h3 class="title">
                   7178: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7179: <p>The automatic copying of config files can be toggled by setting the
                   7180: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7181: installation.  Note that the scripts will be always copied inside the
                   7182: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7183: matter what the value of this variable is.</p>
1.1       dsieger  7184: </div>
                   7185: </div>
1.184     rillig   7186: <div class="sect1">
                   7187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7188: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7189: <p>If a package needs to create special users and/or groups during
                   7190: installation, it can do so by using the pkginstall framework.</p>
                   7191: <p>Users can be created by adding entries to the
                   7192: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7193: syntax:</p>
                   7194: <pre class="programlisting">
                   7195: user:group
                   7196: </pre>
                   7197: <p>Further specification of user details may be done by setting
                   7198: per-user variables.
                   7199: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7200: numeric UID for the user.
                   7201: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7202: user's description or comment.
                   7203: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7204: user's home directory, and defaults to
                   7205: <code class="filename">/nonexistent</code> if not specified.
                   7206: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7207: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7208: not specified.</p>
                   7209: <p>Similarly, groups can be created by adding entries to the
                   7210: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7211: <pre class="programlisting">
                   7212: group
                   7213: </pre>
                   7214: <p>The numeric GID of the group may be set by defining
                   7215: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7216: <p>If a package needs to create the users and groups at an earlier
                   7217: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7218: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7219: <code class="literal">pre-install</code> to indicate the phase before which the
                   7220: users and groups are created. In this case, the numeric UIDs and GIDs
                   7221: of the created users and groups are automatically hardcoded into the
                   7222: final installation scripts.</p>
1.1       dsieger  7223: </div>
1.41      asau     7224: <div class="sect1">
1.1       dsieger  7225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7226: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7227: <p>Packages that install system shells should register them in the shell
                   7228: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7229: administrator.  This must be done from the installation scripts to keep
                   7230: binary packages working on any system.  pkginstall provides an easy way to
                   7231: accomplish this task.</p>
                   7232: <p>When a package provides a shell interpreter, it has to set the
                   7233: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7234: add some hooks to the installation scripts to handle it.  Consider the
1.207     leot     7235: 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.184     rillig   7236: <pre class="programlisting">
                   7237: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7238: </pre>
                   7239: <div class="sect2">
                   7240: <div class="titlepage"><div><div><h3 class="title">
                   7241: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7242: <p>The automatic registration of shell interpreters can be disabled by
                   7243: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7244: environment variable to <code class="literal">NO</code>.</p>
                   7245: </div>
1.1       dsieger  7246: </div>
1.41      asau     7247: <div class="sect1">
1.1       dsieger  7248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7249: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7250: <p>Packages that install X11 fonts should update the database files
                   7251: that index the fonts within each fonts directory.  This can easily be
                   7252: accomplished within the pkginstall framework.</p>
                   7253: <p>When a package installs X11 fonts, it must list the directories in
                   7254: which fonts are installed in the
                   7255: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7256: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7257: <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
                   7258: installation scripts to run the appropriate commands to update the fonts
                   7259: database files within each of those directories.  For convenience, if the
                   7260: directory path is relative, it is taken to be relative to the package's
1.207     leot     7261: 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.1       dsieger  7262: <pre class="programlisting">
1.184     rillig   7263: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  7264: </pre>
1.184     rillig   7265: <div class="sect2">
                   7266: <div class="titlepage"><div><div><h3 class="title">
                   7267: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7268: <p>The automatic update of fonts databases can be disabled by
                   7269: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7270: environment variable to <code class="literal">NO</code>.</p>
1.1       dsieger  7271: </div>
                   7272: </div>
                   7273: </div>
1.41      asau     7274: <div class="chapter">
1.1       dsieger  7275: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   7276: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1       dsieger  7277: <div class="toc">
                   7278: <p><b>Table of Contents</b></p>
1.100     leot     7279: <dl class="toc">
1.154     rillig   7280: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1       dsieger  7281: <dd><dl>
1.154     rillig   7282: <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>
                   7283: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7284: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7285: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7286: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7287: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7288: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7289: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7290: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7291: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7292: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7293: </dl></dd>
                   7294: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7295: <dd><dl>
                   7296: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7297: <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>
                   7298: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7299: </dl></dd>
                   7300: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7301: <dd><dl>
                   7302: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7303: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7304: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223     nia      7305: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154     rillig   7306: </dl></dd>
                   7307: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7308: <dd><dl>
                   7309: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7310: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205     wiz      7311: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223     nia      7312: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   7313: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   7314: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   7315: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154     rillig   7316: </dl></dd>
                   7317: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7318: <dd><dl>
                   7319: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7320: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172     rillig   7321: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7322: <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>
                   7323: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154     rillig   7324: </dl></dd>
                   7325: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7326: <dd><dl>
                   7327: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7328: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7329: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7330: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7331: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203     nia      7332: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig   7333: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7334: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203     nia      7335: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   7336: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   7337: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   7338: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   7339: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   7340: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   7341: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger  7342:     emulation</a></span></dt>
1.203     nia      7343: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   7344: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger  7345: </dl></dd>
1.154     rillig   7346: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7347: </dl>
                   7348: </div>
1.41      asau     7349: <div class="sect1">
1.1       dsieger  7350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7351: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1       dsieger  7352: <p>One appealing feature of pkgsrc is that it runs on many
1.108     rillig   7353:   different platforms. As a result, it is important to ensure,
                   7354:   where possible, that packages in pkgsrc are portable. This
                   7355:   chapter mentions some particular details you should pay
                   7356:   attention to while working on pkgsrc.</p>
1.41      asau     7357: <div class="sect2">
1.1       dsieger  7358: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7359: <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.1       dsieger  7360: </h3></div></div></div>
                   7361: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7362:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7363:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7364:     want to use those variables in the preprocessor directives of
1.207     leot     7365:     <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.1       dsieger  7366:     <code class="literal">.for</code>), you need to include the file
                   7367:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7368:     loads the user preferences.</p>
                   7369: <p>But note that some variables may not be completely defined
                   7370:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7371:     included, as they may contain references to variables that are
1.108     rillig   7372:     not yet defined. In shell commands (the lines in
                   7373:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7374:     is no problem, since variables are only expanded when they are
                   7375:     used. But in the preprocessor directives mentioned above and in
                   7376:     dependency lines (of the form <code class="literal">target:
1.1       dsieger  7377:     dependencies</code>) the variables are expanded at load
                   7378:     time.</p>
1.41      asau     7379: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7380: <h3 class="title">Note</h3>
1.108     rillig   7381: <p>To check whether a variable can be used at load time,
                   7382:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1       dsieger  7383: </div>
                   7384: </div>
1.41      asau     7385: <div class="sect2">
1.1       dsieger  7386: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7387: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1       dsieger  7388: <p>Occasionally, packages require interaction from the user,
                   7389:     and this can be in a number of ways:</p>
1.41      asau     7390: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7391: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7392:        interaction such as entering username/password or accepting a
                   7393:        license on a web page.</p></li>
1.23      wiz      7394: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7395:        passwords.</p></li>
1.23      wiz      7396: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7397: <li class="listitem"><p>help during the build process</p></li>
                   7398: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7399: </ul></div>
1.108     rillig   7400: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7401:     variable to define which stages need interaction. This should be
                   7402:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1       dsieger  7403: <pre class="programlisting">
                   7404: INTERACTIVE_STAGE=      configure install
1.111     sevan    7405: </pre>
1.1       dsieger  7406: <p>The user can then decide to skip this package by setting the
1.108     rillig   7407:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7408:     are also excluded from bulk builds.</p>
1.1       dsieger  7409: </div>
1.41      asau     7410: <div class="sect2">
1.1       dsieger  7411: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7412: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111     sevan    7413: <p>Authors of software can choose the licence under which software
                   7414:     can be copied.  The Free Software Foundation has declared some
                   7415:     licenses "Free", and the Open Source Initiative has a definition of
                   7416:     "Open Source".</p>
                   7417: <p>By default, pkgsrc allows packages with Free or Open Source
                   7418:     licenses to be built.  To allow packages with other licenses to be
                   7419:     built as well, the pkgsrc user needs to add these licenses to the
                   7420:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7421:     that this variable only affects which packages may be
                   7422:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7423:     restrict the actual use of the package and its redistribution.</p>
1.1       dsieger  7424: <p>One might want to only install packages with a BSD license,
1.108     rillig   7425:     or the GPL, and not the other.  The free licenses are added to the
1.111     sevan    7426:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.19      jnemeth  7427:     user can override the default by setting the
                   7428:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111     sevan    7429:     of "+=".  The licenses accepted by default are defined in the
                   7430:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7431:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1       dsieger  7432: <p>The license tag mechanism is intended to address
                   7433:     copyright-related issues surrounding building, installing and
                   7434:     using a package, and not to address redistribution issues (see
                   7435:     <code class="varname">RESTRICTED</code> and
1.111     sevan    7436:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19      jnemeth  7437:     Packages with redistribution restrictions should set these
                   7438:     tags.</p>
1.1       dsieger  7439: <p>Denoting that a package may be copied according to a
                   7440:     particular license is done by placing the license in
                   7441:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7442:     <code class="varname">LICENSE</code> variable to a string identifying the
1.207     leot     7443:     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.1       dsieger  7444: <pre class="programlisting">
                   7445: LICENSE=        xv-license
1.111     sevan    7446: </pre>
1.1       dsieger  7447: <p>When trying to build, the user will get a notice that the
                   7448:     package is covered by a license which has not been placed in the
                   7449:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7450: <pre class="programlisting">
                   7451: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7452: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7453: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7454: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7455: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7456: *** Error code 1
1.111     sevan    7457: </pre>
1.10      hubertf  7458: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7459:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7460:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7461:     convey to pkgsrc that it should not in the future fail because of
                   7462:     that license:</p>
                   7463: <pre class="programlisting">
                   7464: ACCEPTABLE_LICENSES+=xv-license
1.111     sevan    7465: </pre>
                   7466: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7467:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7468:     is deprecated because it does not crisply refer to a particular
                   7469:     license text.  Another problem with such usage is that it does not
                   7470:     enable a user to tell pkgsrc to proceed for a single package
                   7471:     without also telling pkgsrc to proceed for all packages with that
                   7472:     tag.</p>
                   7473: <div class="sect3">
                   7474: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7475: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48      rodent   7476: <p>When adding a package with a new license, the following steps
                   7477:     are required:</p>
                   7478: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7479: <li class="listitem">
1.169     rillig   7480: <p>Check whether the license qualifies as Free or Open Source by
                   7481:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7482:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111     sevan    7483:     Open Source Initiative</a>.  If this is the case, the filename in
                   7484:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7485:     <code class="filename">-license</code> suffix, and the license name should be
                   7486:     added to:</p>
1.48      rodent   7487: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     rillig   7488: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7489:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7490: <li class="listitem"><p>default_acceptable_licenses in
                   7491:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48      rodent   7492: </ul></div>
                   7493: </li>
1.169     rillig   7494: <li class="listitem"><p>The license text should be added to
                   7495:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7496:     licenses can be seen in this directory.</p></li>
1.48      rodent   7497: </ol></div>
1.111     sevan    7498: </div>
                   7499: <div class="sect3">
                   7500: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7501: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1       dsieger  7502: <p>When the license changes (in a way other than formatting),
1.111     sevan    7503:     make sure that the new license has a different name (e.g.,
1.1       dsieger  7504:     append the version number if it exists, or the date).  Just
                   7505:     because a user told pkgsrc to build programs under a previous
                   7506:     version of a license does not mean that pkgsrc should build
                   7507:     programs under the new licenses.  The higher-level point is that
                   7508:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7509:     test is a mechanistic test of whether a particular text has been
1.111     sevan    7510:     approved by either of two bodies (FSF or OSI).</p>
                   7511: </div>
1.1       dsieger  7512: </div>
1.41      asau     7513: <div class="sect2">
1.1       dsieger  7514: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7515: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1       dsieger  7516: <p>Some licenses restrict how software may be re-distributed.
1.111     sevan    7517:     By declaring the restrictions, package tools can
1.1       dsieger  7518:     automatically refrain from e.g. placing binary packages on FTP
                   7519:     sites.</p>
1.111     sevan    7520: <p>There are four possible restrictions, which are
1.1       dsieger  7521:     the cross product of sources (distfiles) and binaries not being
                   7522:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7523:     language in any license, and because non-Free licenses tend to be
                   7524:     different from each other, pkgsrc adopts a definition of FTP and
1.111     sevan    7525:     CD-ROM.
                   7526: 
                   7527:     "FTP" means making the source or binary file available over the
                   7528:     Internet at no charge.
                   7529: 
                   7530:     "CD-ROM" means making the source or binary available on some kind of
                   7531:     media, together with other source and binary packages, which is sold
                   7532:     for a distribution charge.
1.1       dsieger  7533:     </p>
                   7534: <p>In order to encode these restrictions, the package system
                   7535:     defines five make variables that can be set to note these
                   7536:     restrictions:</p>
1.41      asau     7537: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7538: <li class="listitem">
1.1       dsieger  7539: <p><code class="varname">RESTRICTED</code></p>
                   7540: <p>This variable should be set whenever a restriction
                   7541:        exists (regardless of its kind).  Set this variable to a
                   7542:        string containing the reason for the restriction.  It should
                   7543:        be understood that those wanting to understand the restriction
                   7544:        will have to read the license, and perhaps seek advice of
                   7545:        counsel.</p>
                   7546: </li>
1.23      wiz      7547: <li class="listitem">
1.1       dsieger  7548: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7549: <p>Binaries may not be placed on CD-ROM containing other
                   7550:        binary packages, for which a distribution charge may be made.
                   7551:        In this case, set this variable to
                   7552:        <code class="varname">${RESTRICTED}</code>.</p>
                   7553: </li>
1.23      wiz      7554: <li class="listitem">
1.1       dsieger  7555: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7556: <p>Binaries may not made available on the Internet without
                   7557:        charge.  In this case, set this variable to
                   7558:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7559:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7560: </li>
1.23      wiz      7561: <li class="listitem">
1.1       dsieger  7562: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7563: <p>Distfiles may not be placed on CD-ROM, together with
                   7564:        other distfiles, for which a fee may be charged.  In this
                   7565:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7566:        </p>
                   7567: </li>
1.23      wiz      7568: <li class="listitem">
1.1       dsieger  7569: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7570: <p>Distfiles may not made available via FTP at no charge.
                   7571:        In this case, set this variable to
                   7572:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7573:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7574: </li>
                   7575: </ul></div>
1.111     sevan    7576: <p>Please note that packages will be removed from pkgsrc when the
                   7577:     distfiles are not distributable and cannot be obtained for a period
                   7578:     of one full quarter branch. Packages with manual/interactive fetch
                   7579:     must have a maintainer and it is his/her responsibility to ensure
                   7580:     this.</p>
1.1       dsieger  7581: </div>
1.41      asau     7582: <div class="sect2">
1.1       dsieger  7583: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7584: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175     gutterid 7585: <p>Your package may depend on some other package being present,
                   7586:     and there are various ways of expressing this dependency.
                   7587:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7588:     <code class="varname">BUILD_DEPENDS</code>,
                   7589:     <code class="varname">TOOL_DEPENDS</code>, and
                   7590:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.1       dsieger  7591:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7592:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7593:     to handle dependencies, and which uses the variables named above.
1.184     rillig   7594:     See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175     gutterid 7595: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7596:     definition registers that pre-requisite in the binary package so it
                   7597:     will be pulled in when the binary package is later installed, whilst
                   7598:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7599:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7600:     dependency that is only needed for building or testing the resulting
1.184     rillig   7601:     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.1       dsieger  7602: <p>This means that if you only need a package present whilst
1.175     gutterid 7603:     you are building or testing, it should be noted as a
                   7604:     <code class="varname">TOOL_DEPENDS</code>,
                   7605:     <code class="varname">BUILD_DEPENDS</code>, or
                   7606:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.156     leot     7607:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7608:     packages, i.e. packages for the architecture where the package
                   7609:     is built;
                   7610:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175     gutterid 7611:     packages, i.e., packages for the architecture for which the package
1.156     leot     7612:     is built.</p>
1.175     gutterid 7613: <p>The format for a <code class="varname">DEPENDS</code>,
                   7614:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7615:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1       dsieger  7616: <pre class="programlisting">
                   7617: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.111     sevan    7618: </pre>
1.23      wiz      7619: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7620:     may include any of the wildcard version numbers recognized by
1.207     leot     7621:     <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.23      wiz      7622: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7623: <li class="listitem">
1.1       dsieger  7624: <p>If your package needs another package's binaries or
1.54      wiz      7625:        libraries to build and run, and if that package has a
1.1       dsieger  7626:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7627: <pre class="programlisting">
                   7628: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7629: </pre>
1.1       dsieger  7630: </li>
1.23      wiz      7631: <li class="listitem">
1.54      wiz      7632: <p>If your package needs another package's binaries or
                   7633:        libraries only for building, and if that package has a
                   7634:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7635: <pre class="programlisting">
                   7636: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7637: </pre>
1.54      wiz      7638: <p>but set
                   7639:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7640:        to make it a build dependency only. This case is rather
                   7641:        rare.</p>
                   7642: </li>
                   7643: <li class="listitem">
1.25      spz      7644: <p>If your package needs binaries from another package to build,
1.156     leot     7645:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1       dsieger  7646: <pre class="programlisting">
1.156     leot     7647: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111     sevan    7648: </pre>
1.1       dsieger  7649: </li>
1.156     leot     7650: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7651:        files to include, etc. from another package to build,
                   7652:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25      spz      7653: <li class="listitem"><p>If your package needs a library with which to link and
                   7654:        there is no <code class="filename">buildlink3.mk</code> file
                   7655:        available, create one. Using
                   7656:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7657:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7658: <li class="listitem">
1.25      spz      7659: <p>If your package needs some executable to be able to run
                   7660:        correctly and if there's no
                   7661:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7662:        using the <code class="varname">DEPENDS</code> variable. The
1.207     leot     7663:        <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.129     wiz      7664:        be able to execute the latex binary from the tex-latex-bin package
1.25      spz      7665:        when it runs, and that is specified:</p>
1.1       dsieger  7666: <pre class="programlisting">
1.129     wiz      7667: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111     sevan    7668: </pre>
1.25      spz      7669: </li>
1.175     gutterid 7670: <li class="listitem"><p>If your package includes a test suite that has extra
                   7671:         dependencies only required for this purpose (frequently this
                   7672:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7673:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25      spz      7674: <li class="listitem">
                   7675: <p>You can use wildcards in package dependencies. Note that
                   7676:        such wildcard dependencies are retained when creating binary
                   7677:        packages. The dependency is checked when installing the binary
                   7678:        package and any package which matches the pattern will be
                   7679:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7680: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7681:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7682:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7683:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7684: <p>Wildcards can also be used to specify that a package
                   7685:        will only build against a certain minimum version of a
                   7686:        pre-requisite:</p>
                   7687: <pre class="programlisting">
1.25      spz      7688: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.111     sevan    7689: </pre>
1.25      spz      7690: <p>This means that the package will build using version 6.0
                   7691:        of ImageMagick or newer. Such a dependency may be warranted
                   7692:        if, for example, the command line options of an executable
                   7693:        have changed.</p>
                   7694: <p>If you need to depend on minimum versions of libraries,
1.183     wiz      7695:        set
                   7696:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7697:        to the appropriate pattern before including its
                   7698:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7699: <pre class="programlisting">
                   7700: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7701: .include "../../graphics/jpeg/buildlink3.mk"
                   7702: </pre>
1.1       dsieger  7703: <p>For security fixes, please update the package
1.154     rillig   7704:        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.1       dsieger  7705:        information.</p>
                   7706: </li>
                   7707: </ol></div>
                   7708: <p>If your package needs files from another package to build,
                   7709:     add the relevant distribution files to
                   7710:     <code class="varname">DISTFILES</code>, so they will be extracted
1.207     leot     7711:     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.1       dsieger  7712:     (It relies on the jpeg sources being present in source form
                   7713:     during the build.)</p>
                   7714: </div>
1.41      asau     7715: <div class="sect2">
1.1       dsieger  7716: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7717: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226     gutterid 7718: <p>Your package may conflict with other packages users might
                   7719:     already have installed on their system, e.g., if your package
1.1       dsieger  7720:     installs the same set of files as another package in the pkgsrc
1.227   ! wiz      7721:     tree.</p>
1.207     leot     7722: <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>
                   7723:     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.142     leot     7724:     install the same shared library, thus you set in
                   7725:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7726: <pre class="programlisting">
                   7727: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7728:     </pre>
                   7729: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7730: <pre class="programlisting">
                   7731: CONFLICTS=      libXaw3d-[0-9]*
                   7732:     </pre>
1.207     leot     7733: <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.142     leot     7734:     that conflict with existing packages and abort. However, in many
                   7735:     situations this is too late in the process. Binary package managers
                   7736:     will not know about the conflict until they attempt to install the
                   7737:     package after already downloading it and all its dependencies.
                   7738:     Users may also waste time building a package and its dependencies
                   7739:     only to find out at the end that it conflicts with another package
                   7740:     they have installed.</p>
                   7741: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7742:     should be added in all cases where it is known that packages conflict
                   7743:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.207     leot     7744:     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.142     leot     7745:     managers to inform users that packages cannot be installed onto
                   7746:     the target system.</p>
1.1       dsieger  7747: </div>
1.41      asau     7748: <div class="sect2">
1.1       dsieger  7749: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7750: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7751: <p>There are several reasons why a package might be
                   7752:     instructed to not build under certain circumstances.  If the
                   7753:     package builds and runs on most platforms, the exceptions
1.83      dholland 7754:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7755:     the package builds and runs on a small handful of platforms,
                   7756:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7757:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7758:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7759:     (OS-version-platform) that can use glob-style
                   7760:     wildcards.</p>
                   7761: <p>If a package is not appropriate for some platforms (as
1.114     maya     7762:     opposed to merely broken), a different set of variables should be
1.83      dholland 7763:     used as this affects failure reporting and statistics.
                   7764:     If the package is appropriate for most platforms, the exceptions
1.1       dsieger  7765:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.83      dholland 7766:     the package is appropriate for only a small handful of platforms
                   7767:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1       dsieger  7768:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7769:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7770:     (OS-version-platform) that can use glob-style
                   7771:     wildcards.</p>
                   7772: <p>Some packages are tightly bound to a specific version of an
1.207     leot     7773:     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.1       dsieger  7774:     backwards compatible with other versions of the OS, and should be
                   7775:     uploaded to a version specific directory on the FTP server.  Mark
                   7776:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      7777:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  7778:     the package system internals, but may be used in the
                   7779:     future.</p>
                   7780: <p>If the package should be skipped (for example, because it
                   7781:     provides functionality already provided by the system), set
                   7782:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7783:     the package should fail because some preconditions are not met,
                   7784:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7785:     message.</p>
                   7786: </div>
1.41      asau     7787: <div class="sect2">
1.1       dsieger  7788: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7789: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7790: <p>To ensure that a package may not be deleted, once it has been
                   7791:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7792:     be set in the package Makefile. This will be carried into any
                   7793:     binary package that is made from this pkgsrc entry. A
1.23      wiz      7794:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.207     leot     7795:     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.23      wiz      7796:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  7797: </div>
1.41      asau     7798: <div class="sect2">
1.1       dsieger  7799: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7800: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7801: <p>When a vulnerability is found, this should be noted in
1.205     wiz      7802:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
                   7803:     Entries in that file consist of three parts:</p>
                   7804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7805: <li class="listitem"><p>package version pattern</p></li>
                   7806: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   7807: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   7808: </ul></div>
                   7809: <p>For the package version pattern please always use `&lt;' to
                   7810:     mark an upper bound (not `&lt;='!). This will avoid possible
                   7811:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   7812:     related to security fixes. Lower bounds can be added too, using
                   7813:     '&gt;' or '&gt;='. For example,
1.206     wiz      7814:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.2</code></span>&#8221;</span> would mark
1.205     wiz      7815:     versions 1.0 (included) to 1.2 (excluded) of
                   7816:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo</code></span>&#8221;</span> as affected by the security
                   7817:     issue.</p>
                   7818: <p>Entries should always be added at the bottom of the file.</p>
                   7819: <p>When fixing packages, please modify the upper bound of the
                   7820:     corresponding entry. To continue the previous example, if a fix
                   7821:     was backported to version 1.1nb2, change the previous pattern to
1.206     wiz      7822:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>&#8221;</span>.</p>
1.205     wiz      7823: <p>To locally test a package version pattern against a
                   7824:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   7825:     pmatch</strong></span> command.</p>
                   7826: <p>The URL should be as permanent as possible and provide as
                   7827:     much information about the issue as possible.  CVE entries are
                   7828:     preferred.</p>
                   7829: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31      wiz      7830:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  7831: <p>After fixing the vulnerability by a patch, its
1.31      wiz      7832:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7833:     course not necessary if the problem is fixed by using a newer
                   7834:     release of the software), and the pattern in the
                   7835:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  7836: <p>Also, if the fix should be applied to the stable pkgsrc
                   7837:     branch, be sure to submit a pullup request!</p>
                   7838: <p>Binary packages already on ftp.NetBSD.org will be handled
                   7839:     semi-automatically by a weekly cron job.</p>
1.205     wiz      7840: <p>In case a security issue is disputed, please contact
                   7841:     pkgsrc-security@NetBSD.org.</p>
1.1       dsieger  7842: </div>
1.41      asau     7843: <div class="sect2">
1.1       dsieger  7844: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7845: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  7846: <p>When making fixes to an existing package it can be useful
                   7847:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7848:     avoid conflicting with future versions by the original author, a
1.23      wiz      7849:     <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.1       dsieger  7850:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      7851:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7852:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  7853: <pre class="programlisting">
                   7854: DISTNAME=       foo-17.42
                   7855: PKGREVISION=    9
1.111     sevan    7856: </pre>
1.1       dsieger  7857: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      7858:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7859:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  7860:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7861:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   7862: <p>When a new release of the package is released, the
                   7863:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7864:     minor release of the above package, things should be like:</p>
                   7865: <pre class="programlisting">
                   7866: DISTNAME=       foo-17.43
1.111     sevan    7867: </pre>
1.1       dsieger  7868: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7869:     non-trivial change in the resulting binary package.  Without a
                   7870:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7871:     version installed has no way of knowing that their package is out
                   7872:     of date.  Thus, changes without increasing
                   7873:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7874:     trivial that no reasonable person would want to upgrade", and this
                   7875:     is the rough test for when increasing
                   7876:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7877:     changes that do not merit increasing
                   7878:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     7879: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7880: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169     rillig   7881:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7882:       comments in Makefile.</p></li>
                   7883: <li class="listitem"><p>Changing build variables if the resulting binary
                   7884:       package is the same.</p></li>
                   7885: <li class="listitem"><p>Changing
                   7886:       <code class="filename">DESCR</code>.</p></li>
                   7887: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7888:       default options don't change.</p></li>
1.1       dsieger  7889: </ul></div>
                   7890: <p>Examples of changes that do merit an increase to
                   7891:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     7892: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     rillig   7893: <li class="listitem"><p>Security fixes</p></li>
                   7894: <li class="listitem"><p>Changes or additions to a patch
                   7895:       file</p></li>
                   7896: <li class="listitem"><p>Changes to the
                   7897:       <code class="filename">PLIST</code></p></li>
                   7898: <li class="listitem"><p>A dependency is changed or
                   7899:       renamed.</p></li>
1.1       dsieger  7900: </ul></div>
                   7901: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7902:     changes.</p>
                   7903: </div>
1.41      asau     7904: <div class="sect2">
1.1       dsieger  7905: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7906: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180     rillig   7907: <p>When you want to replace the same text in multiple files, or
                   7908: multiple times in the same file, it is cumbersome to maintain a patch
                   7909: file for this. This is where the SUBST framework steps in. It provides an
                   7910: easy-to-use interface for replacing text in files. It just needs the
                   7911: following information:</p>
                   7912: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7913: <li class="listitem"><p>In which phase of the package build cycle should the
                   7914: replacement happen?</p></li>
                   7915: <li class="listitem"><p>In which files should the replacement
1.172     rillig   7916: happen?</p></li>
1.180     rillig   7917: <li class="listitem"><p>Which text should be replaced with
                   7918: what?</p></li>
1.172     rillig   7919: </ul></div>
                   7920: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180     rillig   7921: variables. A minimal example is:</p>
                   7922: <pre class="programlisting">
                   7923: SUBST_CLASSES+=         paths
                   7924: SUBST_STAGE.paths=      pre-configure
                   7925: SUBST_FILES.paths=      src/*.c
                   7926: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7927: </pre>
                   7928: <p>Translated into English, it means: In the pre-configure stage (that
                   7929: is, after applying the patches from the patches/ directory and before
                   7930: running the configure script and the portability check), replace the text
                   7931: <code class="literal">/usr/local</code> with the content of the variable
                   7932: <code class="varname">PREFIX</code>.</p>
                   7933: <p>Each SUBST block starts by appending an identifier to
                   7934: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7935: identifier can be chosen freely by the package. If there should ever be
                   7936: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7937: early, so don't worry about name collisions.</p>
                   7938: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7939: SUBST block are parameterized using this identifier. In the remainder of
                   7940: this section, these parameterized variables are written as
                   7941: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7942: <pre class="programlisting">
                   7943: SUBST_CLASSES+=         paths
                   7944: SUBST_STAGE.paths=      pre-configure
                   7945: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7946: SUBST_FILES.paths=      src/*.c
                   7947: SUBST_FILES.paths+=     scripts/*.sh
                   7948: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7949: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7950: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7951: </pre>
                   7952: <p>To get a complete picture about the SUBST substitutions, run
                   7953: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7954: expected, run pkglint on the package, which detects several typical
                   7955: mistakes surrounding the SUBST blocks. For any questions that might
                   7956: remain after this, have a look at
                   7957: <code class="filename">mk/subst.mk</code>.</p>
                   7958: <div class="sect3">
                   7959: <div class="titlepage"><div><div><h4 class="title">
                   7960: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7961: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7962: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7963: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7964: popular stages are, in chronological order:</p>
                   7965: <div class="variablelist"><dl class="variablelist">
                   7966: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7967: <dd>
                   7968: <p>The substitutions are applied immediately after the
                   7969: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7970: package will leave no traces of the original files.</p>
                   7971: <p>When the substitution applies to files for which there is also a
                   7972: patch in the <code class="filename">patches/</code> directory, this means that the
                   7973: patches will be computed based on the result of the substitution. When
                   7974: these patches are sent to the upstream maintainer later, to be fixed in
                   7975: the upstream package, these patches may no longer match what the upstream
                   7976: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7977: often a better choice.</p>
                   7978: </dd>
                   7979: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7980: <dd>
                   7981: <p>The substitutions are applied after the patches from the
                   7982: <code class="filename">patches/</code> directory. This makes it possible to run
                   7983: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207     leot     7984: 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.180     rillig   7985: <p>When updating the patches, it is helpful to explicitly separate the
                   7986: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7987: configure</strong></span>, and to only edit the patches between these commands.
                   7988: Otherwise the substitutions from the SUBST block will end up in the patch
                   7989: file. When this happens in really obvious ways, pkglint will complain
                   7990: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7991: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7992: can only detect these really obvious
                   7993: cases.</p>
                   7994: </dd>
                   7995: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7996: <dd><p>This stage should only be used if the package defines a
                   7997: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7998: happen after that. Typical examples are packages that use the
                   7999: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   8000: script from
                   8001: <code class="filename">configure.ac</code>.</p></dd>
                   8002: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   8003: <dd><p>This stage is used to fix up any mistakes by the
                   8004: configure stage.</p></dd>
                   8005: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   8006: <dd><p>This stage should only be used for substitutions that are
                   8007: clearly related to building the package, not for fixing the
                   8008: configuration. Substitutions for pathnames (such as replacing
                   8009: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   8010: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   8011: actual username) belong in pre-configure or post-configure
                   8012: instead.</p></dd>
                   8013: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   8014: <dd>
                   8015: <p>Just as with pre-build, this stage should only be used
                   8016: for substitutions that are clearly related to building the package, not
                   8017: for fixing the configuration. Substitutions for pathnames (such as
                   8018: replacing <code class="filename">/usr/local</code> with
                   8019: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   8020: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   8021: pre-configure or post-configure instead.</p>
                   8022: <p>A typical use is to update pkg-config files to include the rpath
                   8023: compiler options.</p>
                   8024: </dd>
                   8025: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8026: <dd><p>In general, the install phase should be as simple as
                   8027: possible. As with the pre-build and post-build stages, it should not be
                   8028: used to fix pathnames or user names, these belong in pre-configure
                   8029: instead. There are only few legitimate use cases for applying
                   8030: substitutions in this stage.</p></dd>
                   8031: </dl></div>
                   8032: </div>
                   8033: <div class="sect3">
                   8034: <div class="titlepage"><div><div><h4 class="title">
1.181     rillig   8035: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180     rillig   8036: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8037: filename patterns. These patterns are relative to
                   8038: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8039: A typical example is:</p>
                   8040: <pre class="programlisting">
                   8041: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8042: </pre>
                   8043: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8044: implementation checks that each filename pattern that is mentioned here
                   8045: has an effect. For example, if none of the
                   8046: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8047: and substituted, that filename pattern is redundant and should be left
1.181     rillig   8048: out. By default, the SUBST framework will complain with an error message.
                   8049: If the text to be substituted occurs in some of the files from a single
                   8050: pattern, but not in all of them, that is totally ok, and the SUBST
1.180     rillig   8051: framework will only print an INFO message for those files.</p>
                   8052: <p>If there is a good reason for having redundant filename patterns,
1.181     rillig   8053: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180     rillig   8054: <p>Another popular way of choosing the files for the substitutions is
                   8055: via a shell command, like this:</p>
                   8056: <pre class="programlisting">
1.181     rillig   8057: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.180     rillig   8058: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8059: </pre>
                   8060: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8061: freely chosen and independent of the SUBST framework.</p>
                   8062: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8063: lists each file individually. Thereby chances are higher that there are
                   8064: filename patterns in which no substitution happens. Since the SUBST
                   8065: framework cannot know whether the filename patterns in
                   8066: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8067: Makefile (where any redundant filename pattern would be suspicious) or
                   8068: been generated by a shell command (in which redundant filename patterns
                   8069: are more likely and to be expected), it will complain about these
                   8070: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8071: command to generate the list of filename patterns often need to set
                   8072: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8073: </div>
                   8074: <div class="sect3">
                   8075: <div class="titlepage"><div><div><h4 class="title">
                   8076: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8077: <p>In most cases, the substitutions are given using one or more
1.207     leot     8078: <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.180     rillig   8079: <pre class="programlisting">
                   8080: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8081: </pre>
                   8082: <p>Each of the sed commands needs to be preceded by the
                   8083: <code class="literal">-e</code> option and should be specified on a line of its
                   8084: own, to avoid hiding short sed commands at the end of a line.</p>
                   8085: <p>Since the sed commands often contain shell metacharacters as the
                   8086: separator (the <code class="literal">|</code> in the above example), it is common
                   8087: to enclose them in single quotes.</p>
                   8088: <p>A common substitution is to replace placeholders of the form
                   8089: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8090: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8091: <pre class="programlisting">
                   8092: SUBST_VARS.path=        PREFIX
                   8093: </pre>
                   8094: <p>This type of substitutions is typically done by the GNU configure
1.181     rillig   8095: scripts during the do-configure stage, but in some cases these need to be
                   8096: overridden. The same pattern is also used when a package defines patches
                   8097: that replace previously hard-coded paths like
                   8098: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8099: placeholder first, which then gets substituted by the actual
                   8100: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8101: cases, it works equally well to just use the SUBST framework to directly
                   8102: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8103: thereby omitting the intermediate patch file.</p>
1.180     rillig   8104: <p>If the above is not flexible enough, it is possible to not use sed
                   8105: at all for the substitution but to specify an entirely different command,
                   8106: like this:</p>
1.1       dsieger  8107: <pre class="programlisting">
1.180     rillig   8108: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8109: </pre>
                   8110: <p>This is used for the few remaining packages in which the
                   8111: distributed files use Windows-style line endings that need to be
                   8112: converted to UNIX-style line endings.</p>
                   8113: </div>
                   8114: <div class="sect3">
                   8115: <div class="titlepage"><div><div><h4 class="title">
                   8116: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8117: <p>When a SUBST block is applied during a package build, a message is
                   8118: logged. The default message is fine for most purposes but can be
                   8119: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8120: message.</p>
                   8121: </div>
1.1       dsieger  8122: </div>
                   8123: </div>
1.41      asau     8124: <div class="sect1">
1.1       dsieger  8125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8126: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     8127: <div class="sect2">
1.1       dsieger  8128: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8129: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  8130: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8131:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8132:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8133:     with the name of each file to download as an argument, expecting
                   8134:     it to output the URL of the directory from which to download
1.207     leot     8135:     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.1       dsieger  8136:     example of this usage.</p>
                   8137: <p>If the download can't be automated, because the user must
                   8138:     submit personal information to apply for a password, or must pay
                   8139:     for the source, or whatever, you can set
                   8140:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8141:     displayed to the user before aborting the build. Example:</p>
                   8142: <pre class="programlisting">
                   8143: FETCH_MESSAGE=  "Please download the files"
                   8144: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8145: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111     sevan    8146: </pre>
1.1       dsieger  8147: </div>
1.41      asau     8148: <div class="sect2">
1.1       dsieger  8149: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8150: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  8151: <p>Sometimes authors of a software package make some
                   8152:     modifications after the software was released, and they put up a
                   8153:     new distfile without changing the package's version number. If a
                   8154:     package is already in pkgsrc at that time, the checksum will
                   8155:     no longer match. The contents of the new distfile should be
                   8156:     compared against the old one before changing anything, to make
                   8157:     sure the distfile was really updated on purpose, and that
                   8158:     no trojan horse or so crept in.
                   8159:     Please mention that the distfiles were compared and what was found
1.53      rodent   8160:     in your commit message.</p>
1.109     wiz      8161: <p>Then, the correct way to work around this is to set
                   8162:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8163:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8164:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8165:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.1       dsieger  8166:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.154     rillig   8167:     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.1       dsieger  8168:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109     wiz      8169:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8170:     be appended, like
                   8171:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169     rillig   8172: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8173:     name does not contain a version and the distfile is apt to change. In
                   8174:     cases where the likelihood of this is very small,
                   8175:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8176:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8177:     distfile name changes, even if a package is being moved or
                   8178:     renamed.</p>
1.53      rodent   8179: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1       dsieger  8180:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8181:     path in the filenames.
1.53      rodent   8182:     Also, increase the PKGREVISION if the installed package is different.
1.1       dsieger  8183:     Furthermore, a mail to the package's authors seems appropriate
                   8184:     telling them that changing distfiles after releases without
                   8185:     changing the file names is not good practice.</p>
                   8186: </div>
1.88      tnn      8187: <div class="sect2">
                   8188: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8189: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169     rillig   8190: <p>Helper methods exist for packages hosted on github.com which
                   8191:     will often have distfile names that clash with other packages, for
                   8192:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8193:     from below:</p>
1.88      tnn      8194: <div class="sect3">
                   8195: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8196: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169     rillig   8197: <p>If your distfile URL looks similar to
1.189     bacon    8198:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169     rillig   8199:       then you are packaging a tagged release.</p>
1.88      tnn      8200: <pre class="programlisting">
1.189     bacon    8201: DISTNAME=       example-1.0
1.90      tnn      8202: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    8203: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      8204: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      8205: EXTRACT_SUFX=   .zip
                   8206: </pre>
                   8207: </div>
                   8208: <div class="sect3">
                   8209: <div class="titlepage"><div><div><h4 class="title">
1.189     bacon    8210: <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>
                   8211: <p>If your distfile looks similar to
                   8212:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8213:       release, then set the package version to 0.0.0.N, where N is the number
                   8214:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8215:       This will (almost) ensure that the first tagged release will have a
                   8216:       version greater than this one so that package upgrades will function
                   8217:       properly.</p>
                   8218: <pre class="programlisting">
                   8219: DISTNAME=       example-0.0.0.347
                   8220: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8221: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8222: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8223: </pre>
                   8224: </div>
                   8225: <div class="sect3">
                   8226: <div class="titlepage"><div><div><h4 class="title">
                   8227: <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>
                   8228: <p>If your distfile looks similar to
                   8229:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8230:       then include the last release version and the commit count since that
                   8231:       release in the package version and set GITHUB_TAG to the commit hash.
                   8232:       The latest release and commit count are shown in the output of
                   8233:       "git describe --tags":
                   8234:       </p>
                   8235: <pre class="screen">
                   8236: # git clone https://github.com/username/example
                   8237: # cd example
                   8238: # git describe --tags
                   8239: 1.2.3-5-g988881a
                   8240: </pre>
1.88      tnn      8241: <pre class="programlisting">
1.189     bacon    8242: DISTNAME=       example-1.2.3.5
                   8243: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8244: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      8245: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111     sevan    8246: </pre>
1.88      tnn      8247: </div>
                   8248: <div class="sect3">
                   8249: <div class="titlepage"><div><div><h4 class="title">
1.189     bacon    8250: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169     rillig   8251: <p>If your distfile URL looks similar to
1.189     bacon    8252:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169     rillig   8253:       then you are packaging a release.</p>
1.88      tnn      8254: <pre class="programlisting">
                   8255: DISTNAME=       offensive-1.6
1.90      tnn      8256: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8257: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    8258: GITHUB_PROJECT= example
1.90      tnn      8259: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8260: EXTRACT_SUFX=   .zip
1.111     sevan    8261: </pre>
1.88      tnn      8262: </div>
                   8263: </div>
1.1       dsieger  8264: </div>
1.41      asau     8265: <div class="sect1">
1.1       dsieger  8266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8267: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     8268: <div class="sect2">
1.1       dsieger  8269: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8270: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8271: <p>pkgsrc supports many different machines, with different
                   8272:     object formats like a.out and ELF, and varying abilities to do
                   8273:     shared library and dynamic loading at all. To accompany this,
                   8274:     varying commands and options have to be passed to the
                   8275:     compiler, linker, etc. to get the Right Thing, which can be
                   8276:     pretty annoying especially if you don't have all the machines
                   8277:     at your hand to test things.  The
1.207     leot     8278:     <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.23      wiz      8279:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8280:     both static and dynamic libraries from a set of source files,
                   8281:     thus being platform-independent.</p>
                   8282: <p>Here's how to use libtool in a package in seven simple
                   8283:     steps:</p>
1.23      wiz      8284: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8285: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8286:        Makefile.</p></li>
1.23      wiz      8287: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8288:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8289:        add it to the definition of <code class="varname">CC</code>, if only
                   8290:        libraries are being built in a given Makefile. This one command
                   8291:        will build both PIC and non-PIC library objects, so you need not
                   8292:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8293: <li class="listitem">
1.1       dsieger  8294: <p>For the linking of the library, remove any
1.23      wiz      8295:        <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
                   8296:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8297: <pre class="programlisting">
                   8298: ${LIBTOOL} --mode=link \
                   8299:     ${CC} -o ${.TARGET:.a=.la} \
                   8300:         ${OBJS:.o=.lo} \
                   8301:         -rpath ${PREFIX}/lib \
                   8302:         -version-info major:minor
1.111     sevan    8303: </pre>
1.1       dsieger  8304: <p>Note that the library is changed to have a
                   8305:        <code class="filename">.la</code> extension, and the objects are
                   8306:        changed to have a <code class="filename">.lo</code>
                   8307:        extension. Change <code class="varname">OBJS</code> as
                   8308:        necessary. This automatically creates all of the
                   8309:        <code class="filename">.a</code>,
                   8310:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8311:        necessary) in the build directory. Be sure to include
1.23      wiz      8312:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8313:        minor are zero, as libtool will otherwise strip off the
                   8314:        shared library version.</p>
                   8315: <p>From the libtool manual:</p>
                   8316: <pre class="programlisting">
                   8317: So, libtool library versions are described by three integers:
                   8318: 
                   8319: CURRENT
                   8320: The most recent interface number that this library implements.
                   8321: 
                   8322: REVISION
                   8323: The implementation number of the CURRENT interface.
                   8324: 
                   8325: AGE
                   8326: The difference between the newest and oldest interfaces that
                   8327: this library implements.  In other words, the library implements
                   8328: all the interface numbers in the range from number `CURRENT -
                   8329: AGE' to `CURRENT'.
                   8330: 
                   8331: If two libraries have identical CURRENT and AGE numbers, then the
                   8332: dynamic linker chooses the library with the greater REVISION number.
1.111     sevan    8333: </pre>
1.23      wiz      8334: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8335:        different results for a.out and ELF (excluding symlinks)
                   8336:        in only one case. An ELF library of the form
1.23      wiz      8337:        <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.1       dsieger  8338:        will have a symlink of
1.23      wiz      8339:        <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.1       dsieger  8340:        on an a.out platform. This is handled
                   8341:        automatically.</p>
1.23      wiz      8342: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8343:        directory of the library being built.</p>
                   8344: <p>In the <code class="filename">PLIST</code>, include only the
                   8345:        <code class="filename">.la</code> file, the other files will be
                   8346:        added automatically.</p>
                   8347: </li>
1.23      wiz      8348: <li class="listitem">
1.1       dsieger  8349: <p>When linking shared object (<code class="filename">.so</code>)
1.207     leot     8350:        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.23      wiz      8351:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8352:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8353:        tacked on.</p>
                   8354: <p>The <code class="filename">PLIST</code> file gets the
                   8355:        <code class="filename">foo.so</code> entry.</p>
                   8356: </li>
1.23      wiz      8357: <li class="listitem">
1.1       dsieger  8358: <p>When linking programs that depend on these libraries
                   8359:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.207     leot     8360:        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.23      wiz      8361:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8362:        libraries (static or shared), but please be aware that
                   8363:        libtool will not allow you to specify a relative path in
1.23      wiz      8364:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8365:        expects you to change that argument to be the
                   8366:        <code class="filename">.la</code> file. e.g.</p>
                   8367: <pre class="programlisting">
                   8368: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111     sevan    8369: </pre>
1.1       dsieger  8370: <p>should be changed to:</p>
                   8371: <pre class="programlisting">
                   8372: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111     sevan    8373: </pre>
1.1       dsieger  8374: <p>and it will do the right thing with the libraries.</p>
                   8375: </li>
1.23      wiz      8376: <li class="listitem">
1.207     leot     8377: <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>
                   8378:        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.23      wiz      8379:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8380:        <code class="filename">.la</code>. e.g.</p>
                   8381: <pre class="programlisting">
1.22      jakllsch 8382: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111     sevan    8383: </pre>
1.1       dsieger  8384: <p>This will install the static <code class="filename">.a</code>,
                   8385:        shared library, any needed symlinks, and run
1.207     leot     8386:        <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.1       dsieger  8387: </li>
1.23      wiz      8388: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8389:        the <code class="filename">.la</code>
                   8390:        file (this is a change from previous behaviour).</p></li>
                   8391: </ol></div>
                   8392: </div>
1.41      asau     8393: <div class="sect2">
1.1       dsieger  8394: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8395: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8396: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8397:     package Makefile. This will override the package's own libtool
                   8398:     in most cases.  For older libtool using packages,  libtool is
                   8399:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8400:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8401:     configure; find work*/ -name libtool</strong></span>.</p>
                   8402: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8403:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8404:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8405:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8406:     package's libtool script(s), set it as appropriate.</p>
                   8407: <p>If you do not need <code class="filename">*.a</code> static
                   8408:     libraries built and installed, then use
                   8409:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8410: <p>If your package makes use of the platform-independent library
                   8411:     for loading dynamic shared objects, that comes with libtool
                   8412:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8413: <p>Some packages use libtool incorrectly so that the package
                   8414:     may not work or build in some circumstances. Some of the more
                   8415:     common errors are:</p>
1.41      asau     8416: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8417: <li class="listitem">
1.1       dsieger  8418: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8419:        executable or library. This in itself isn't a problem if one of two things
                   8420:        has been done:</p>
1.23      wiz      8421: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8422: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8423:            <code class="filename">libfoo.la</code>, not
                   8424:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8425: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8426: </ol></div>
                   8427: </li>
1.23      wiz      8428: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8429:        The function lt_dlinit() should be called and the macro
                   8430:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8431:        executables.</p></li>
                   8432: </ul></div>
                   8433: </div>
1.41      asau     8434: <div class="sect2">
1.1       dsieger  8435: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8436: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8437: <p>If a package needs GNU autoconf or automake to be executed
1.223     nia      8438:     to regenerate the
                   8439:     <code class="filename">configure</code>
                   8440:     script and <code class="filename">Makefile.in</code> makefile
                   8441:     templates from <code class="filename">configure.ac</code> and
                   8442:     <code class="filename">Makefile.am</code>,
                   8443:     then they should be executed in a pre-configure target:</p>
1.1       dsieger  8444: <pre class="programlisting">
1.223     nia      8445: USE_TOOLS+=    autoconf automake autoreconf
                   8446: GNU_CONFIGURE= yes
1.1       dsieger  8447: ...
                   8448: 
                   8449: pre-configure:
1.223     nia      8450:         set -e; cd ${WRKSRC} &amp;&amp; autoreconf -fi
1.1       dsieger  8451: ...
1.111     sevan    8452: </pre>
1.223     nia      8453: <p>Packages which use GNU Automake will sometimes
                   8454:     require GNU Make (<code class="literal">gmake</code> in
                   8455:     <code class="varname">USE_TOOLS</code>),
                   8456:     but not always.  Note that autoreconf
                   8457:     only needs to be executed if <code class="filename">configure.ac</code>
                   8458:     or Makefiles are modified, or <code class="filename">configure</code>
                   8459:     is not present.</p>
1.1       dsieger  8460: <p>There are times when the configure process makes
                   8461:     additional changes to the generated files, which then causes
                   8462:     the build process to try to re-execute the automake sequence.
                   8463:     This is prevented by touching various files in the configure
                   8464:     stage. If this causes problems with your package you can set
                   8465:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8466:     Makefile.</p>
                   8467: </div>
1.223     nia      8468: <div class="sect2">
                   8469: <div class="titlepage"><div><div><h3 class="title">
                   8470: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
                   8471: <p>Packages using Meson to configure need to include:
                   8472: 
                   8473: </p>
                   8474: <pre class="programlisting">
                   8475: .include "../../devel/meson/build.mk"
                   8476: </pre>
                   8477: <p>In nearly all cases (any program with dependencies),
                   8478:     pkg-config needs to be added to
                   8479:     <code class="varname">USE_TOOLS</code>.  If the package installs
                   8480:     translation files for non-English languages, also
                   8481:     add msgfmt and xgettext:
                   8482: 
                   8483: </p>
                   8484: <pre class="programlisting">
                   8485: USE_TOOLS+=    pkg-config msgfmt xgettext
                   8486: </pre>
                   8487: <p>If any options need to be passed to Meson, use
                   8488:     <code class="varname">MESON_ARGS</code> instead of
                   8489:     <code class="varname">CONFIGURE_ARGS</code>:
                   8490: 
                   8491: </p>
                   8492: <pre class="programlisting">
                   8493: MESON_ARGS+=   -Dx11=false
                   8494: </pre>
                   8495: </div>
1.1       dsieger  8496: </div>
1.41      asau     8497: <div class="sect1">
1.1       dsieger  8498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8499: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41      asau     8500: <div class="sect2">
1.1       dsieger  8501: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8502: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.223     nia      8503: <p>Compilers for the C and C++ languages comes with
1.1       dsieger  8504:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8505:     is written in C and will hide all other compilers (via the wrapper
1.184     rillig   8506:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8507: <p>To declare which language's compiler a package needs, set
                   8508:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212     wiz      8509:     currently are:
                   8510:     </p>
                   8511: <pre class="programlisting">
                   8512:        c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
                   8513:        c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
                   8514:        fortran77, java, objc, obj-c++, and ada.
                   8515:     </pre>
                   8516: <p>
                   8517:     (and any combination).  The default is
1.23      wiz      8518:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8519:     written in C++, usually need a C compiler for the configure
                   8520:     phase.</p>
1.223     nia      8521: <p>To express a general requirement on a specific C or C++
                   8522:     version, normally only <code class="varname">GCC_REQD</code> needs to be set.
                   8523:     For example, GCC 7 includes support for C++17, so if the package uses
                   8524:     C++17 it should specify:
                   8525: 
                   8526:     </p>
                   8527: <pre class="programlisting">
                   8528:        GCC_REQD+=      7
                   8529:     </pre>
                   8530: <p>Language variants like <code class="literal">c++11</code> for
                   8531:     <code class="varname">USE_LANGUAGES</code> should only be specified
                   8532:     if the package does not explicitly set <code class="literal">-std=...</code>
                   8533:     when compiling (i.e. the package assumes the compiler defaults to
                   8534:     C++11 or some other standard).  This is usually a bug in the
                   8535:     upstream build system.</p>
                   8536: <p>GCC version 5 includes support for C++14, while GCC 4.7 includes
                   8537:     more-or-less complete support for C++11.  For more information, consult
                   8538:     <a class="ulink" href="https://gcc.gnu.org/projects/cxx-status.html" target="_top">GCC's own documentation on programming language support.</a></p>
1.1       dsieger  8539: </div>
1.41      asau     8540: <div class="sect2">
1.1       dsieger  8541: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8542: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1       dsieger  8543: <p>If a program is written in Java, use the Java framework in
                   8544:     pkgsrc.  The package must include
                   8545:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8546:     provides the following variables:</p>
1.41      asau     8547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8548: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8549:       dependency on the JDK is added.  If
1.23      wiz      8550:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8551:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8552:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8553:       JDK.</p></li>
1.23      wiz      8554: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8555:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8556:       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
                   8557:       <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
                   8558:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8559:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8560:       above. This variable is not set by default.</p></li>
1.24      wiz      8561: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8562:       automatically set to the runtime location of the used Java
                   8563:       implementation dependency. It may be used to set
                   8564:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8565:       needs this variable to be defined.
                   8566:       </p></li>
1.1       dsieger  8567: </ul></div>
                   8568: </div>
1.41      asau     8569: <div class="sect2">
1.1       dsieger  8570: <div class="titlepage"><div><div><h3 class="title">
1.205     wiz      8571: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
                   8572: <p>If a program is written in Go and has any dependencies on
                   8573:     other Go modules, have the package include
                   8574:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8575: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8576: <li class="listitem"><p>Generate a list of those dependencies with
                   8577:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8578:       go-modules.mk</strong></span>.</p></li>
1.223     nia      8579: <li class="listitem"><p>Prepend
                   8580:       <code class="literal">.include "go-modules.mk"</code> to any other
                   8581:       <code class="literal">.include</code>s.</p></li>
                   8582: <li class="listitem"><p>Incorporate these modules in
                   8583:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8584:       makesum</strong></span>.</p></li>
                   8585: </ol></div>
                   8586: </div>
                   8587: <div class="sect2">
                   8588: <div class="titlepage"><div><div><h3 class="title">
                   8589: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
                   8590: <p>If a program is written in Rust and uses Cargo to build,
                   8591:     have the package include
                   8592:     <code class="filename">../../lang/rust/cargo.mk</code>.</p>
                   8593: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8594: <li class="listitem"><p>Generate a list of those dependencies with
                   8595:       <span class="command"><strong>make CARGO_ARGS="build --release" build &amp;&amp;
                   8596:       make print-cargo-depends &gt; cargo-depends.mk</strong></span>.</p></li>
                   8597: <li class="listitem"><p>Prepend
                   8598:       <code class="literal">.include "cargo-depends.mk"</code> to any other
                   8599:       <code class="literal">.include</code>s.</p></li>
1.205     wiz      8600: <li class="listitem"><p>Incorporate these modules in
                   8601:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8602:       makesum</strong></span>.</p></li>
                   8603: </ol></div>
                   8604: </div>
                   8605: <div class="sect2">
                   8606: <div class="titlepage"><div><div><h3 class="title">
1.223     nia      8607: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203     nia      8608: <p>If your package contains interpreted Perl scripts, add
1.23      wiz      8609:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8610:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8611:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8612:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74      wiz      8613:     that you want adjusted. Every occurrence of
                   8614:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210     gutterid 8615:     replaced with the full path to the Perl executable.</p>
                   8616: <p>If a particular version of Perl is needed, set the
1.1       dsieger  8617:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8618:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.203     nia      8619: <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.210     gutterid 8620:     about handling Perl modules.</p>
                   8621: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8622:     for the language now known as Raku.</p>
1.1       dsieger  8623: </div>
1.41      asau     8624: <div class="sect2">
1.1       dsieger  8625: <div class="titlepage"><div><div><h3 class="title">
1.223     nia      8626: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40      wiz      8627: <p><code class="varname">REPLACE_SH</code>,
                   8628:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8629:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225     gutterid 8630:     she-bangs in files. Please use the appropriate one, preferring
                   8631:     <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74      wiz      8632:     Each should contain a list of scripts, relative to
                   8633:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8634:     occurrence of the matching shell in a she-bang line will be
                   8635:     replaced with the full path to the shell executable.
1.40      wiz      8636:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8637:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8638: </div>
1.41      asau     8639: <div class="sect2">
1.40      wiz      8640: <div class="titlepage"><div><div><h3 class="title">
1.223     nia      8641: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210     gutterid 8642: <p>There are further similar REPLACE variables available, e.g.,
                   8643:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8644:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211     gutterid 8645:     noted above, have their actions defined centrally in
1.210     gutterid 8646:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211     gutterid 8647:     languages define the actions of these variables within their own
                   8648:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
                   8649:     actioned in <code class="filename">lang/php/phpversion.mk</code>, and
                   8650:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210     gutterid 8651:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8652:     consult the mk files found within their specific directories (the
1.216     gutterid 8653:     naming convention varies), or check the list found in
                   8654:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210     gutterid 8655: <p>Currently, special handling for other languages varies
1.1       dsieger  8656:     in pkgsrc.  If a compiler package provides a
                   8657:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8658:     just add a (build) dependency on the appropriate compiler
                   8659:     package.</p>
                   8660: </div>
                   8661: </div>
1.41      asau     8662: <div class="sect1">
1.1       dsieger  8663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8664: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  8665: <p>The most common failures when building a package are that
                   8666:        some platforms do not provide certain header files, functions or
                   8667:        libraries, or they provide the functions in a library that the
                   8668:        original package author didn't know. To work around this, you
                   8669:        can rewrite the source code in most cases so that it does not
                   8670:        use the missing functions or provides a replacement function.</p>
1.41      asau     8671: <div class="sect2">
1.1       dsieger  8672: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8673: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8674: <p>If a package already comes with a GNU configure script, the
                   8675:        preferred way to fix the build failure is to change the
                   8676:        configure script, not the code. In the other cases, you can
                   8677:        utilize the C preprocessor, which defines certain macros
                   8678:        depending on the operating system and hardware architecture it
                   8679:        compiles for. These macros can be queried using for example
                   8680:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8681:        system, hardware architecture and compiler has its own macro.
                   8682:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8683:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8684:        are all defined, you know that you are using NetBSD on an i386
                   8685:        compatible CPU, and your compiler is GCC.</p>
                   8686: <p>The list of the following macros for hardware and
                   8687:        operating system depends on the compiler that is used. For
                   8688:        example, if you want to conditionally compile code on Solaris,
                   8689:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8690:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     8691: <div class="sect3">
1.1       dsieger  8692: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8693: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.223     nia      8694: <p>To distinguish between specific NetBSD versions,
                   8695:         you should use the following code.</p>
                   8696: <pre class="programlisting">
                   8697: #ifdef __NetBSD__
                   8698: #include &lt;sys/param.h&gt;
                   8699: #if __NetBSD_Prereq__(9,99,17)
                   8700: /* use a newer feature */
                   8701: #else
                   8702: /* older code */
                   8703: #endif
                   8704: #endif
                   8705: 
                   8706: #ifndef _WIN32
                   8707: /* Unix-like specific code */
                   8708: #endif
                   8709: </pre>
1.1       dsieger  8710: <p>To distinguish between 4.4 BSD-derived systems and the
                   8711:         rest of the world, you should use the following code.</p>
                   8712: <pre class="programlisting">
                   8713: #include &lt;sys/param.h&gt;
                   8714: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8715: /* BSD-specific code goes here */
                   8716: #else
                   8717: /* non-BSD-specific code goes here */
                   8718: #endif
                   8719: </pre>
1.223     nia      8720: <p>You can also test for the following macros:</p>
1.1       dsieger  8721: <pre class="programlisting">
1.45      obache   8722: Cygwin      __CYGWIN__
                   8723: DragonFly   __DragonFly__
1.1       dsieger  8724: FreeBSD     __FreeBSD__
1.45      obache   8725: Haiku       __HAIKU__
1.1       dsieger  8726: Interix     __INTERIX
                   8727: IRIX        __sgi (TODO: get a definite source for this)
1.223     nia      8728: Linux       __linux
1.83      dholland 8729: Mac OS X    __APPLE__
1.45      obache   8730: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8731: Minix3      __minix
1.1       dsieger  8732: NetBSD      __NetBSD__
                   8733: OpenBSD     __OpenBSD__
                   8734: Solaris     sun, __sun
                   8735: </pre>
                   8736: </div>
1.41      asau     8737: <div class="sect3">
1.1       dsieger  8738: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8739: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  8740: <pre class="programlisting">
                   8741: i386        i386, __i386, __i386__
1.223     nia      8742: x86-64      __amd64__, __x86_64__
                   8743: ARM         __arm__
1.1       dsieger  8744: MIPS        __mips
                   8745: SPARC       sparc, __sparc
1.223     nia      8746: PowerPC     __powerpc
1.1       dsieger  8747: </pre>
                   8748: </div>
1.41      asau     8749: <div class="sect3">
1.1       dsieger  8750: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8751: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  8752: <pre class="programlisting">
                   8753: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8754: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8755: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8756: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8757: </pre>
                   8758: </div>
                   8759: </div>
1.41      asau     8760: <div class="sect2">
1.1       dsieger  8761: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8762: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8763: <p>Some source files trigger bugs in the compiler, based on
                   8764:         combinations of compiler version and architecture and almost
                   8765:         always relation to optimisation being enabled.  Common symptoms
                   8766:         are gcc internal errors or never finishing compiling a
                   8767:        file.</p>
                   8768: <p>Typically, a workaround involves testing the
                   8769:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8770:         optimisation for that combination of file,
1.87      tnn      8771:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8772: <p>This used to be a big problem in the past, but is rarely
                   8773:        needed now as compiler technology has matured. If you still need
                   8774:        to add a compiler specific workaround, please do so in the file
                   8775:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8776:        compiler version as detailed as possible.</p>
1.1       dsieger  8777: </div>
1.41      asau     8778: <div class="sect2">
1.1       dsieger  8779: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   8780: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8781: <p>Compilation sometimes fails with an error message like this:</p>
                   8782: <pre class="programlisting">
                   8783: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8784:     fatal error: pango/pango.h: No such file or directory
                   8785: </pre>
                   8786: <p>The proper way to fix this problem depends on the type of the
                   8787: header, which is described in the following sections.</p>
                   8788: <div class="sect3">
                   8789: <div class="titlepage"><div><div><h4 class="title">
                   8790: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8791: <p>If the header name looks like it comes from a different package,
                   8792: that other package should be included via the buildlink3
                   8793: framework.</p>
                   8794: <p>First, look whether the header is somewhere in the buildlink3
                   8795: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8796: the missing Pango header:</p>
                   8797: <pre class="programlisting">
                   8798: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8799: </pre>
                   8800: <p>In the case of Pango, the output is:</p>
                   8801: <pre class="programlisting">
                   8802: work/.buildlink/include/pango-1.0/pango/pango.h
                   8803: </pre>
                   8804: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8805: in the <code class="filename">.buildlink</code> directory, it would have been
                   8806: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8807: path component though, which means that the compiler command line must
                   8808: contain an option of the form
                   8809: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8810: most cases this option is generated by the configure script, which can be examined using:</p>
                   8811: <pre class="programlisting">
                   8812: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8813: -I/usr/pkg/include/pango-1.0
                   8814: -I/usr/pkg/include/pango-1.0
                   8815: -I/usr/pkg/include/pango-1.0
                   8816: -I/usr/pkg/include/pango-1.0
                   8817: -I/usr/pkg/include/pango-1.0
                   8818: </pre>
                   8819: <p>This looks good. These options are transformed by the buildlink
                   8820: wrapper to refer to the correct path inside
                   8821: <code class="filename">work/.buildlink</code>.</p>
                   8822: <p>Since the compilation fails though, examine the compiler command
                   8823: lines in <code class="filename">work/.work.log</code> to see whether the
                   8824: <code class="literal">-I</code> option is included in the particular command
                   8825: line.</p>
                   8826: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8827: build-env</strong></span>, which sets up an interactive, realistic environment
                   8828: including all the pkgsrc wrapper commands and environment variables. From
                   8829: there, try to compile some simple example programs that use the
                   8830: header.</p>
                   8831: </div>
                   8832: <div class="sect3">
                   8833: <div class="titlepage"><div><div><h4 class="title">
                   8834: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8835: <p>If the name of the header seems to come from the package itself,
                   8836: and if the build is run with parallel jobs, the package may have some
                   8837: undeclared dependencies between the <code class="filename">.c</code> and the
                   8838: <code class="filename">.h</code> files, and a C file is compiled before its
                   8839: required header is generated.</p>
                   8840: <p>To see whether the build runs with parallel jobs, run
                   8841: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8842: like this:</p>
                   8843: <pre class="programlisting">
                   8844:   usr   MAKE_JOBS=              7
                   8845:   pkg   MAKE_JOBS_SAFE          # undefined
                   8846:   def   _MAKE_JOBS_N=           7
                   8847: </pre>
                   8848: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8849: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8850: package could have disabled parallel builds by setting
                   8851: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8852: in this case it hasn't.</p>
                   8853: <p>To see whether the build failure is caused by parallel builds,
                   8854: first save the exact error message and a bit of context, maybe you need
                   8855: it later for reporting a bug. Next, run:</p>
                   8856: <pre class="programlisting">
                   8857: MAKE_JOBS_SAFE=no bmake clean build
                   8858: </pre>
                   8859: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8860: report</a> against the pkgsrc package, including the exact error
                   8861: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8862: </div>
1.173     rillig   8863: <div class="sect3">
                   8864: <div class="titlepage"><div><div><h4 class="title">
                   8865: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8866: <p>Pkgsrc does not work reliably if any of
                   8867: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8868: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8869: bootstrap program prevents installing pkgsrc in symlink-based
                   8870: directories. Existing pkgsrc installations are not checked for symlinks
                   8871: though.</p>
                   8872: <p>The "No such file or directory" error messages are a typical
                   8873: symptom of symlinks, and it's quite difficult to find out that this is
                   8874: the actual cause.</p>
                   8875: </div>
                   8876: <div class="sect3">
                   8877: <div class="titlepage"><div><div><h4 class="title">
                   8878: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8879: <p>When building a hierarchy of packages, it may happen that one
                   8880: package is built and then pkgsrc is updated. This situation can provoke
                   8881: various hard to diagnose build errors. To clean up the situation:</p>
                   8882: <pre class="programlisting">
1.223     nia      8883: <code class="prompt">$</code> (cd ../../ &amp;&amp; cat mk/bsd.pkg.mk &gt;/dev/null &amp;&amp; rm -rf */*/work)
1.173     rillig   8884: </pre>
1.223     nia      8885: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
                   8886: prevent running this command in the wrong directory.)</p>
1.173     rillig   8887: <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
                   8888: that directory as well.</p>
                   8889: </div>
                   8890: <div class="sect3">
                   8891: <div class="titlepage"><div><div><h4 class="title">
                   8892: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8893: <p>On platforms other than BSD, third-party packages are installed in
                   8894: <code class="filename">/usr/include</code>, together with the base system. This
                   8895: means that pkgsrc cannot distinguish between headers provided by the base
                   8896: system (which it needs) and headers from third-party packages (which are
                   8897: often included in pkgsrc as well). This can lead to subtle version
                   8898: mismatches.</p>
                   8899: <p>In pkgsrc installations that have been active for several years, it
                   8900: may happen that some files are manually deleted. To exclude this unlikely
                   8901: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8902: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8903: check/fix dependencies.</p>
                   8904: <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>
                   8905: for contact information. Be prepared to describe what you have tried so
                   8906: far and what any error messages were.</p>
                   8907: </div>
1.172     rillig   8908: </div>
                   8909: <div class="sect2">
                   8910: <div class="titlepage"><div><div><h3 class="title">
                   8911: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.23      wiz      8912: </h3></div></div></div>
1.1       dsieger  8913: <p>This error message often means that a package did not
                   8914:        link to a shared library it needs. The following functions are
                   8915:        known to cause this error message over and over.</p>
                   8916: <div class="informaltable">
1.106     tnn      8917: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1       dsieger  8918: <colgroup>
                   8919: <col>
                   8920: <col>
                   8921: <col>
                   8922: </colgroup>
                   8923: <thead><tr>
                   8924: <th>Function</th>
                   8925: <th>Library</th>
                   8926: <th>Affected platforms</th>
                   8927: </tr></thead>
                   8928: <tbody>
                   8929: <tr>
                   8930: <td>accept, bind, connect</td>
                   8931: <td>-lsocket</td>
                   8932: <td>Solaris</td>
                   8933: </tr>
                   8934: <tr>
                   8935: <td>crypt</td>
                   8936: <td>-lcrypt</td>
                   8937: <td>DragonFly, NetBSD</td>
                   8938: </tr>
                   8939: <tr>
                   8940: <td>dlopen, dlsym</td>
                   8941: <td>-ldl</td>
                   8942: <td>Linux</td>
                   8943: </tr>
                   8944: <tr>
                   8945: <td>gethost*</td>
                   8946: <td>-lnsl</td>
                   8947: <td>Solaris</td>
                   8948: </tr>
                   8949: <tr>
                   8950: <td>inet_aton</td>
                   8951: <td>-lresolv</td>
                   8952: <td>Solaris</td>
                   8953: </tr>
                   8954: <tr>
                   8955: <td>nanosleep, sem_*, timer_*</td>
                   8956: <td>-lrt</td>
                   8957: <td>Solaris</td>
                   8958: </tr>
                   8959: <tr>
                   8960: <td>openpty</td>
                   8961: <td>-lutil</td>
                   8962: <td>Linux</td>
                   8963: </tr>
                   8964: </tbody>
                   8965: </table>
                   8966: </div>
1.223     nia      8967: <p>To fix these linker errors, it is often sufficient to add
1.1       dsieger  8968:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8969:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223     nia      8970:     <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1       dsieger  8971:     bmake</strong></span>.</p>
1.41      asau     8972: <div class="sect3">
1.1       dsieger  8973: <div class="titlepage"><div><div><h4 class="title">
1.223     nia      8974: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1       dsieger  8975: <p>When you are using the SunPro compiler, there is another
                   8976: possibility. That compiler cannot handle the following code:</p>
                   8977: <pre class="programlisting">
                   8978: extern int extern_func(int);
                   8979: 
                   8980: static inline int
                   8981: inline_func(int x)
                   8982: {
                   8983:         return extern_func(x);
                   8984: }
                   8985: 
                   8986: int main(void)
                   8987: {
                   8988:         return 0;
                   8989: }
                   8990: </pre>
                   8991: <p>It generates the code for <code class="function">inline_func</code> even if
                   8992: that function is never used. This code then refers to
                   8993: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8994: solve this problem you can try to tell the package to disable inlining
                   8995: of functions.</p>
                   8996: </div>
                   8997: </div>
1.41      asau     8998: <div class="sect2">
1.1       dsieger  8999: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   9000: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1       dsieger  9001: <p>Sometimes packages fail to build because the compiler runs
                   9002:     into an operating system specific soft limit.  With the
                   9003:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223     nia      9004:     to unlimit the resources.  The allowed values are any combination of
                   9005:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>,
                   9006:     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   9007:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>,
                   9008:     <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> and
                   9009:     <span class="quote">&#8220;<span class="quote">virtualsize</span>&#8221;</span>.
1.1       dsieger  9010:     Setting this variable is similar to running the shell builtin
1.10      hubertf  9011:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  9012:     segment size or maximum stack size of a process, respectively, to
                   9013:     their hard limits.</p>
                   9014: </div>
                   9015: </div>
1.41      asau     9016: <div class="sect1">
1.1       dsieger  9017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9018: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     9019: <div class="sect2">
1.1       dsieger  9020: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9021: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  9022: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  9023:     with some operating systems cannot create more than one
                   9024:     directory at a time. As such, you should call
                   9025:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9026: <pre class="programlisting">
                   9027: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9028: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111     sevan    9029: </pre>
1.223     nia      9030: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
                   9031:     directly, you can also append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   9032:     dir2</code></span>&#8221;</span> to the <code class="varname">INSTALLATION_DIRS</code>
                   9033:     variable, which will automatically do the right thing.</p>
1.1       dsieger  9034: </div>
1.41      asau     9035: <div class="sect2">
1.1       dsieger  9036: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9037: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  9038: <p>In general, documentation should be installed into
                   9039:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223     nia      9040:     <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1       dsieger  9041:     includes the version number of the package).</p>
                   9042: <p>Many modern packages using GNU autoconf allow to set the
                   9043:     directory where HTML documentation is installed with the
1.223     nia      9044:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag is
                   9045:     needed because otherwise the documentation ends up in
                   9046:     <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
                   9047:     pkgsrc, the HTML documentation should go into the package-specific
                   9048:     directory, just like any other documentation.</p>
1.1       dsieger  9049: <p>An exception to the above is that library API documentation
1.207     leot     9050:     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.1       dsieger  9051:     browsers (devhelp) should be left at their default location, which
                   9052:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9053:     documentation can be recognized from files ending in
                   9054:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9055:     (It is also acceptable to install such files in
                   9056:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9057:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9058:     <code class="filename">.devhelp*</code> file must be directly in that
                   9059:     directory then, no additional subdirectory level is allowed in
                   9060:     this case. This is usually achieved by using
1.23      wiz      9061:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  9062:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9063:     though.)</p>
                   9064: </div>
1.41      asau     9065: <div class="sect2">
1.1       dsieger  9066: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9067: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  9068: <p>Certain packages, most of them in the games category, install
                   9069:     a score file that allows all users on the system to record their
                   9070:     highscores.  In order for this to work, the binaries need to be
                   9071:     installed setgid and the score files owned by the appropriate
1.35      wiz      9072:     group and/or owner (traditionally the "games" user/group).  Set
                   9073:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  9074:     following variables, documented in more detail in
                   9075:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      9076:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9077:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100     leot     9078:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   9079:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   9080:     <code class="varname">GAMEDATA_PERMS</code> and
                   9081:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   9082: <p>An example that illustrates some of the variables described above is
                   9083:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   9084:     used to properly set directory permissions of the directory where the
                   9085:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   9086:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   9087:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   9088:     binary:</p>
                   9089: <pre class="programlisting">
1.112     rillig   9090: USE_GAMESGROUP=         yes
1.100     leot     9091: 
1.112     rillig   9092: BUILD_DEFS+=            VARBASE
1.100     leot     9093: 
1.112     rillig   9094: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   9095: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9096: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111     sevan    9097: </pre>
1.100     leot     9098: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9099:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9100:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9101:     needed to be accessed by setgid games and
                   9102:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14      jmcneill 9103: <p>A package should therefore never hard code file ownership or
1.100     leot     9104:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9105:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9106:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9107:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1       dsieger  9108: </div>
1.41      asau     9109: <div class="sect2">
1.1       dsieger  9110: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9111: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 9112: <p><code class="varname">DESTDIR</code> support means that a package
                   9113:     installs into a staging directory, not the final location of the
                   9114:     files. Then a binary package is created which can be used for
                   9115:     installation as usual. There are two ways: Either the package must
1.23      wiz      9116:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   9117:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     9118: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9119: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113     leot     9120:       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>.
                   9121:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38      wiz      9122:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   9123:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 9124:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9125:       the inclusion.</p></li>
1.23      wiz      9126: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   9127:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      9128: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   9129:       automatically. Many manual rules and pre/post-install often are
                   9130:       incorrect; fix them.</p></li>
1.23      wiz      9131: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     9132:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      9133: <li class="listitem"><p>In general, packages should support
1.4       rillig   9134:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9135:       DESTDIR.</p></li>
                   9136: </ul></div>
                   9137: </div>
1.41      asau     9138: <div class="sect2">
1.4       rillig   9139: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9140: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  9141: <p>Your package may also contain scripts with hardcoded paths to
1.203     nia      9142:       other interpreters besides (or as well as) Perl.  To correct the
1.1       dsieger  9143:       full pathname to the script interpreter, you need to set the
                   9144:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  9145:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  9146: <pre class="programlisting">
                   9147: REPLACE_INTERPRETER+=   tcl
                   9148: REPLACE.tcl.old=        .*/bin/tclsh
                   9149: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9150: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9151: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111     sevan    9152: </pre>
1.1       dsieger  9153: </div>
1.41      asau     9154: <div class="sect2">
1.1       dsieger  9155: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9156: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1       dsieger  9157: <p>Makefiles of packages providing perl5 modules should include
                   9158:     the Makefile fragment
                   9159:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  9160:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  9161:     configuration for such modules as well as various hooks to tune
                   9162:     this configuration.  See comments in this file for
                   9163:     details.</p>
                   9164: <p>Perl5 modules will install into different places depending
                   9165:     on the version of perl used during the build process.  To
                   9166:     address this, pkgsrc will append lines to the
                   9167:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9168:     the installed <code class="filename">.packlist</code> file generated by
                   9169:     most perl5 modules.  This is invoked by defining
                   9170:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47      wiz      9171:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9172:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9173:     e.g.:</p>
1.1       dsieger  9174: <pre class="programlisting">
1.47      wiz      9175: PERL5_PACKLIST= auto/Pg/.packlist
1.111     sevan    9176: </pre>
1.47      wiz      9177: <p>The perl5 config variables
                   9178:     <code class="varname">installarchlib</code>,
                   9179:     <code class="varname">installscript</code>,
                   9180:     <code class="varname">installvendorbin</code>,
                   9181:     <code class="varname">installvendorscript</code>,
                   9182:     <code class="varname">installvendorarch</code>,
                   9183:     <code class="varname">installvendorlib</code>,
                   9184:     <code class="varname">installvendorman1dir</code>, and
                   9185:     <code class="varname">installvendorman3dir</code> represent those
                   9186:     locations in which components of perl5 modules may be installed,
                   9187:     provided as variable with uppercase and prefixed with
                   9188:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9189:     and may be used by perl5 packages that don't have a packlist.
                   9190:     These variables are also substituted for in the
                   9191:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9192:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  9193: </div>
1.41      asau     9194: <div class="sect2">
1.1       dsieger  9195: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9196: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  9197: <p>Some packages install info files or use the
1.23      wiz      9198:     <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.1       dsieger  9199:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9200:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9201:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9202:     handle registration of the info files in the Info directory
1.23      wiz      9203:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  9204:     files registration is either provided by the system, or by a
                   9205:     special purpose package automatically added as dependency if
                   9206:     needed.</p>
                   9207: <p><code class="varname">PKGINFODIR</code> is the directory under
                   9208:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9209:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      9210:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  9211: <p>The info files for the package should be listed in the
                   9212:     package <code class="filename">PLIST</code>; however any split info files
                   9213:     need not be listed.</p>
1.23      wiz      9214: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9215:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  9216:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      9217:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  9218:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9219:     variable in the package <code class="filename">Makefile</code>. By
                   9220:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  9221:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  9222:     does not match the required minimum, a build dependency on the
1.207     leot     9223:     <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.1       dsieger  9224:     be added automatically.</p>
                   9225: <p>The build and installation process of the software provided
                   9226:     by the package should not use the
1.10      hubertf  9227:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  9228:     info files is the task of the package
                   9229:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  9230:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  9231: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  9232:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9233:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  9234:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  9235: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  9236:     no effect except the logging of a message. The script overriding
1.10      hubertf  9237:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  9238:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  9239:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  9240: </div>
1.41      asau     9241: <div class="sect2">
1.1       dsieger  9242: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9243: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  9244: <p>All packages that install manual pages should install them
                   9245:     into the same directory, so that there is one common place to look
                   9246:     for them. In pkgsrc, this place is
                   9247:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9248:     should be used in packages. The default for
                   9249:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      9250:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9251:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     9252: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9253: <h3 class="title">Note</h3>
                   9254: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9255:     is far from complete.</p>
                   9256: </div>
                   9257: <p>The <code class="filename">PLIST</code> files can just use
                   9258:     <code class="filename">man/</code> as the top level directory for the man
                   9259:     page file entries, and the pkgsrc framework will convert as
                   9260:     needed. In all other places, the correct
                   9261:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9262: <p>Packages that are
                   9263:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      9264:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  9265:     <code class="filename">./configure</code>
                   9266:     --mandir switch to set where the man pages should be installed.
                   9267:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9268:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9269: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9270:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      9271:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  9272:     Or if the <code class="filename">./configure</code> script uses
                   9273:     a non-standard use of --mandir, you can set
                   9274:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184     rillig   9275: <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.1       dsieger  9276:     information on installation of compressed manual pages.</p>
                   9277: </div>
1.41      asau     9278: <div class="sect2">
1.1       dsieger  9279: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9280: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9281: <p>If a package installs font files, you will need to rebuild
                   9282:     the fonts database in the directory where they get installed at
                   9283:     installation and deinstallation time.  This can be automatically
                   9284:     done by using the pkginstall framework.</p>
                   9285: <p>You can list the directories where fonts are installed in the
                   9286:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9287:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9288:     <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.1       dsieger  9289:     Also make sure that the database file
                   9290:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9291: <p>Note that you should not create new directories for fonts;
                   9292:     instead use the standard ones to avoid that the user needs to
                   9293:     manually configure his X server to find them.</p>
                   9294: </div>
1.41      asau     9295: <div class="sect2">
1.1       dsieger  9296: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9297: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9298: <p>If a package installs SGML or XML data files that need to be
                   9299:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9300:     etc.), you need to take some extra steps:</p>
1.23      wiz      9301: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9302: <li class="listitem"><p>Include
1.1       dsieger  9303:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9304:        your <code class="filename">Makefile</code>, which takes care of
                   9305:        registering those files in system-wide catalogs at
                   9306:        installation and deinstallation time.</p></li>
1.23      wiz      9307: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9308:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9309: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9310:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9311: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9312:        to be added to the SGML catalog.  These come in groups of
                   9313:        three strings; see xmlcatmgr(1) for more information
                   9314:        (specifically, arguments recognized by the 'add' action).
                   9315:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9316: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9317:        to be added to the XML catalog.  These come in groups of three
                   9318:        strings; see xmlcatmgr(1) for more information (specifically,
                   9319:        arguments recognized by the 'add' action).  Note that you will
                   9320:        normally not use this variable.</p></li>
                   9321: </ol></div>
                   9322: </div>
1.41      asau     9323: <div class="sect2">
1.1       dsieger  9324: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9325: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9326: <p>If a package provides extensions to the MIME database by
                   9327:     installing <code class="filename">.xml</code> files inside
                   9328:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9329:     need to take some extra steps to ensure that the database is kept
                   9330:     consistent with respect to these new files:</p>
1.23      wiz      9331: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9332: <li class="listitem"><p>Include
1.1       dsieger  9333:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9334:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9335:        this same directory, which is reserved for inclusion from
                   9336:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9337:        care of rebuilding the MIME database at installation and
                   9338:        deinstallation time, and disallows any access to it directly
                   9339:        from the package.</p></li>
1.23      wiz      9340: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9341:        <code class="filename">share/mime</code> directory,
                   9342:        <span class="emphasis"><em>except</em></span> for files saved under
                   9343:        <code class="filename">share/mime/packages</code>.  The former are
                   9344:        handled automatically by
                   9345:        the update-mime-database program, but the latter are
                   9346:        package-dependent and must be removed by the package that
                   9347:        installed them in the first place.</p></li>
1.23      wiz      9348: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9349:        from the PLIST.  They will be handled by the shared-mime-info
                   9350:        package.</p></li>
                   9351: </ol></div>
                   9352: </div>
1.41      asau     9353: <div class="sect2">
1.1       dsieger  9354: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9355: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1       dsieger  9356: <p>If a package uses intltool during its build, add
                   9357:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9358:     which forces it to use the intltool package provided by pkgsrc,
                   9359:     instead of the one bundled with the distribution file.</p>
                   9360: <p>This tracks intltool's build-time dependencies and uses the
                   9361:     latest available version; this way, the package benefits of any
                   9362:     bug fixes that may have appeared since it was released.</p>
                   9363: </div>
1.41      asau     9364: <div class="sect2">
1.1       dsieger  9365: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9366: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9367: <p>If a package contains a rc.d script, it won't be copied into
                   9368:     the startup directory by default, but you can enable it, by adding
                   9369:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9370:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9371:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9372:     it will automatically remove the scripts when the package is
                   9373:     deinstalled.</p>
                   9374: </div>
1.41      asau     9375: <div class="sect2">
1.1       dsieger  9376: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9377: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9378: <p>If a package installs TeX packages into the texmf tree,
                   9379:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9380:     updated.</p>
1.41      asau     9381: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9382: <h3 class="title">Note</h3>
1.22      jakllsch 9383: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9384:     packages should install files
1.22      jakllsch 9385:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9386:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9387: </div>
1.23      wiz      9388: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9389: <li class="listitem"><p>Include
1.22      jakllsch 9390:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9391:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9392:       database at installation and deinstallation time.</p></li>
1.23      wiz      9393: <li class="listitem">
1.1       dsieger  9394: <p>If your package installs files into a texmf
                   9395:       tree other than the one
1.22      jakllsch 9396:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9397:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9398:       trees that need database update.</p>
                   9399: <p>If your package also installs font map files that need
1.10      hubertf  9400:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9401:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9402:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9403:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9404:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9405:       be run automatically at installation/deinstallation to
                   9406:       enable/disable font map files for TeX output
                   9407:       drivers.</p>
                   9408: </li>
1.23      wiz      9409: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9410:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9411:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9412: </ol></div>
                   9413: </div>
1.41      asau     9414: <div class="sect2">
1.1       dsieger  9415: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9416: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1       dsieger  9417:     emulation</h3></div></div></div>
                   9418: <p>There are some packages that provide libraries and
                   9419:     executables for running binaries from a one operating system
                   9420:     on a different one (if the latter supports it).  One example
                   9421:     is running Linux binaries on NetBSD.</p>
1.207     leot     9422: <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.1       dsieger  9423:     helps in extracting and packaging Linux rpm packages.</p>
                   9424: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9425:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9426:     if all libraries for each installed executable can be found by
                   9427:     the dynamic linker.  Since the standard dynamic linker is run,
                   9428:     this fails for emulation packages, because the libraries used
                   9429:     by the emulation are not in the standard directories.</p>
                   9430: </div>
1.184     rillig   9431: <div class="sect2">
                   9432: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9433: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184     rillig   9434: <p>If a package installs images under the
                   9435:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9436:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9437:     database, you need to take some extra steps to make sure that the
                   9438:     shared theme directory is handled appropriately and that the cache
                   9439:     database is rebuilt:</p>
                   9440: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9441: <li class="listitem"><p>Include
                   9442:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9443: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9444:        entry that refers to the theme cache.</p></li>
                   9445: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9446:          directories from the <code class="filename">share/icons/hicolor</code>
                   9447:          hierarchy because they will be handled automatically.</p></li>
                   9448: </ol></div>
                   9449: <p>The best way to verify that the PLIST is correct with
                   9450:       respect to the last two points is to regenerate it using
                   9451:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9452: </div>
                   9453: <div class="sect2">
                   9454: <div class="titlepage"><div><div><h3 class="title">
1.203     nia      9455: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184     rillig   9456: <p>If a package installs <code class="filename">.desktop</code> files
                   9457:       under <code class="filename">share/applications</code> and these include
                   9458:       MIME information (MimeType key), you need to take extra steps to
                   9459:       ensure that they are registered into the MIME database:</p>
                   9460: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9461: <li class="listitem"><p>Include
                   9462:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9463: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9464:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9465:          It will be handled automatically.</p></li>
                   9466: </ol></div>
                   9467: <p>The best way to verify that the PLIST is correct with
                   9468:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9469:       print-PLIST</strong></span>.</p>
                   9470: </div>
                   9471: </div>
                   9472: <div class="sect1">
                   9473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9474: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9475: <p>In some cases one does not have the time to solve a problem
                   9476:   immediately. In this case, one can plainly mark a package as broken.  For
                   9477:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9478:   reason why the package is broken (similar to the
                   9479:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9480:   the package will immediately be shown this message, and the build
                   9481:   will not be even tried.</p>
                   9482: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9483:   intervals.</p>
                   9484: </div>
                   9485: </div>
                   9486: <div class="chapter">
                   9487: <div class="titlepage"><div><div><h2 class="title">
                   9488: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9489: <div class="toc">
                   9490: <p><b>Table of Contents</b></p>
                   9491: <dl class="toc">
                   9492: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9493: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9494: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9495: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9496: </dl>
                   9497: </div>
                   9498: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9499: site</a>:</p>
                   9500: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9501:   environment, an intuitive and attractive desktop for users, and the
                   9502:   GNOME development platform, an extensive framework for building
                   9503:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9504: <p>pkgsrc provides a seamless way to automatically build and install
                   9505: a complete GNOME environment <span class="emphasis"><em>under many different
                   9506: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9507: the most advanced build and packaging systems for GNOME due to its
                   9508: included technologies buildlink3, the wrappers and tools framework and
                   9509: automatic configuration file management.  Lots of efforts are put into
                   9510: achieving a completely clean deinstallation of installed software
                   9511: components.</p>
                   9512: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9513: the above also means that great efforts are put into making GNOME work
1.201     cirnatda 9514: under this operating system.</p>
1.184     rillig   9515: <p>This chapter is aimed at pkgsrc developers and other people
                   9516: interested in helping our GNOME porting and packaging efforts.  It
                   9517: provides instructions on how to manage the existing packages and some
                   9518: important information regarding their internals.</p>
                   9519: <div class="sect1">
                   9520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9521: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9522: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207     leot     9524: <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.184     rillig   9525:     the core GNOME desktop environment.  It only includes the necessary
                   9526:     bits to get it to boot correctly, although it may lack important
                   9527:     functionality for daily operation.  The idea behind this package is
                   9528:     to let end users build their own configurations on top of this one,
                   9529:     first installing this meta package to achieve a functional setup and
                   9530:     then adding individual applications.</p></li>
1.207     leot     9531: <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.184     rillig   9532:     complete installation of the GNOME platform and desktop as defined
                   9533:     by the GNOME project; this is based on the components distributed in
                   9534:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9535:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9536:     official FTP server.  Developer-only tools found in those
                   9537:     directories are not installed unless required by some other
                   9538:     component to work properly.  Similarly, packages from the bindings
                   9539:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9540:     in unless required as a dependency for an end-user component.  This
1.207     leot     9541:     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>
                   9542: <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.184     rillig   9543:     Installs all the tools required to build a GNOME component when
                   9544:     fetched from the CVS repository.  These are required to let the
                   9545:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9546: </ul></div>
                   9547: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9548: sorted in a way that eases updates: a package may depend on other
                   9549: packages listed before it but not on any listed after it.  It is very
                   9550: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9551: change it to alphabetical sorting!</em></span></p>
                   9552: </div>
                   9553: <div class="sect1">
                   9554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9555: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9556: <p>Almost all GNOME applications are written in C and use a common
                   9557: set of tools as their build system.  Things get different with the new
                   9558: bindings to other languages (such as Python), but the following will
                   9559: give you a general idea on the minimum required tools:</p>
                   9560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9561: <li class="listitem">
                   9562: <p>Almost all GNOME applications use the GNU Autotools as their
                   9563:     build system.  As a general rule you will need to tell this to your
                   9564:     package:</p>
                   9565: <pre class="programlisting">
1.223     nia      9566: GNU_CONFIGURE=  yes
                   9567: USE_LIBTOOL=    yes
                   9568: USE_TOOLS+=     gmake
1.184     rillig   9569: </pre>
                   9570: </li>
                   9571: <li class="listitem">
                   9572: <p>If the package uses pkg-config to detect dependencies, add this
                   9573:     tool to the list of required utilities:</p>
                   9574: <pre class="programlisting">
1.223     nia      9575: USE_TOOLS+=     pkg-config
1.184     rillig   9576: </pre>
1.207     leot     9577: <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.184     rillig   9578:     the end of the build process to ensure that you did not miss to
                   9579:     specify any dependency in your package and that the version
                   9580:     requirements are all correct.</p>
                   9581: </li>
                   9582: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9583:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9584:     to handle dependencies and to force the package to use the latest
                   9585:     available version.</p></li>
                   9586: <li class="listitem">
                   9587: <p>If the package uses gtk-doc (a documentation generation
                   9588:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9589:     tool is rather big and the distfile should come with pregenerated
                   9590:     documentation anyway; if it does not, it is a bug that you ought to
                   9591:     report.  For such packages you should disable gtk-doc (unless it is
                   9592:     the default):</p>
                   9593: <pre class="programlisting">
1.223     nia      9594: CONFIGURE_ARGS+=        --disable-gtk-doc
1.184     rillig   9595: </pre>
                   9596: <p>The default location of installed HTML files
                   9597:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9598:     and should not be changed unless the package insists on installing
                   9599:     them somewhere else.  Otherwise programs as
                   9600:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9601:     do that with an entry similar to:</p>
                   9602: <pre class="programlisting">
1.223     nia      9603: CONFIGURE_ARGS+=        --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184     rillig   9604: </pre>
                   9605: </li>
                   9606: </ul></div>
                   9607: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9608: files under the installation prefix to maintain databases.  In this
                   9609: context, shared means that those exact same directories and files are
                   9610: used among several different packages, leading to conflicts in the
                   9611: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9612: handle the most common cases, so you have to forget about using
                   9613: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9614: omitting shared files from them.  If you find yourself doing those,
                   9615: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9616: <p>The following table lists the common situations that result in
                   9617: using shared directories or files.  For each of them, the appropriate
                   9618: solution is given.  After applying the solution be sure to
                   9619: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9620: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9621: <div class="table">
                   9622: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9623: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9624: <colgroup>
                   9625: <col>
                   9626: <col>
                   9627: </colgroup>
                   9628: <thead><tr>
                   9629: <th>If the package...</th>
                   9630: <th>Then...</th>
                   9631: </tr></thead>
                   9632: <tbody>
                   9633: <tr>
                   9634: <td>Installs icons under the
                   9635:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9636:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203     nia      9637: <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.184     rillig   9638: </tr>
                   9639: <tr>
                   9640: <td>Installs files under
                   9641:         <code class="filename">share/mime/packages</code>.</td>
1.203     nia      9642: <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.184     rillig   9643: </tr>
                   9644: <tr>
                   9645: <td>Installs <code class="filename">.desktop</code> files under
                   9646:         <code class="filename">share/applications</code> and these include MIME
                   9647:         information.</td>
1.203     nia      9648: <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.184     rillig   9649: </tr>
                   9650: </tbody>
                   9651: </table></div>
1.1       dsieger  9652: </div>
1.184     rillig   9653: <br class="table-break">
1.1       dsieger  9654: </div>
1.41      asau     9655: <div class="sect1">
1.1       dsieger  9656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   9657: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9658: <p>When seeing GNOME as a whole, there are two kinds of
                   9659: updates:</p>
                   9660: <div class="variablelist"><dl class="variablelist">
                   9661: <dt><span class="term">Major update</span></dt>
                   9662: <dd>
                   9663: <p>Given that there is still a very long way for GNOME 3 (if it
                   9664:       ever appears), we consider a major update one that goes from a
                   9665:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9666:       where <code class="literal">Y</code> is even and greater than
                   9667:       <code class="literal">X</code>.  These are hard to achieve because they
                   9668:       introduce lots of changes in the components' code and almost all
                   9669:       GNOME distfiles are updated to newer versions.  Some of them can
                   9670:       even break API and ABI compatibility with the previous major
                   9671:       version series.  As a result, the update needs to be done all at
                   9672:       once to minimize breakage.</p>
                   9673: <p>A major update typically consists of around 80 package
                   9674:       updates and the addition of some new ones.</p>
                   9675: </dd>
                   9676: <dt><span class="term">Minor update</span></dt>
                   9677: <dd>
                   9678: <p>We consider a minor update one that goes from a
                   9679:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9680:       one where <code class="literal">Y</code> is greater than
                   9681:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9682:       not update all GNOME components, can be done in an incremental way
                   9683:       and do not break API nor ABI compatibility.</p>
                   9684: <p>A minor update typically consists of around 50 package
                   9685:       updates, although the numbers here may vary a lot.</p>
                   9686: </dd>
                   9687: </dl></div>
                   9688: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9689: release (either major or minor), the following steps should be
                   9690: followed:</p>
                   9691: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23      wiz      9692: <li class="listitem">
1.184     rillig   9693: <p>Get a list of all the tarballs that form the new release by
                   9694:     using the following commands.  These will leave the full list of the
                   9695:     components' distfiles into the <code class="filename">list.txt</code>
                   9696:     file:</p>
                   9697: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9698:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9699:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9700: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9701:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9702:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.1       dsieger  9703: </li>
1.184     rillig   9704: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9705:     bump their version to the release you are updating them to.  The
                   9706:     three meta packages should be always consistent with versioning.
                   9707:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9708:     in them.</p></li>
1.23      wiz      9709: <li class="listitem">
1.184     rillig   9710: <p>For each meta package, update all its
                   9711:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9712:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9713:     newer version (even if found in the FTP) because the meta packages
                   9714:     are supposed to list the exact versions that form a specific GNOME
                   9715:     release.  Exceptions are permitted here if a newer version solves a
                   9716:     serious issue in the overall desktop experience; these typically
                   9717:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9718:     from the developers.</p>
                   9719: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9720:     should be updated to the latest version available (if found in
                   9721:     pkgsrc).  This is the case, for example, of the dependencies on the
1.207     leot     9722:     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.1       dsieger  9723: </li>
1.23      wiz      9724: <li class="listitem">
1.184     rillig   9725: <p>Generate a patch from the modified meta packages and extract the
                   9726:     list of "new" lines.  This will provide you an outline on what
                   9727:     packages need to be updated in pkgsrc and in what order:</p>
                   9728: <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.1       dsieger  9729: </li>
1.184     rillig   9730: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9731:     installed packages and start over from scratch at this point.</p></li>
                   9732: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9733:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9734:     it in order.  For major desktop updates none of these should be
                   9735:     committed until the entire set is completed because there are chances
                   9736:     of breaking not-yet-updated packages.</p></li>
                   9737: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9738:     the tree one by one with appropriate log messages.  At the end,
                   9739:     commit the three meta package updates and all the corresponding
                   9740:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9741:     <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>
                   9742: </ol></div>
                   9743: </div>
                   9744: <div class="sect1">
                   9745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9746: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9747: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9748: packages.  Please, it is very important that you always, always,
                   9749: <span class="strong"><strong>always</strong></span> feed back any portability
                   9750: 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
                   9751: their attention on portability issues and to ensure that future versions
                   9752: can be built out-of-the box on NetBSD.  The less custom patches in
                   9753: pkgsrc, the easier further updates are.  Those developers in charge of
                   9754: issuing major GNOME updates will be grateful if you do that.</p>
1.200     cirnatda 9755: <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
                   9756: GitLab</a>.  Not all components use these to track bugs, but most
1.184     rillig   9757: of them do.  Do not be short on your reports: always provide detailed
                   9758: explanations of the current failure, how it can be improved to achieve
1.200     cirnatda 9759: maximum portability and, if at all possible, provide a patch against the
                   9760: main Git branch.  The more verbose you are, the higher chances of your
                   9761: patch being accepted.</p>
1.184     rillig   9762: <p>Also, please avoid using preprocessor magic to fix portability
                   9763: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9764: GNOME to their operating system, the official GNOME sources are now
                   9765: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9766: and similar macros.  This hurts portability.  Please see our patching
                   9767: 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
                   9768: details.</p>
                   9769: </div>
1.1       dsieger  9770: </div>
1.41      asau     9771: <div class="chapter">
1.1       dsieger  9772: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9773: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9774: <div class="toc">
                   9775: <p><b>Table of Contents</b></p>
1.100     leot     9776: <dl class="toc">
1.154     rillig   9777: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9778: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9779: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9780: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9781: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9782: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9783: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9784: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9785: </dl>
                   9786: </div>
1.41      asau     9787: <div class="sect1">
1.1       dsieger  9788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9789: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9790: <p>Our policy is that we accept binaries only from pkgsrc
                   9791:        developers to guarantee that the packages don't contain any
                   9792:        trojan horses etc. This is not to annoy anyone but rather to
                   9793:        protect our users! You're still free to put up your home-made
                   9794:        binary packages and tell the world where to get them. NetBSD
                   9795:        developers doing bulk builds and wanting to upload them please
1.154     rillig   9796:        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.66      asau     9797: builds)</i></a>.</p>
1.1       dsieger  9798: </div>
1.41      asau     9799: <div class="sect1">
1.1       dsieger  9800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9801: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218     nia      9802: <p>Firstly, you can import new packages into
                   9803:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
                   9804:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   9805:        for details.</p>
                   9806: <p>Next, check that your package is complete, compiles and
1.184     rillig   9807:        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.218     nia      9808:        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>
                   9809:        tool and fix any errors that appear.</p>
                   9810: <p>Finally, send a report to the pkgsrc bug tracking system,
1.207     leot     9811:        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.1       dsieger  9812:        that, go to the web page
1.174     leot     9813:        <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21      snj      9814:        which contains some instructions and a link to a form where you
                   9815:        can submit packages.  The
1.207     leot     9816:        <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.21      snj      9817:        also available as a substitute for either of the above two tools.
                   9818:        </p>
1.1       dsieger  9819: <p>In the form of the problem report, the category should be
1.23      wiz      9820:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9821:        and version number, and the description field should contain a
                   9822:        short description of your package (contents of the COMMENT
1.218     nia      9823:        variable or DESCR file are OK).</p>
1.1       dsieger  9824: </div>
1.41      asau     9825: <div class="sect1">
1.1       dsieger  9826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9827: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9828: <p>Please note all package additions, updates, moves, and
                   9829:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9830:        important to keep this file up to date and conforming to the
                   9831:        existing format, because it will be used by scripts to
1.174     leot     9832:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9833:        sites. Additionally, check the
                   9834:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9835:        for the package you updated or removed, in case it was mentioned
                   9836:        there.</p>
                   9837: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9838:        bumped, the change should appear in
                   9839:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9840:        related or otherwise relevant. Mass bumps that result from a
                   9841:        dependency being updated should not be mentioned. In all other
                   9842:        cases it's the developer's decision.</p>
                   9843: <p>There is a make target that helps in creating proper
1.10      hubertf  9844:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9845:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9846:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9847:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9848:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9849:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9850:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9851:   For new packages, or package moves or removals, set the
                   9852:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9853:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9854:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9855:   not the same as your NetBSD login name. The target also automatically
                   9856:   removes possibly existing entries for the package in the
                   9857:   <code class="filename">TODO</code> file. Don't forget to commit
1.66      asau     9858:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22      jakllsch 9859:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9860:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9861:   makes the cvs commands use the main repository.
                   9862:   </p>
1.1       dsieger  9863: </div>
1.41      asau     9864: <div class="sect1">
1.1       dsieger  9865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9866: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130     wiz      9867: <p>For several years, there have been mirrors of pkgsrc in
                   9868:   fossil, git, and hg. Standard practise when using these tools is to
                   9869:   make the first line of a commit message function as a summary that
                   9870:   can be read without the rest, such as is commonly done with "git log
                   9871:   --oneline". For this reason, we have the following guidelines for
                   9872:   pkgsrc commit messages:</p>
                   9873: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9874: <li class="listitem"><p>Start the commit message with a line that explains the
1.131     wiz      9875:     big picture in 65 characters or less. When a commit is for one
1.130     wiz      9876:     package, include the name of the package. For updates, include the
                   9877:     version to which it is updated.</p></li>
                   9878: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9879: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9880:     package, reason for a change) and any relevant PRs. Wrap this
                   9881:     section.</p></li>
                   9882: </ul></div>
                   9883: <p>Here is an example:
                   9884:   </p>
                   9885: <pre class="programlisting">
                   9886:   libxslt: update to 1.0.30
                   9887: 
                   9888:   Changes since 1.0.29:
                   9889:   ...
                   9890:   </pre>
                   9891: <p>
                   9892:   </p>
                   9893: <p>Here is another example:
                   9894:   </p>
                   9895: <pre class="programlisting">
                   9896:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9897: 
                   9898:   (rationale)
                   9899:   </pre>
                   9900: <p>
                   9901:   </p>
                   9902: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9903:   allowed on the pkgsrc repository to change commit messages.</p>
                   9904: </div>
                   9905: <div class="sect1">
                   9906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9907: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  9908: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      9909:   access to the pkgsrc repository.</p>
                   9910: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9911: Start by adding the directory and then files in the directory. Don't
                   9912: forget to add the new package to the category's
                   9913: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9914: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9915: <pre class="programlisting">
                   9916: <code class="prompt">$</code> cd .../pkgsrc/category
                   9917: <code class="prompt">$</code> cvs add pkgname
                   9918: <code class="prompt">$</code> cd pkgname
                   9919: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9920: <code class="prompt">$</code> cvs add patches/p*
                   9921: <code class="prompt">$</code> cvs status | less
1.34      wiz      9922: <code class="prompt">$</code> cvs commit
1.33      wiz      9923: <code class="prompt">$</code> cd ..
                   9924: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      9925: <code class="prompt">$</code> cvs commit Makefile
1.66      asau     9926: <code class="prompt">$</code> cd pkgname
1.73      jnemeth  9927: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33      wiz      9928: </pre>
1.1       dsieger  9929: <p>The commit message of the initial import should include part of the
                   9930:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9931:   what the package is/does.</p>
1.33      wiz      9932: <p>Also mention the new package in
                   9933: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9934: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9935: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  9936: </div>
1.41      asau     9937: <div class="sect1">
1.1       dsieger  9938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9939: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9940: <p>Please always put a concise, appropriate and relevant summary of the
                   9941:   changes between old and new versions into the commit log when updating
                   9942:   a package. There are various reasons for this:</p>
1.41      asau     9943: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9944: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9945:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9946: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9947:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9948: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9949:   repository is very useful for people who read the pkgsrc-changes mailing
                   9950:   list, so that they can make tactical decisions about when to upgrade
                   9951:   the package.</p></li>
                   9952: </ul></div>
                   9953: <p>Please also recognize that, just because a new version of a package
                   9954:   has been released, it should not automatically be upgraded in the CVS
                   9955:   repository.  We prefer to be conservative in the packages that are
                   9956:   included in pkgsrc - development or beta packages are not really the
                   9957:   best thing for most places in which pkgsrc is used. Please use your
                   9958:   judgement about what should go into pkgsrc, and bear in mind that
                   9959:   stability is to be preferred above new and possibly untested features.</p>
                   9960: </div>
1.41      asau     9961: <div class="sect1">
1.1       dsieger  9962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9963: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20      snj      9964: <p>Renaming packages is not recommended.</p>
1.175     gutterid 9965: <p>When renaming packages, be sure to fix any references to the old name
1.20      snj      9966:   in other Makefiles, options, buildlink files, etc.</p>
1.167     leot     9967: <p>
1.175     gutterid 9968:   Also, when renaming a package, please add
1.167     leot     9969:   the package name and version pattern(s) of the previous package
                   9970:   to <code class="varname">SUPERSEDES</code>.
1.20      snj      9971:   This may be repeated for multiple renames.
                   9972:   The new package would be an exact replacement.
1.167     leot     9973:   Example:
1.20      snj      9974: </p>
1.167     leot     9975: <pre class="programlisting">
                   9976: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9977: SUPERSEDES+=    optcomp-[0-9]*
                   9978: </pre>
1.23      wiz      9979: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9980:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9981:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9982:   not be an exact replacement but is a suggestion for the replaced
                   9983:   functionality.</p>
                   9984: </div>
1.41      asau     9985: <div class="sect1">
1.20      snj      9986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9987: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20      snj      9988: <p>It is preferred that packages are not renamed or moved, but if needed
                   9989:   please follow these steps.
                   9990: </p>
1.23      wiz      9991: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9992: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9993: <li class="listitem">
1.1       dsieger  9994: <p>Remove all CVS dirs.</p>
                   9995: <p>Alternatively to the first two steps you can also do:</p>
                   9996: <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>
                   9997: <p>and use that for further work.</p>
                   9998: </li>
1.23      wiz      9999: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   10000: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   10001: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   10002: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      10003: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   10004: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   10005: for doing an update using pkgsrc building; for example, it can
1.207     leot     10006: 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.20      snj      10007: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   10008: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   10009: it may have multiple matches, so the tool should also check on the
                   10010: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   10011: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   10012: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      10013: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  10014: place.</p></li>
1.23      wiz      10015: <li class="listitem">
1.1       dsieger  10016: <p>Check if any package depends on it:
                   10017: </p>
                   10018: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   10019: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   10020: </li>
1.23      wiz      10021: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   10022: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   10023: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   10024: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   10025: <li class="listitem">
1.1       dsieger  10026: <p>Commit the changed and removed files:</p>
                   10027: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   10028: <p>(and any packages from step 5, of course).</p>
                   10029: </li>
                   10030: </ol></div>
                   10031: </div>
                   10032: </div>
1.41      asau     10033: <div class="chapter">
1.1       dsieger  10034: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   10035: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  10036: <p>This section contains the answers to questions that may
                   10037:        arise when you are writing a package. If you don't find your
                   10038:        question answered here, first have a look in the other chapters,
                   10039:        and if you still don't have the answer, ask on the
                   10040:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     10041: <div class="qandaset">
1.174     leot     10042: <a name="devfaq.qandaset"></a><dl>
1.154     rillig   10043: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  10044:        MAKEFLAGS, .MAKEFLAGS and
                   10045:        MAKE_FLAGS?</a>
                   10046: </dt>
1.154     rillig   10047: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  10048:        MAKE, GMAKE and
                   10049:        MAKE_PROGRAM?</a>
                   10050: </dt>
1.154     rillig   10051: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  10052:        CC, PKG_CC and
                   10053:        PKGSRC_COMPILER?</a>
                   10054: </dt>
1.223     nia      10055: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  10056:        VARNAME=BUILDLINK_PREFIX.foo
                   10057:        say it's empty?</a>
                   10058: </dt>
1.223     nia      10059: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1       dsieger  10060:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   10061:        don't understand the := inside
                   10062:        it.</a>
                   10063: </dt>
1.223     nia      10064: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  10065:        developers?</a>
                   10066: </dt>
1.223     nia      10067: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  10068:        documentation?</a>
                   10069: </dt>
1.223     nia      10070: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174     leot     10071: What shall I do?</a>
1.1       dsieger  10072: </dt>
                   10073: </dl>
1.41      asau     10074: <table border="0" style="width: 100%;">
                   10075: <colgroup>
1.1       dsieger  10076: <col align="left" width="1%">
1.23      wiz      10077: <col>
1.41      asau     10078: </colgroup>
1.1       dsieger  10079: <tbody>
1.41      asau     10080: <tr class="question">
1.1       dsieger  10081: <td align="left" valign="top">
1.174     leot     10082: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1       dsieger  10083: </td>
                   10084: <td align="left" valign="top"><p>What is the difference between
                   10085:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10086:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10087: </tr>
                   10088: <tr class="answer">
                   10089: <td align="left" valign="top"></td>
1.223     nia      10090: <td align="left" valign="top">
                   10091: <p><code class="varname">MAKEFLAGS</code> are the flags passed
                   10092:        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>.</p>
                   10093: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
                   10094:        passed to the <code class="varname">MAKE_PROGRAM</code> when building the
                   10095:        package.</p>
                   10096: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
                   10097:        <span class="command"><strong>bmake</strong></span> and should not be used by
                   10098:        packages.</p>
                   10099: </td>
1.1       dsieger  10100: </tr>
1.41      asau     10101: <tr class="question">
1.1       dsieger  10102: <td align="left" valign="top">
1.174     leot     10103: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1       dsieger  10104: </td>
                   10105: <td align="left" valign="top"><p>What is the difference between
                   10106:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10107:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10108: </tr>
                   10109: <tr class="answer">
                   10110: <td align="left" valign="top"></td>
1.223     nia      10111: <td align="left" valign="top">
                   10112: <p><code class="varname">MAKE</code> is the path to the
1.207     leot     10113:        <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.223     nia      10114:        infrastructure.</p>
                   10115: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
                   10116:        need to say <code class="varname">USE_TOOLS+=gmake</code> to use
                   10117:        that.</p>
                   10118: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
                   10119:        program that is used for building the package.</p>
                   10120: </td>
1.1       dsieger  10121: </tr>
1.41      asau     10122: <tr class="question">
1.1       dsieger  10123: <td align="left" valign="top">
1.174     leot     10124: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1       dsieger  10125: </td>
                   10126: <td align="left" valign="top"><p>What is the difference between
                   10127:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10128:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10129: </tr>
                   10130: <tr class="answer">
                   10131: <td align="left" valign="top"></td>
                   10132: <td align="left" valign="top">
1.223     nia      10133: <p><code class="varname">CC</code> is the path to the real C
                   10134:        compiler, which can be configured by the pkgsrc user.</p>
                   10135: <p><code class="varname">PKG_CC</code> is the path to the compiler
                   10136:        wrapper.</p>
                   10137: <p><code class="varname">PKGSRC_COMPILER</code> is
                   10138:        <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
                   10139:        compiler that should be used. See
                   10140:        <code class="filename">mk/compiler.mk</code> for more information about
                   10141:        the latter variable.</p>
1.1       dsieger  10142: </td>
                   10143: </tr>
1.41      asau     10144: <tr class="question">
1.1       dsieger  10145: <td align="left" valign="top">
1.223     nia      10146: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1       dsieger  10147: </td>
1.10      hubertf  10148: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  10149:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10150:        say it's empty?</p></td>
                   10151: </tr>
                   10152: <tr class="answer">
                   10153: <td align="left" valign="top"></td>
                   10154: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      10155:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10156:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  10157:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  10158:        command.</p></td>
                   10159: </tr>
1.41      asau     10160: <tr class="question">
1.1       dsieger  10161: <td align="left" valign="top">
1.223     nia      10162: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1       dsieger  10163: </td>
                   10164: <td align="left" valign="top"><p>What does
1.108     rillig   10165:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10166:        don't understand the <code class="code">:=</code> inside
1.1       dsieger  10167:        it.</p></td>
                   10168: </tr>
                   10169: <tr class="answer">
                   10170: <td align="left" valign="top"></td>
1.223     nia      10171: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
                   10172:        assignment operator, even though it may look like one.
1.1       dsieger  10173:        Instead, it is a degenerate form of
1.108     rillig   10174:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.207     leot     10175:        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.108     rillig   10176:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1       dsieger  10177:        case of <code class="varname">MASTER_SITE_*</code>,
                   10178:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10179:        <em class="replaceable"><code>new_string</code></em> is
1.108     rillig   10180:        <code class="code">package/</code>. That's where the
                   10181:        <code class="code">:</code> and the <code class="code">=</code> fall
1.1       dsieger  10182:        together.</p></td>
                   10183: </tr>
1.41      asau     10184: <tr class="question">
1.1       dsieger  10185: <td align="left" valign="top">
1.223     nia      10186: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1       dsieger  10187: </td>
                   10188: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10189:        developers?</p></td>
                   10190: </tr>
                   10191: <tr class="answer">
                   10192: <td align="left" valign="top"></td>
1.41      asau     10193: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174     leot     10194: <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.1       dsieger  10195: <dd><p>This is a list for technical discussions related
                   10196:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10197:        pkgsrc infrastructure, proposed new features, questions related
                   10198:        to porting pkgsrc to a new platform, advice for maintaining a
                   10199:        package, patches that affect many packages, help requests moved
                   10200:        from pkgsrc-users when an infrastructure bug is found,
                   10201:        etc.</p></dd>
1.174     leot     10202: <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.1       dsieger  10203: <dd><p>All bug reports in category "pkg" sent with
1.207     leot     10204:        <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.1       dsieger  10205:        directly; use one of the other mailing
                   10206:        lists.</p></dd>
                   10207: </dl></div></td>
                   10208: </tr>
1.41      asau     10209: <tr class="question">
1.1       dsieger  10210: <td align="left" valign="top">
1.223     nia      10211: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1       dsieger  10212: </td>
                   10213: <td align="left" valign="top"><p>Where is the pkgsrc
                   10214:        documentation?</p></td>
                   10215: </tr>
                   10216: <tr class="answer">
                   10217: <td align="left" valign="top"></td>
                   10218: <td align="left" valign="top">
                   10219: <p>There are many places where you can find
                   10220:        documentation about pkgsrc:</p>
1.41      asau     10221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10222: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  10223:        of chapters that explain large parts of pkgsrc, but some
                   10224:        chapters tend to be outdated. Which ones they are is hard to
                   10225:        say.</p></li>
1.174     leot     10226: <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.1       dsieger  10227:        about certain features, announcements of new parts of the pkgsrc
                   10228:        infrastructure and sometimes even announcements that a certain
                   10229:        feature has been marked as obsolete. The benefit here is that
                   10230:        each message has a date appended to it.</p></li>
1.23      wiz      10231: <li class="listitem"><p>Many of the files in the
1.1       dsieger  10232:        <code class="filename">mk/</code> directory start with a comment that
                   10233:        describes the purpose of the file and how it can be used by the
                   10234:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  10235:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  10236:        help</strong></span>.</p></li>
1.23      wiz      10237: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  10238:        information, but they tend to be highly abbreviated, especially
                   10239:        for actions that occur often. Some contain a detailed
                   10240:        description of what has changed, but they are geared towards the
                   10241:        other pkgsrc developers, not towards an average pkgsrc user.
                   10242:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10243:        don't know what has been before, these messages may not be worth
                   10244:        too much to you.</p></li>
1.23      wiz      10245: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10246:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  10247:        mind of the developer who wrote the code. To get this
1.10      hubertf  10248:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  10249:        to see who has written it and ask on the
                   10250:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10251:        find your questions later (see above). To be sure that the
                   10252:        developer in charge reads the mail, you may CC him or
                   10253:        her.</p></li>
                   10254: </ul></div>
1.184     rillig   10255: </td>
                   10256: </tr>
                   10257: <tr class="question">
                   10258: <td align="left" valign="top">
1.223     nia      10259: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184     rillig   10260: </td>
1.223     nia      10261: <td align="left" valign="top"><p>I have a little time to kill.
1.184     rillig   10262: What shall I do?</p></td>
                   10263: </tr>
                   10264: <tr class="answer">
                   10265: <td align="left" valign="top"></td>
                   10266: <td align="left" valign="top">
                   10267: <p>This is not really an FAQ yet, but here's the answer
                   10268: anyway.</p>
1.41      asau     10269: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184     rillig   10270: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207     leot     10271:     <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.184     rillig   10272:     will tell you about newer versions of installed packages that are
                   10273:     available, but not yet updated in pkgsrc.</p></li>
                   10274: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10275:     &mdash; it contains a list of suggested new packages and a list of
                   10276:     cleanups and enhancements for pkgsrc that would be nice to
                   10277:     have.</p></li>
                   10278: <li class="listitem"><p>Review packages for which review was requested on
                   10279:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10280:     mailing list.</p></li>
1.1       dsieger  10281: </ul></div>
1.184     rillig   10282: </td>
1.1       dsieger  10283: </tr>
                   10284: </tbody>
1.184     rillig   10285: </table>
1.1       dsieger  10286: </div>
                   10287: </div>
                   10288: </div>
1.41      asau     10289: <div class="part">
1.1       dsieger  10290: <div class="titlepage"><div><div><h1 class="title">
                   10291: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     10292: <div class="partintro">
1.1       dsieger  10293: <div></div>
                   10294: <p>This part of the guide deals with everything
                   10295:        from the infrastructure that is behind the interfaces described
                   10296:        in the developer's guide. A casual package maintainer should not
                   10297:        need anything from this part.</p>
                   10298: <div class="toc">
                   10299: <p><b>Table of Contents</b></p>
1.100     leot     10300: <dl class="toc">
1.184     rillig   10301: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10302: <dd><dl>
1.184     rillig   10303: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10304: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10305: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger  10306: <dd><dl>
1.184     rillig   10307: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10308: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger  10309: </dl></dd>
1.184     rillig   10310: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10311: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10312: <dd><dl>
1.184     rillig   10313: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10314: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10315: </dl></dd>
1.184     rillig   10316: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10317: <dd><dl>
1.184     rillig   10318: <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>
                   10319: <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.1       dsieger  10320: </dl></dd>
                   10321: </dl></dd>
1.184     rillig   10322: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1       dsieger  10323: <dd><dl>
1.184     rillig   10324: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10325: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger  10326: <dd><dl>
1.184     rillig   10327: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10328: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger  10329: </dl></dd>
                   10330: </dl></dd>
1.184     rillig   10331: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10332: <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.1       dsieger  10333: </dl>
                   10334: </div>
                   10335: </div>
1.41      asau     10336: <div class="chapter">
1.1       dsieger  10337: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10338: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10339: <div class="toc">
                   10340: <p><b>Table of Contents</b></p>
1.100     leot     10341: <dl class="toc">
1.184     rillig   10342: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10343: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10344: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger  10345: <dd><dl>
1.184     rillig   10346: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10347: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger  10348: </dl></dd>
1.184     rillig   10349: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10350: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10351: <dd><dl>
1.184     rillig   10352: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10353: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10354: </dl></dd>
1.184     rillig   10355: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10356: <dd><dl>
1.184     rillig   10357: <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>
                   10358: <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.1       dsieger  10359: </dl></dd>
                   10360: </dl>
                   10361: </div>
                   10362: <p>The pkgsrc infrastructure consists of many small Makefile
                   10363:        fragments. Each such fragment needs a properly specified
                   10364:        interface. This chapter explains how such an interface looks
                   10365:        like.</p>
1.41      asau     10366: <div class="sect1">
1.1       dsieger  10367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10368: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10369: <p>Whenever a variable is defined in the pkgsrc
                   10370:        infrastructure, the location and the way of definition provide
                   10371:        much information about the intended use of that variable.
                   10372:        Additionally, more documentation may be found in a header
                   10373:        comment or in this pkgsrc guide.</p>
                   10374: <p>A special file is
                   10375:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10376:        variables that are intended to be user-defined. They are either
                   10377:        defined using the <code class="literal">?=</code> operator or they are
                   10378:        left undefined because defining them to anything would
1.23      wiz      10379:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10380:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10381:        file.</p>
                   10382: <p>Outside this file, the following conventions apply:
                   10383:        Variables that are defined using the <code class="literal">?=</code>
                   10384:        operator may be overridden by a package.</p>
                   10385: <p>Variables that are defined using the <code class="literal">=</code>
                   10386:        operator may be used read-only at run-time.</p>
                   10387: <p>Variables whose name starts with an underscore must not be
                   10388:        accessed outside the pkgsrc infrastructure at all. They may
                   10389:        change without further notice.</p>
1.41      asau     10390: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10391: <h3 class="title">Note</h3>
                   10392: <p>These conventions are currently not applied
                   10393:        consistently to the complete pkgsrc
                   10394:        infrastructure.</p>
                   10395: </div>
                   10396: </div>
1.41      asau     10397: <div class="sect1">
1.1       dsieger  10398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10399: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10400: <p>All variables that contain lists of things should default
                   10401:        to being empty. Two examples that do not follow this rule are
                   10402:        <code class="varname">USE_LANGUAGES</code> and
                   10403:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10404:        modified using the <code class="literal">+=</code> operator in package
                   10405:        <code class="filename">Makefile</code>s (or other files included by
                   10406:        them), since there is no guarantee whether the variable is
                   10407:        already set or not, and what its value is. In the case of
1.23      wiz      10408:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10409:        the default value and just define it as in the following
                   10410:        example.</p>
                   10411: <pre class="programlisting">
                   10412: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10413: </pre>
                   10414: <p>Because of the selection of this default value, the same
                   10415:        value appears in many package Makefiles. Similarly for
                   10416:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10417:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10418:        doesn't stand out. Nevertheless it is mentioned in many
                   10419:        files.</p>
                   10420: </div>
1.41      asau     10421: <div class="sect1">
1.1       dsieger  10422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10423: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41      asau     10424: <div class="sect2">
1.1       dsieger  10425: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10426: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1       dsieger  10427: <p>Variable evaluation takes place either at load time or at
                   10428:        runtime, depending on the context in which they occur. The
                   10429:        contexts where variables are evaluated at load time are:</p>
1.41      asau     10430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10431: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10432:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10433: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10434:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10435: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10436: </ul></div>
                   10437: <p>A special exception are references to the iteration
                   10438:        variables of <code class="literal">.for</code> loops, which are expanded
                   10439:        inline, no matter in which context they appear.</p>
                   10440: <p>As the values of variables may change during load time,
                   10441:        care must be taken not to evaluate them by accident. Typical
                   10442:        examples for variables that should not be evaluated at load time
                   10443:        are <code class="varname">DEPENDS</code> and
                   10444:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10445:        clear, here is an example:</p>
                   10446: <pre class="programlisting">
                   10447: CONFIGURE_ARGS=         # none
                   10448: CFLAGS=                 -O
                   10449: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10450: 
                   10451: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10452: 
                   10453: CFLAGS+=                -Wall
1.111     sevan    10454: </pre>
1.1       dsieger  10455: <p>This code shows how the use of the <code class="literal">:=</code>
                   10456:        operator can quickly lead to unexpected results. The first
                   10457:        paragraph is fairly common code. The second paragraph evaluates
                   10458:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10459:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10460:        <code class="literal">-Wall</code> is appended to the
                   10461:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10462:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10463:        paragraphs from above typically occur in completely unrelated
                   10464:        files.</p>
                   10465: </div>
1.41      asau     10466: <div class="sect2">
1.1       dsieger  10467: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10468: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10469: <p>After all the files have been loaded, the values of the
                   10470:        variables cannot be changed anymore. Variables that are used in
                   10471:        the shell commands are expanded at this point.</p>
                   10472: </div>
                   10473: </div>
1.41      asau     10474: <div class="sect1">
1.1       dsieger  10475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10476: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10477: <p>There are many ways in which the definition and use of a
1.108     rillig   10478:        variable can be restricted in order to detect bugs and violations
                   10479:        of the (mostly unwritten) policies. A package can be checked with
                   10480:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10481:        rules.</p>
1.1       dsieger  10482: </div>
1.41      asau     10483: <div class="sect1">
1.1       dsieger  10484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10485: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10486: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10487:        of the following classes. Cases where a file falls into more
                   10488:        than one class should be avoided as it often leads to subtle
                   10489:        bugs.</p>
1.41      asau     10490: <div class="sect2">
1.1       dsieger  10491: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10492: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10493: <p>In a traditional imperative programming language some of
                   10494:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10495:        procedures. They take some input parameters and&mdash;after
                   10496:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10497:        variables in <code class="filename">Makefile</code>s have global scope
                   10498:        care must be taken not to use parameter names that have already
                   10499:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10500:        bad choice for a parameter name.</p>
                   10501: <p>Procedures are completely evaluated at preprocessing time.
                   10502:        That is, when calling a procedure all input parameters must be
                   10503:        completely resolvable. For example,
                   10504:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10505:        parameter since it is very likely that further text will be
                   10506:        added after calling the procedure, which would effectively apply
                   10507:        the procedure to only a part of the variable. Also, references
1.108     rillig   10508:        to other variables will be modified after calling the
1.1       dsieger  10509:        procedure.</p>
                   10510: <p>A procedure can declare its output parameters either as
                   10511:        suitable for use in preprocessing directives or as only
                   10512:        available at runtime. The latter alternative is for variables
                   10513:        that contain references to other runtime variables.</p>
                   10514: <p>Procedures shall be written such that it is possible to
                   10515:        call the procedure more than once. That is, the file must not
                   10516:        contain multiple-inclusion guards.</p>
                   10517: <p>Examples for procedures are
                   10518:        <code class="filename">mk/bsd.options.mk</code> and
                   10519:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10520:        that the parameters are evaluated at load time, they should be
                   10521:        assigned using the <code class="literal">:=</code> operator, which should
                   10522:        be used only for this purpose.</p>
                   10523: </div>
1.41      asau     10524: <div class="sect2">
1.1       dsieger  10525: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10526: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10527: <p>Action files take some input parameters and may define
                   10528:        runtime variables. They shall not define loadtime variables.
                   10529:        There are action files that are included implicitly by the
                   10530:        pkgsrc infrastructure, while other must be included
                   10531:        explicitly.</p>
                   10532: <p>An example for action files is
                   10533:        <code class="filename">mk/subst.mk</code>.</p>
                   10534: </div>
                   10535: </div>
1.41      asau     10536: <div class="sect1">
1.1       dsieger  10537: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10538: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10539: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10540:        a set of variable definitions, and include the file
                   10541:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10542:        Before that, they may also include various other
                   10543:        <code class="filename">*.mk</code> files if they need to query the
                   10544:        availability of certain features like the type of compiler or
                   10545:        the X11 implementation. Due to the heavy use of preprocessor
                   10546:        directives like <code class="literal">.if</code> and
                   10547:        <code class="literal">.for</code>, the order in which the files are loaded
                   10548:        matters.</p>
                   10549: <p>This section describes at which point the various files
                   10550:        are loaded and gives reasons for that order.</p>
1.41      asau     10551: <div class="sect2">
1.1       dsieger  10552: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10553: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10554: </h3></div></div></div>
                   10555: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10556:        is to define some essential variables like
                   10557:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10558:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10559: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10560:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   10561:        After that, those variables
1.1       dsieger  10562:        that have not been overridden by the user are loaded from
                   10563:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10564: <p>After the user settings, the system settings and platform
                   10565:        settings are loaded, which may override the user
                   10566:        settings.</p>
                   10567: <p>Then, the tool definitions are loaded. The tool wrappers
                   10568:        are not yet in effect. This only happens when building a
                   10569:        package, so the proper variables must be used instead of the
                   10570:        direct tool names.</p>
                   10571: <p>As the last steps, some essential variables from the
                   10572:        wrapper and the package system flavor are loaded, as well as the
                   10573:        variables that have been cached in earlier phases of a package
                   10574:        build.</p>
                   10575: </div>
1.41      asau     10576: <div class="sect2">
1.1       dsieger  10577: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10578: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10579: </h3></div></div></div>
                   10580: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10581: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10582:        loaded, which fill default values for those variables that have
                   10583:        not been defined by the package. These variables may later
                   10584:        be used even in unrelated files.</p>
                   10585: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10586:        provides the target <code class="literal">error-check</code> that is added
                   10587:        as a special dependency to all other targets that use
                   10588:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10589:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10590: <p>Then, the package-specific hacks from
                   10591:        <code class="filename">hacks.mk</code> are included.</p>
                   10592: <p>Then, various other files follow. Most of them don't have
                   10593:        any dependencies on what they need to have included before or
                   10594:        after them, though some do.</p>
                   10595: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10596:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10597:        restricts the use of these variables to all the files that have
                   10598:        been included before. Appearances in later files will be
                   10599:        silently ignored.</p>
                   10600: <p>Then, the files for the main targets are included, in the
                   10601:        order of later execution, though the actual order should not
                   10602:        matter.</p>
                   10603: <p>At last, some more files are included that don't set any
                   10604:        interesting variables but rather just define make targets to be
                   10605:        executed.</p>
                   10606: </div>
                   10607: </div>
                   10608: </div>
1.41      asau     10609: <div class="chapter">
1.1       dsieger  10610: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10611: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1       dsieger  10612: <div class="toc">
                   10613: <p><b>Table of Contents</b></p>
1.100     leot     10614: <dl class="toc">
1.184     rillig   10615: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10616: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger  10617: <dd><dl>
1.184     rillig   10618: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10619: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger  10620: </dl></dd>
                   10621: </dl>
                   10622: </div>
                   10623: <p>The pkgsrc infrastructure consists of a large codebase,
                   10624:        and there are many corners where every little bit of a file is
                   10625:        well thought out, making pkgsrc likely to fail as soon as
                   10626:        anything is changed near those parts. To prevent most changes
                   10627:        from breaking anything, a suite of regression tests should go
                   10628:        along with every important part of the pkgsrc infrastructure.
                   10629:        This chapter describes how regression tests work in pkgsrc and
                   10630:        how you can add new tests.</p>
1.41      asau     10631: <div class="sect1">
1.1       dsieger  10632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10633: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207     leot     10634: <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.10      hubertf  10635:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10636:        can simply run that command, which will run all tests in the
1.168     rillig   10637:        <code class="filename">regress/</code> directory.</p>
1.1       dsieger  10638: </div>
1.41      asau     10639: <div class="sect1">
1.1       dsieger  10640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10641: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168     rillig   10642: <p>Every directory in the <code class="filename">regress/</code>
                   10643:        directory that contains a file called <code class="filename">spec</code>
1.1       dsieger  10644:        is considered a regression test. This file is a shell program
1.10      hubertf  10645:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10646:        The following functions can be overridden to suit your
                   10647:        needs.</p>
1.41      asau     10648: <div class="sect2">
1.1       dsieger  10649: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10650: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108     rillig   10651: <p>These functions do not take any parameters. Although they
                   10652:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.174     leot     10653:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108     rillig   10654:        question</a> for details.</p>
1.41      asau     10655: <div class="variablelist"><dl class="variablelist">
1.108     rillig   10656: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1       dsieger  10657: <dd><p>This function prepares the environment for the
                   10658:        test. By default it does nothing.</p></dd>
1.108     rillig   10659: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10660: <dd>
                   10661: <p>This function runs the actual test. By default,
1.1       dsieger  10662:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10663:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10664:        error messages into the file
1.108     rillig   10665:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10666: <p>When defining this function, make sure that all output that
                   10667:        needs to be checked is written to the correct output file.
                   10668:        Example:</p>
                   10669: <pre class="programlisting">
                   10670: do_test() {
1.112     rillig   10671:         echo "Example output"
1.108     rillig   10672: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10673: </pre>
                   10674: </dd>
                   10675: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10676: <dd>
                   10677: <p>This function is run after the test and is
1.1       dsieger  10678:        typically used to compare the actual output from the one that is
                   10679:        expected. It can make use of the various helper functions from
1.108     rillig   10680:        the next section. Example:</p>
                   10681: <pre class="programlisting">
                   10682: check_result() {
1.112     rillig   10683:         exit_status 0
                   10684:         output_require "Example"
                   10685:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10686:         output_prohibit "no such file or directory"
1.168     rillig   10687:         regress_fail "expected $expected but got $actual for input $input"
1.108     rillig   10688: }
                   10689: </pre>
                   10690: </dd>
                   10691: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1       dsieger  10692: <dd><p>This function cleans everything up after the
                   10693:        test has been run. By default it does nothing.</p></dd>
                   10694: </dl></div>
                   10695: </div>
1.41      asau     10696: <div class="sect2">
1.1       dsieger  10697: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10698: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41      asau     10699: <div class="variablelist"><dl class="variablelist">
1.168     rillig   10700: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10701: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108     rillig   10702: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1       dsieger  10703: <dd><p>This function compares the exitcode of the
1.108     rillig   10704:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1       dsieger  10705:        If they differ, the test will fail.</p></dd>
1.108     rillig   10706: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10707: <dd>
                   10708: <p>This function checks for each of its parameters
                   10709:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1       dsieger  10710:        extended regular expression. If it does not, the test will
1.108     rillig   10711:        fail. Example:</p>
                   10712: <pre class="programlisting">
                   10713: output_require "looks fine"
                   10714: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10715: </pre>
                   10716: </dd>
1.177     leot     10717: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1       dsieger  10718: <dd><p>This function checks for each of its parameters
1.10      hubertf  10719:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10720:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10721:        If any of the regular expressions matches, the test will
                   10722:        fail.</p></dd>
                   10723: </dl></div>
                   10724: </div>
                   10725: </div>
                   10726: </div>
1.41      asau     10727: <div class="chapter">
1.1       dsieger  10728: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10729: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10730: <div class="toc">
                   10731: <p><b>Table of Contents</b></p>
1.184     rillig   10732: <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.1       dsieger  10733: </div>
                   10734: <p>The pkgsrc system has already been ported to many
                   10735:        operating systems, hardware architectures and compilers. This
                   10736:        chapter explains the necessary steps to make pkgsrc even more
                   10737:        portable.</p>
1.41      asau     10738: <div class="sect1">
1.1       dsieger  10739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10740: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10741: <p>To port pkgsrc to a new operating system (called
                   10742:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10743:        following files:</p>
1.41      asau     10744: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10745: <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>
                   10746: <dd><p>This file contains some basic definitions, for
                   10747:        example the name of the C
                   10748:        compiler.</p></dd>
                   10749: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10750: <dd><p>Insert code that defines the variables
                   10751:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212     wiz      10752:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1       dsieger  10753:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10754:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10755:        appear in this file.</p></dd>
                   10756: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10757: <dd><p>This file contains the platform-specific
                   10758:        definitions that are used by pkgsrc. Start by copying one of the
                   10759:        other files and edit it to your
                   10760:        needs.</p></dd>
                   10761: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10762: <dd><p>This file defines the paths to all the tools
                   10763:        that are needed by one or the other package in pkgsrc, as well
                   10764:        as by pkgsrc itself. Find out where these tools are on your
                   10765:        platform and add them.</p></dd>
                   10766: </dl></div>
                   10767: <p>Now, you should be able to build some basic packages, like
1.207     leot     10768:        <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.1       dsieger  10769: </div>
                   10770: </div>
                   10771: </div>
1.41      asau     10772: <div class="appendix">
                   10773: <div class="titlepage"><div><div><h1 class="title">
                   10774: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  10775: <div class="toc">
                   10776: <p><b>Table of Contents</b></p>
1.100     leot     10777: <dl class="toc">
1.1       dsieger  10778: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10779: <dd><dl>
                   10780: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10781: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10782: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172     rillig   10783: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger  10784: </dl></dd>
                   10785: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10786: </dl>
                   10787: </div>
                   10788: <p>We checked to find a piece of software that wasn't in the packages
                   10789:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10790:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10791:     present in the tree is beyond us, but it's useful for the purposes of
                   10792:     this exercise.</p>
1.41      asau     10793: <div class="sect1">
1.1       dsieger  10794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10795: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     10796: <div class="sect2">
1.1       dsieger  10797: <div class="titlepage"><div><div><h3 class="title">
                   10798: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10799: <pre class="programlisting">
                   10800: # $NetBSD$
                   10801: #
                   10802: 
                   10803: DISTNAME=       bison-1.25
                   10804: CATEGORIES=     devel
1.171     rillig   10805: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       dsieger  10806: 
1.29      dholland 10807: MAINTAINER=     pkgsrc-users@NetBSD.org
1.174     leot     10808: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.1       dsieger  10809: COMMENT=        GNU yacc clone
                   10810: 
                   10811: GNU_CONFIGURE=  yes
1.46      wiz      10812: INFO_FILES=     yes
1.1       dsieger  10813: 
                   10814: .include "../../mk/bsd.pkg.mk"
                   10815: </pre>
                   10816: </div>
1.41      asau     10817: <div class="sect2">
1.1       dsieger  10818: <div class="titlepage"><div><div><h3 class="title">
                   10819: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10820: <pre class="programlisting">
                   10821: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.207     leot     10822: 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.1       dsieger  10823: of the NetBSD source tree is beyond me.
                   10824: </pre>
                   10825: </div>
1.41      asau     10826: <div class="sect2">
1.1       dsieger  10827: <div class="titlepage"><div><div><h3 class="title">
                   10828: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10829: <pre class="programlisting">
                   10830: @comment $NetBSD$
                   10831: bin/bison
                   10832: man/man1/bison.1.gz
                   10833: share/bison.simple
                   10834: share/bison.hairy
                   10835: </pre>
                   10836: </div>
1.41      asau     10837: <div class="sect2">
1.1       dsieger  10838: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   10839: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1       dsieger  10840: <p>The NetBSD package system comes with
1.207     leot     10841:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1       dsieger  10842:        which helps to check the contents of these
                   10843:        files. After installation it is quite easy to use, just change to the
1.171     rillig   10844:        directory of the package you wish to examine and run
1.10      hubertf  10845:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10846: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171     rillig   10847: ERROR: Makefile: Each package must define its LICENSE.
                   10848: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10849: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10850: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10851: 1 error, 2 warnings and 1 note found.
                   10852: (Run "pkglint -e" to show explanations.)
                   10853: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172     rillig   10854: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1       dsieger  10855: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170     rillig   10856:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1       dsieger  10857:        -Wall</strong></span> for a very thorough check.</p>
                   10858: </div>
                   10859: </div>
1.41      asau     10860: <div class="sect1">
1.1       dsieger  10861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10862: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10863: <p>Create the directory where the package lives,
                   10864:       plus any auxiliary directories:</p>
                   10865: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10866: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10867: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10868: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10869: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184     rillig   10870:       <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.1       dsieger  10871:       then continue with fetching the distfile:</p>
                   10872: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10873: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10874: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10875: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10876: ftp: Error retrieving file: 500 Internal error
                   10877: 
                   10878: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10879: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10880: ftp: Error retrieving file: 500 Internal error
                   10881: 
                   10882: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10883: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10884: Successfully retrieved file.</pre>
                   10885: <p>Generate the checksum of the distfile into
                   10886:       <code class="filename">distinfo</code>:</p>
                   10887: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10888: <p>Now compile:</p>
                   10889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10890: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10891: ===&gt;  Extracting for bison-1.25
                   10892: ===&gt;  Patching for bison-1.25
                   10893: ===&gt;   Ignoring empty patch directory
                   10894: ===&gt;  Configuring for bison-1.25
                   10895: creating cache ./config.cache
                   10896: checking for gcc... cc
                   10897: checking whether we are using GNU C... yes
                   10898: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10899: checking how to run the C preprocessor... cc -E
                   10900: checking for minix/config.h... no
                   10901: checking for POSIXized ISC... no
                   10902: checking whether cross-compiling... no
                   10903: checking for ANSI C header files... yes
                   10904: checking for string.h... yes
                   10905: checking for stdlib.h... yes
                   10906: checking for memory.h... yes
                   10907: checking for working const... yes
                   10908: checking for working alloca.h... no
                   10909: checking for alloca... yes
                   10910: checking for strerror... yes
                   10911: updating cache ./config.cache
                   10912: creating ./config.status
                   10913: creating Makefile
                   10914: ===&gt;  Building for bison-1.25
                   10915: 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
                   10916: 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
                   10917: 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
                   10918: 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
                   10919: 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
                   10920: 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
                   10921: 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
                   10922: 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
                   10923: 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
                   10924: 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
                   10925: 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
                   10926: 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
                   10927: 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
                   10928: 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
                   10929: 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
                   10930: 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
                   10931: 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
                   10932: 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
                   10933: 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
                   10934: 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
                   10935: 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
                   10936: 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
                   10937: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10938: rm -f bison.s1
                   10939: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10940: <p>Everything seems OK, so install the files:</p>
                   10941: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10942: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10943: ===&gt;  Installing for bison-1.25
                   10944: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10945: rm -f /usr/pkg/bin/bison
                   10946: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10947: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10948: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10949: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10950: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10951: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10952: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10953: ===&gt;  Registering installation for bison-1.25</pre>
                   10954: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10955:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10956:       binary package, do this now:</p>
                   10957: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10958: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10959: ===&gt;  Building package for bison-1.25
                   10960: Creating package bison-1.25.tgz
                   10961: Registering depends:.
                   10962: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10963: <p>Now that you don't need the source and object files
                   10964:       any more, clean up:</p>
                   10965: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10966: ===&gt;  Cleaning for bison-1.25</pre>
                   10967: </div>
                   10968: </div>
1.41      asau     10969: <div class="appendix">
                   10970: <div class="titlepage"><div><div><h1 class="title">
1.207     leot     10971: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1       dsieger  10972: <div class="toc">
                   10973: <p><b>Table of Contents</b></p>
1.100     leot     10974: <dl class="toc">
1.207     leot     10975: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   10976: <dd><dl>
                   10977: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   10978: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   10979: </dl></dd>
                   10980: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   10981: <dd><dl>
                   10982: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   10983: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   10984: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   10985: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   10986: </dl></dd>
                   10987: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   10988: <dd><dl>
                   10989: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   10990: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   10991: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   10992: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   10993: </dl></dd>
1.1       dsieger  10994: </dl>
                   10995: </div>
1.207     leot     10996: <p>
                   10997: A number of mechanisms are available in pkgsrc to improve the security of the
                   10998: resulting system. This page describes the mechanisms, and gives hints
                   10999: about detecting and fixing problems.
                   11000: </p>
                   11001: <p>
                   11002: Mechanisms can be enabled individually in
                   11003: <code class="filename">mk.conf</code>, and are
                   11004: individually described below.
                   11005: </p>
                   11006: <p>
                   11007: Typically, a feature will cause some programs to fail to build or work
                   11008: when first enabled. This can be due to latent problems in the
                   11009: program, and can be due to other reasons. After enough testing to
                   11010: have confidence that user problems will be quite rare, individual
                   11011: mechanisms will be enabled by default.
                   11012: </p>
                   11013: <p>
                   11014: For each mechanism, see the Caveats section below for an explanation
                   11015: of what might go wrong at compile time and at run time, and how to
                   11016: notice and address these problems.
                   11017: </p>
1.41      asau     11018: <div class="sect1">
1.1       dsieger  11019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207     leot     11020: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
                   11021: <div class="sect2">
                   11022: <div class="titlepage"><div><div><h3 class="title">
                   11023: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
                   11024: <div class="sect3">
                   11025: <div class="titlepage"><div><div><h4 class="title">
                   11026: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
                   11027: <p>
                   11028: This allows substitute wrappers to be used for some commonly used
                   11029: library functions that do not have built-in bounds checking - but
                   11030: could in some cases.
                   11031: </p>
                   11032: <p>
                   11033: Two mitigation levels are available:
                   11034: </p>
                   11035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11036: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   11037: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   11038: </ul></div>
                   11039: <p>
                   11040: "strong" has been enabled by default since pkgsrc-2017Q3.
                   11041: </p>
                   11042: </div>
                   11043: <div class="sect3">
                   11044: <div class="titlepage"><div><div><h4 class="title">
                   11045: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
                   11046: <p>
                   11047: This enables a stack-smashing protection mitigation. It is done by adding a
                   11048: guard variable to functions with vulnerable objects. The guards are initialized
                   11049: when a function is entered and then checked when the function exits. The guard
                   11050: check will fail and the program forcibly exited if the variable was modified in
                   11051: the meantime. This can happen in case of buffer overflows or memory corruption,
                   11052: and therefore exposing these bugs.
                   11053: </p>
                   11054: <p>
                   11055: Different mitigation levels are available:
                   11056: </p>
                   11057: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11058: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   11059: by the compiler;</p></li>
                   11060: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   11061: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   11062: two settings above.</p></li>
                   11063: </ul></div>
                   11064: <p>
                   11065: This mitigation is supported by both GCC and clang. It may be supported in
                   11066: additional compilers, possibly under a different name. It is particularly useful
                   11067: for unsafe programming languages, such as C/C++.
                   11068: </p>
                   11069: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11070: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   11071: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   11072: </ul></div>
                   11073: <p>More details can be found here:</p>
                   11074: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11075: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11076: </p></li></ul></div>
                   11077: </div>
                   11078: <div class="sect3">
                   11079: <div class="titlepage"><div><div><h4 class="title">
                   11080: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
                   11081: <p>
                   11082: This requests the creation of PIE (Position Independent Executables) for all
                   11083: executables. The PIE mechanism is normally used for shared libraries, so that
                   11084: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11085: useful security properties; however, it is necessary to fully leverage some,
                   11086: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11087: (ASLR), which causes different addresses to be used each time a program is run.
                   11088: This makes it more difficult for an attacker to guess addresses and thus makes
                   11089: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11090: program, instead of the stack and heap only.
                   11091: </p>
                   11092: <p>
                   11093: PIE executables will only be built for toolchains that are known to support PIE.
                   11094: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11095: </p>
                   11096: <p>
                   11097: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11098: </p>
1.1       dsieger  11099: </div>
1.210     gutterid 11100: <div class="sect3">
                   11101: <div class="titlepage"><div><div><h4 class="title">
1.219     nia      11102: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207     leot     11103: <p>
                   11104: This also makes the exploitation of some security vulnerabilities more
                   11105: difficult in some cases.
                   11106: </p>
                   11107: <p>Two different mitigation levels are available:</p>
                   11108: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11109: <li class="listitem"><p>
1.219     nia      11110: partial (the default): the ELF sections are reordered so that internal data sections
1.207     leot     11111: precede the program's own data sections, and non-PLT GOT is read-only;
                   11112: </p></li>
                   11113: <li class="listitem"><p>
                   11114: full: in addition to partial RELRO, every relocation is performed immediately
1.218     nia      11115: when starting the program, allowing the entire GOT to be read-only.  This
                   11116: can greatly slow down startup of large programs.
1.207     leot     11117: </p></li>
                   11118: </ul></div>
                   11119: <p>
                   11120: This is currently supported by GCC. Many software distributions now enable this
1.220     nia      11121: feature by default, at the "partial" level.
1.207     leot     11122: </p>
                   11123: <p>
                   11124: More details can be found here:
                   11125: </p>
                   11126: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11127: <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>
                   11128: </p></li></ul></div>
1.1       dsieger  11129: </div>
1.219     nia      11130: </div>
                   11131: <div class="sect2">
                   11132: <div class="titlepage"><div><div><h3 class="title">
                   11133: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
                   11134: <div class="sect3">
                   11135: <div class="titlepage"><div><div><h4 class="title">
                   11136: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
                   11137: <p>
                   11138: With this option, pkgsrc will try to build packages reproducibly. This allows
                   11139: packages built from the same tree and with the same options, to produce
                   11140: identical results bit by bit. This option should be combined with ASLR and
                   11141: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
                   11142: attackers attempting to exploit security vulnerabilities.
                   11143: </p>
                   11144: <p>
                   11145: More details can be found here:
                   11146: </p>
                   11147: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11148: <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>
                   11149: </p></li></ul></div>
                   11150: <p>
                   11151: More work likely needs to be done before pkgsrc is fully reproducible.
                   11152: </p>
                   11153: </div>
1.207     leot     11154: <div class="sect3">
                   11155: <div class="titlepage"><div><div><h4 class="title">
1.219     nia      11156: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207     leot     11157: <p>
                   11158: This uses <code class="literal">-fstack-check</code> with GCC for
                   11159: another stack protection mitigation.
                   11160: </p>
                   11161: <p>
                   11162: It asks the compiler to generate code verifying that it does not corrupt the
                   11163: stack. According to GCC's manual page, this is really only useful for
                   11164: multi-threaded programs.
                   11165: </p>
1.1       dsieger  11166: </div>
                   11167: </div>
                   11168: </div>
1.41      asau     11169: <div class="sect1">
1.1       dsieger  11170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207     leot     11171: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
                   11172: <div class="sect2">
                   11173: <div class="titlepage"><div><div><h3 class="title">
                   11174: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
                   11175: <div class="sect3">
                   11176: <div class="titlepage"><div><div><h4 class="title">
                   11177: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
                   11178: <p>
                   11179: A number of packages may fail to build with this option enabled. The
                   11180: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11181: compilation flag when building libraries or executables (or ideally
                   11182: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11183: <code class="varname">CFLAGS</code> already, but requires the package to
                   11184: actually support it.
                   11185: </p>
                   11186: <div class="sect4">
                   11187: <div class="titlepage"><div><div><h5 class="title">
                   11188: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
                   11189: <p>
                   11190: These instructions are meant as a reference only; they likely need to be adapted
                   11191: for many packages individually.
                   11192: </p>
                   11193: <p>
                   11194: For packages using <code class="filename">Makefiles</code>:
                   11195: </p>
                   11196: <pre class="programlisting">
                   11197: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11198: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11199: </pre>
                   11200: <p>
                   11201: For packages using <code class="filename">Imakefiles</code>:
                   11202: </p>
                   11203: <pre class="programlisting">
                   11204: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11205: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11206: </pre>
                   11207: </div>
                   11208: </div>
                   11209: <div class="sect3">
                   11210: <div class="titlepage"><div><div><h4 class="title">
                   11211: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
                   11212: <p>
                   11213: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11214: scenarios are essentially possible. This is nearly always due to a bug in
                   11215: the program being exposed due to ASLR.
                   11216: </p>
                   11217: </div>
                   11218: <div class="sect3">
                   11219: <div class="titlepage"><div><div><h4 class="title">
                   11220: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
                   11221: <p>
                   11222: Ideally, packages should be fixed for compatibility with MKPIE.
                   11223: However, in some cases this is very difficult, due to complex build systems,
                   11224: packages using non-standard toolchains, or programming languages with odd
                   11225: bootstrapping mechanisms.
                   11226: </p>
                   11227: <p>
                   11228: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11229: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11230: <code class="filename">bsd.prefs.mk</code> is included.
                   11231: </p>
                   11232: </div>
                   11233: </div>
                   11234: <div class="sect2">
                   11235: <div class="titlepage"><div><div><h3 class="title">
                   11236: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
                   11237: <div class="sect3">
                   11238: <div class="titlepage"><div><div><h4 class="title">
                   11239: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
                   11240: <p>
                   11241: This feature makes use of pre-processing directives to look for hardened,
                   11242: alternative implementations of essential library calls. Some programs may fail
                   11243: to build as a result; this usually happens for those trying too hard to be
                   11244: portable, or otherwise abusing definitions in the standard library.
                   11245: </p>
                   11246: </div>
                   11247: <div class="sect3">
                   11248: <div class="titlepage"><div><div><h4 class="title">
                   11249: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
                   11250: <p>
                   11251: This feature may cause some programs to crash, usually indicating an
                   11252: actual bug in the program. The fix will typically involve patching the
                   11253: original program's source code.
                   11254: </p>
                   11255: </div>
                   11256: <div class="sect3">
                   11257: <div class="titlepage"><div><div><h4 class="title">
                   11258: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
                   11259: <p>
                   11260: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11261: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11262: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11263: optimization level. This cannot easily be applied globally, as some packages
                   11264: may require specific optimization levels.
                   11265: </p>
                   11266: </div>
                   11267: <div class="sect3">
                   11268: <div class="titlepage"><div><div><h4 class="title">
                   11269: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
                   11270: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11271: <h3 class="title">Note</h3>
                   11272: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11273: the program!  This is a very bad idea and will expose you to security
                   11274: vulnerabilities.
                   11275: </p>
                   11276: </div>
                   11277: <p>
                   11278: To disable FORTIFY on a per-package basis, set the following
                   11279: in the package's <code class="filename">Makefile</code>
                   11280: before <code class="filename">bsd.prefs.mk</code> is included:
                   11281: </p>
                   11282: <pre class="programlisting">
                   11283: FORTIFY_SUPPORTED=     no
                   11284: </pre>
                   11285: </div>
                   11286: </div>
                   11287: <div class="sect2">
                   11288: <div class="titlepage"><div><div><h3 class="title">
                   11289: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
                   11290: <div class="sect3">
                   11291: <div class="titlepage"><div><div><h4 class="title">
                   11292: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
                   11293: <p>
                   11294: For better protection, full RELRO requires every symbol to be resolved when the
                   11295: program starts, rather than simply when required at run-time. This will have
                   11296: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11297: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11298: background are affected only when started. Programs loading plug-ins at
                   11299: run-time are affected when loading the plug-ins.
                   11300: </p>
                   11301: <p>
                   11302: The impact is not expected to be noticeable on modern hardware, except in some
                   11303: cases for big programs.
                   11304: </p>
                   11305: </div>
                   11306: <div class="sect3">
                   11307: <div class="titlepage"><div><div><h4 class="title">
                   11308: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
                   11309: <p>
                   11310: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11311: RELRO: for instance, with an initialization routine listing any other plug-in
                   11312: required. With full RELRO, the missing symbols are resolved before the
                   11313: initialization routine can run, and the dynamic loader will not be able to find
                   11314: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11315: drivers. Partial RELRO can be applied instead in this case.
                   11316: </p>
                   11317: </div>
                   11318: <div class="sect3">
                   11319: <div class="titlepage"><div><div><h4 class="title">
                   11320: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
                   11321: <p>
                   11322: To disable RELRO on a per-package basis, set the following
                   11323: in the package's <code class="filename">Makefile</code>
                   11324: before <code class="filename">bsd.prefs.mk</code> is included:
                   11325: </p>
                   11326: <pre class="programlisting">
                   11327: RELRO_SUPPORTED=       no
                   11328: </pre>
1.209     nia      11329: <p>
                   11330: It is also possible to at most enable partial RELRO, by
                   11331: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11332: </p>
1.207     leot     11333: </div>
                   11334: </div>
                   11335: <div class="sect2">
                   11336: <div class="titlepage"><div><div><h3 class="title">
                   11337: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
                   11338: <div class="sect3">
                   11339: <div class="titlepage"><div><div><h4 class="title">
                   11340: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
                   11341: <p>
                   11342: The stack-smashing protection provided by this option does not work for some
                   11343: programs. The most common situation in which this happens is when the program
                   11344: allocates variables on the stack, with the size determined at run-time.
                   11345: </p>
                   11346: </div>
                   11347: <div class="sect3">
                   11348: <div class="titlepage"><div><div><h4 class="title">
                   11349: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
                   11350: <p>
                   11351: Again, this feature may cause some programs to crash via a
                   11352: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11353: </p>
                   11354: <p>
                   11355: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11356: messages are sent and - by default -
                   11357: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11358: </p>
                   11359: <pre class="programlisting">
                   11360: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11361: </pre>
                   11362: <p>
                   11363: (where <code class="literal">hostname</code> is the hostname(1) and
                   11364: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11365: </p>
                   11366: <p>
                   11367: Patching the original program is then required.
                   11368: </p>
                   11369: <p>
                   11370: Rebuilding the package via:
                   11371: </p>
                   11372: <pre class="programlisting">
                   11373: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11374: </pre>
                   11375: <p>
                   11376: and inspecting the backtrace of the coredump via the debugger
                   11377: should point out the problematic call by inspecting the frame
                   11378: calling the _chk() (SSP) function.
                   11379: </p>
                   11380: </div>
                   11381: <div class="sect3">
                   11382: <div class="titlepage"><div><div><h4 class="title">
                   11383: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
                   11384: <p>
                   11385: The compiler emits extra code when using this feature: a check for buffer
                   11386: overflows is performed when entering and exiting functions, requiring an extra
                   11387: variable on the stack. The level of protection can otherwise be adjusted to
                   11388: affect only those functions considered more sensitive by the compiler (with
                   11389: -fstack-protector instead of -fstack-protector-all).
                   11390: </p>
                   11391: <p>
                   11392: The impact is not expected to be noticeable on modern hardware. However,
                   11393: programs with a hard requirement to run at the fastest possible speed should
                   11394: avoid using this feature, or using libraries built with this feature.
                   11395: </p>
                   11396: </div>
                   11397: <div class="sect3">
                   11398: <div class="titlepage"><div><div><h4 class="title">
                   11399: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
                   11400: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11401: <h3 class="title">Note</h3>
                   11402: <p>SSP should not be disabled to work around runtime crashes in
                   11403: the program!  This is a very bad idea and will expose you to security
                   11404: vulnerabilities.</p>
                   11405: </div>
                   11406: <p>
                   11407: To disable SSP on a per-package basis, set the following
                   11408: in the package's <code class="filename">Makefile</code>
                   11409: before <code class="filename">bsd.prefs.mk</code> is included:
                   11410: </p>
                   11411: <pre class="programlisting">
                   11412: SSP_SUPPORTED= no
                   11413: </pre>
                   11414: </div>
                   11415: </div>
                   11416: </div>
                   11417: <div class="sect1">
                   11418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11419: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
                   11420: <p>
                   11421: The illusion of security is worse than having no security at all. This section
                   11422: lists a number of ways to ensure the security features requested are actually
                   11423: effective.
                   11424: </p>
                   11425: <p>
                   11426: These instructions were obtained and tested on a system derived from NetBSD 7
                   11427: (amd64). YMMV.
                   11428: </p>
                   11429: <div class="sect2">
                   11430: <div class="titlepage"><div><div><h3 class="title">
                   11431: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
                   11432: <p>
                   11433: The ELF executable type in use changes for binaries built as PIE; without:
                   11434: </p>
                   11435: <pre class="programlisting">
                   11436: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11437: /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
                   11438: </pre>
                   11439: <p>as opposed to the following binary, built as PIE:</p>
                   11440: <pre class="programlisting">
                   11441: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11442: /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
                   11443: </pre>
                   11444: <p>
                   11445: The latter result is then what is expected.
                   11446: </p>
                   11447: </div>
                   11448: <div class="sect2">
                   11449: <div class="titlepage"><div><div><h3 class="title">
                   11450: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
                   11451: <p>
                   11452: The following command should list a section called RELRO:
                   11453: </p>
                   11454: <pre class="programlisting">
                   11455: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11456: 
                   11457: /path/to/bin/ary:     file format elf64-x86-64
                   11458: 
                   11459: Program Header:
                   11460: [...]
                   11461:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11462: </pre>
                   11463: <p>
                   11464: This check is now performed automatically if
                   11465: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11466: </p>
                   11467: </div>
                   11468: <div class="sect2">
                   11469: <div class="titlepage"><div><div><h3 class="title">
                   11470: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
                   11471: <p>
                   11472: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11473: the <code class="varname">BIND_NOW</code> flag:
                   11474: </p>
                   11475: <pre class="programlisting">
                   11476: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11477: 
                   11478: /path/to/bin/ary:     file format elf64-x86-64
                   11479: 
                   11480: Dynamic Section:
                   11481: [...]
                   11482:   BIND_NOW             0x0000000000000000
                   11483: </pre>
                   11484: <p>
                   11485: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11486: </p>
                   11487: <p>
                   11488: This check is now performed automatically (where supported) if
                   11489: <code class="varname">PKG_DEVELOPER</code> is set.
                   11490: </p>
                   11491: </div>
                   11492: <div class="sect2">
                   11493: <div class="titlepage"><div><div><h3 class="title">
                   11494: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208     nia      11495: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11496: <h3 class="title">Note</h3>
                   11497: <p>
                   11498: Checking for SSP using this method only works where the operating system
                   11499: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11500: on recent NetBSD/FreeBSD/Linux versions.
                   11501: </p>
                   11502: </div>
1.207     leot     11503: <p>
                   11504: Building objects, binaries and libraries with SSP will affect the presence of
                   11505: additional symbols in the resulting file:
                   11506: </p>
                   11507: <pre class="programlisting">
                   11508: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11509: [...]
                   11510:                  U __stack_chk_fail
                   11511: 0000000000600ea0 B __stack_chk_guard
                   11512: </pre>
                   11513: <p>
                   11514: This is an indicator that the program was indeed built with support for SSP.
                   11515: </p>
                   11516: <p>
                   11517: This check is now performed automatically (where supported) if
                   11518: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11519: </p>
                   11520: </div>
                   11521: </div>
                   11522: </div>
                   11523: <div class="appendix">
                   11524: <div class="titlepage"><div><div><h1 class="title">
                   11525: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
                   11526: <div class="toc">
                   11527: <p><b>Table of Contents</b></p>
                   11528: <dl class="toc">
                   11529: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11530: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11531: </dl>
                   11532: </div>
                   11533: <div class="sect1">
                   11534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11535: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
                   11536: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11537: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11538: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11539: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11540: =&gt; [172219 bytes]
                   11541: Connected to ftp.plig.net.
                   11542: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11543: 331 Guest login ok, send your complete e-mail address as password.
                   11544: 230-You are user #5 of 500 simultaneous users allowed.
                   11545: 230-
                   11546: 230-  ___ _             _ _
                   11547: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11548: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11549: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11550: 230-         |_|   |_|     |___|         |___|
                   11551: 230-
                   11552: 230-** Welcome to ftp.plig.org **
                   11553: 230-
                   11554: 230-Please note that all transfers from this FTP site are logged. If you
                   11555: 230-do not like this, please disconnect now.
                   11556: 230-
                   11557: 230-This archive is available via
                   11558: 230-
                   11559: 230-HTTP:  http://ftp.plig.org/
                   11560: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11561: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11562: 230-
                   11563: 230-Please email comments, bug reports and requests for packages to be
                   11564: 230-mirrored to ftp-admin@plig.org.
                   11565: 230-
                   11566: 230-
                   11567: 230 Logged in anonymously.
                   11568: Remote system type is UNIX.
                   11569: Using binary mode to transfer files.
                   11570: 200 Type okay.
                   11571: 250 "/pub" is new cwd.
                   11572: 250-"/pub/figlet" is new cwd.
                   11573: 250-
                   11574: 250-Welcome to the figlet archive at ftp.figlet.org
                   11575: 250-
                   11576: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11577: 250-
                   11578: 250-The official FIGlet web page is:
                   11579: 250-   http://www.figlet.org/
                   11580: 250-
                   11581: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11582: 250-contribute a font or something else, you can email us.
                   11583: 250
                   11584: 250 "/pub/figlet/program" is new cwd.
                   11585: 250 "/pub/figlet/program/unix" is new cwd.
                   11586: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11587: 502 Unimplemented command.
                   11588: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11589: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11590: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11591: 226 Transfer completed.
                   11592: 172219 bytes received in 00:02 (75.99 KB/s)
                   11593: 221 Goodbye.
                   11594: =&gt; Checksum OK for figlet221.tar.gz.
                   11595: ===&gt; Extracting for figlet-2.2.1nb2
                   11596: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11597: ===&gt; Patching for figlet-2.2.1nb2
                   11598: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11599: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11600: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11601: ===&gt; Configuring for figlet-2.2.1nb2
                   11602: ===&gt; Building for figlet-2.2.1nb2
                   11603: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11604: chmod a+x figlet
                   11605: gcc -O2 -o chkfont chkfont.c
                   11606: =&gt; Unwrapping files-to-be-installed.
                   11607: <code class="prompt">#</code>
                   11608: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11609: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11610: ===&gt; Installing for figlet-2.2.1nb2
                   11611: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11612: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11613: mkdir -p /usr/pkg/share/figlet
                   11614: cp figlet /usr/pkg/bin
                   11615: cp chkfont /usr/pkg/bin
                   11616: chmod 555 figlist showfigfonts
                   11617: cp figlist /usr/pkg/bin
                   11618: cp showfigfonts /usr/pkg/bin
                   11619: cp fonts/*.flf /usr/pkg/share/figlet
                   11620: cp fonts/*.flc /usr/pkg/share/figlet
                   11621: cp figlet.6 /usr/pkg/man/man6
                   11622: ===&gt; Registering installation for figlet-2.2.1nb2
                   11623: <code class="prompt">#</code></pre>
                   11624: </div>
                   11625: <div class="sect1">
                   11626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11627: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
                   11628: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11629: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11630: ===&gt; Packaging figlet-2.2.1nb2
                   11631: ===&gt; Building binary package for figlet-2.2.1nb2
                   11632: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11633: Using SrcDir value of /usr/pkg
                   11634: Registering depends:.
                   11635: <code class="prompt">#</code></pre>
                   11636: </div>
                   11637: </div>
                   11638: <div class="appendix">
                   11639: <div class="titlepage"><div><div><h1 class="title">
                   11640: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
                   11641: <div class="toc">
                   11642: <p><b>Table of Contents</b></p>
                   11643: <dl class="toc">
                   11644: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11645: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11646: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11647: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11648: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   11649: <code class="filename">stable</code>,
                   11650: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   11651: source packages</a></span></dt>
                   11652: </dl>
                   11653: </div>
                   11654: <p>As in other big projects, the directory layout of pkgsrc
                   11655:        is quite complex for newbies. This chapter explains where you
                   11656:        find things on the FTP server. The base directory on
                   11657:        <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>.
                   11658:        On other servers it may be different, but inside this directory,
                   11659:        everything should look the same, no matter on which server you
                   11660:        are. This directory contains some subdirectories, which are
                   11661:        explained below.</p>
                   11662: <div class="sect1">
                   11663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11664: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11665: <p>The directory <code class="filename">distfiles</code> contains lots
                   11666:        of archive files from all pkgsrc packages, which are mirrored
                   11667:        here. The subdirectories are called after their package names
                   11668:        and are used when the distributed files have names that don't
                   11669:        explicitly contain a version number or are otherwise too generic
                   11670:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11671: </div>
                   11672: <div class="sect1">
                   11673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11674: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11675: <p>This directory contains things that individual pkgsrc
                   11676:        developers find worth publishing.</p>
                   11677: </div>
                   11678: <div class="sect1">
                   11679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11680: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11681: <p>This directory contains binary packages for the various
                   11682:        platforms that are supported by pkgsrc.
                   11683:        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>
                   11684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11685: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   11686:        operating system for which the packages have been built. The
                   11687:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   11688:        command, so it may differ from the one you are used to
                   11689:        hear.</p></li>
                   11690: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   11691:        architecture of the platform for which the packages have been
                   11692:        built. It also includes the <code class="varname">ABI</code> (Application
                   11693:        Binary Interface) for platforms that have several of
                   11694:        them.</p></li>
                   11695: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
                   11696:        the operating system. For version numbers that change often (for
                   11697:        example NetBSD-current), the often-changing part should be
                   11698:        replaced with an <code class="literal">x</code>, for example
                   11699:        <code class="literal">4.99.x</code>.</p></li>
                   11700: <li class="listitem"><p><code class="varname">TAG</code> is either
                   11701:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11702:        for a stable branch, or <code class="literal">head</code> for packages
                   11703:        built from the HEAD branch. The latter should only be used when
                   11704:        the packages are updated on a regular basis. Otherwise the date
                   11705:        from checking out pkgsrc should be appended, for example
                   11706:        <code class="literal">head_20071015</code>.</p></li>
                   11707: </ul></div>
                   11708: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11709:        can quickly click through the directories on the
                   11710:        server and find the best binary packages for their machines. Since they
                   11711:        usually know the operating system and the hardware architecture, OPSYS
                   11712:        and ARCH are placed first. After these choices, they can select the
                   11713:        best combination of OSVERSION and TAG together, since it is usually the
                   11714:        case that packages stay compatible between different version of the
                   11715:        operating system.</p>
                   11716: <p>In each of these directories, there is a
                   11717:        whole binary packages collection for a specific platform. It has a directory called
                   11718:        <code class="filename">All</code> which contains all binary packages.
                   11719:        Besides that, there are various category directories that
                   11720:        contain symbolic links to the real binary packages.</p>
                   11721: </div>
                   11722: <div class="sect1">
                   11723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11724: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   11725: <p>Here are the reports from bulk builds, for those who want
                   11726:        to fix packages that didn't build on some of the platforms. The
1.207     leot     11727:        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.8       rillig   11728: </div>
1.41      asau     11729: <div class="sect1">
1.8       rillig   11730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207     leot     11731: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148     leot     11732: <code class="filename">stable</code>,
1.22      jakllsch 11733: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11734: source packages</h2></div></div></div>
1.23      wiz      11735: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11736:        that is the files that define how to create binary packages from
                   11737:        source archives.</p>
1.149     leot     11738: <p>Each of the <code class="filename">current</code>,
                   11739:        <code class="filename">stable</code> and
                   11740:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11741:        directories share the same structure.  They each contain a
                   11742:        <code class="filename">pkgsrc</code> directory and
                   11743:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1       dsieger  11744: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11745:        snapshot of the CVS repository, which is updated regularly. The
1.149     leot     11746:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11747:        as the directory, ready to be downloaded as a whole.</p>
                   11748: <p>The <code class="filename">current</code> directory contains files
                   11749:        related to the HEAD branch of the CVS repository.
                   11750:        In this directory there is an additional file called
                   11751:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11752:        all pkgsrc <code class="filename">README</code>s with information about
                   11753:        categories and packages.
                   11754:        </p>
                   11755: <p>The <code class="filename">stable</code> directory is a symlink to
                   11756:        the latest 
                   11757:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11758:        </p>
                   11759: <p>The
                   11760:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11761:        directories contain files related to the 
                   11762:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11763:        stable branch of the CVS repository. In these directories there is
                   11764:        an additional file called
                   11765:        <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.1       dsieger  11766:        which contains the state of pkgsrc when it was branched.</p>
                   11767: </div>
                   11768: </div>
1.41      asau     11769: <div class="appendix">
                   11770: <div class="titlepage"><div><div><h1 class="title">
1.207     leot     11771: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154     rillig   11772: <p>
                   11773:        The following list contains all help topics that are available
                   11774:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11775: </p>
1.156     leot     11776: <table border="0" summary="Simple list" class="simplelist">
                   11777: <tr>
                   11778: <td>#!</td>
                   11779: <td>-lintl</td>
                   11780: </tr>
                   11781: <tr>
1.205     wiz      11782: <td>32bit</td>
1.156     leot     11783: <td>64bit</td>
1.205     wiz      11784: </tr>
                   11785: <tr>
1.156     leot     11786: <td>ABI</td>
1.205     wiz      11787: <td>ACCEPTABLE_LICENSES</td>
1.156     leot     11788: </tr>
                   11789: <tr>
                   11790: <td>ACROREAD_FONTPATH</td>
1.205     wiz      11791: <td>ADDITIONAL</td>
1.156     leot     11792: </tr>
                   11793: <tr>
                   11794: <td>AFAIK</td>
1.205     wiz      11795: <td>AIX</td>
1.156     leot     11796: </tr>
                   11797: <tr>
                   11798: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.205     wiz      11799: <td>ALL_ENV</td>
1.156     leot     11800: </tr>
                   11801: <tr>
1.227   ! wiz      11802: <td>ALSA_PC</td>
1.200     cirnatda 11803: <td>ALTERNATIVES_SRC</td>
1.227   ! wiz      11804: </tr>
        !          11805: <tr>
1.225     gutterid 11806: <td>AMANDA_TMP</td>
1.227   ! wiz      11807: <td>AMANDA_USER</td>
1.223     nia      11808: </tr>
                   11809: <tr>
1.225     gutterid 11810: <td>AMANDA_VAR</td>
1.227   ! wiz      11811: <td>APACHE_GROUP</td>
1.217     rillig   11812: </tr>
                   11813: <tr>
1.225     gutterid 11814: <td>APACHE_MODULE_NAME</td>
1.227   ! wiz      11815: <td>APACHE_MODULE_SRC</td>
1.214     leot     11816: </tr>
                   11817: <tr>
1.225     gutterid 11818: <td>APACHE_MODULE_SRCDIR</td>
1.227   ! wiz      11819: <td>APACHE_PKG_PREFIX</td>
1.212     wiz      11820: </tr>
                   11821: <tr>
1.225     gutterid 11822: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.227   ! wiz      11823: <td>APACHE_SUEXEC_DOCROOT</td>
1.197     leot     11824: </tr>
                   11825: <tr>
1.225     gutterid 11826: <td>APACHE_USER</td>
1.227   ! wiz      11827: <td>APPEND_ABI</td>
1.177     leot     11828: </tr>
                   11829: <tr>
1.225     gutterid 11830: <td>APPEND_ELF</td>
1.227   ! wiz      11831: <td>ARLA_CACHE</td>
1.161     leot     11832: </tr>
                   11833: <tr>
1.225     gutterid 11834: <td>AUDIT_PACKAGES_FLAGS</td>
1.227   ! wiz      11835: <td>AUTOCONF_REQD</td>
1.159     rillig   11836: </tr>
                   11837: <tr>
1.225     gutterid 11838: <td>AUTOMAKE_OVERRIDE</td>
1.227   ! wiz      11839: <td>AUTOMAKE_REQD</td>
1.156     leot     11840: </tr>
                   11841: <tr>
1.225     gutterid 11842: <td>AUTO_MKDIRS</td>
1.227   ! wiz      11843: <td>BDB185_DEFAULT</td>
1.156     leot     11844: </tr>
                   11845: <tr>
1.225     gutterid 11846: <td>BDBBASE</td>
1.227   ! wiz      11847: <td>BDB_ACCEPTED</td>
1.156     leot     11848: </tr>
                   11849: <tr>
1.225     gutterid 11850: <td>BDB_DEFAULT</td>
1.227   ! wiz      11851: <td>BDB_LIBS</td>
1.156     leot     11852: </tr>
                   11853: <tr>
1.225     gutterid 11854: <td>BDB_TYPE</td>
1.227   ! wiz      11855: <td>BINCIMAP_GROUP</td>
1.156     leot     11856: </tr>
                   11857: <tr>
1.225     gutterid 11858: <td>BINCIMAP_USER</td>
1.227   ! wiz      11859: <td>BIND_DIR</td>
1.156     leot     11860: </tr>
                   11861: <tr>
1.225     gutterid 11862: <td>BIND_GROUP</td>
1.227   ! wiz      11863: <td>BIND_USER</td>
1.156     leot     11864: </tr>
                   11865: <tr>
1.225     gutterid 11866: <td>BINOWN</td>
1.227   ! wiz      11867: <td>BINPKG_SITES</td>
1.156     leot     11868: </tr>
                   11869: <tr>
1.225     gutterid 11870: <td>BIN_INSTALL_FLAGS</td>
1.227   ! wiz      11871: <td>BISON_PKGDATADIR</td>
1.156     leot     11872: </tr>
                   11873: <tr>
1.225     gutterid 11874: <td>BLAS</td>
1.227   ! wiz      11875: <td>BLAS_ACCEPTED</td>
1.156     leot     11876: </tr>
                   11877: <tr>
1.225     gutterid 11878: <td>BLAS_C_INTERFACE</td>
1.227   ! wiz      11879: <td>BLAS_INCLUDES</td>
1.198     leot     11880: </tr>
                   11881: <tr>
1.225     gutterid 11882: <td>BLAS_INDEX64</td>
1.227   ! wiz      11883: <td>BLAS_LIBS</td>
1.156     leot     11884: </tr>
                   11885: <tr>
1.225     gutterid 11886: <td>BLAS_TYPE</td>
1.227   ! wiz      11887: <td>BOOTSTRAP_DEPENDS</td>
1.156     leot     11888: </tr>
                   11889: <tr>
1.225     gutterid 11890: <td>BROKEN</td>
1.227   ! wiz      11891: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.189     bacon    11892: </tr>
                   11893: <tr>
1.225     gutterid 11894: <td>BROKEN_ON_PLATFORM</td>
1.227   ! wiz      11895: <td>BSDSRCDIR</td>
1.205     wiz      11896: </tr>
                   11897: <tr>
1.225     gutterid 11898: <td>BSDXSRCDIR</td>
1.227   ! wiz      11899: <td>BSD_MAKE_ENV</td>
1.156     leot     11900: </tr>
                   11901: <tr>
1.225     gutterid 11902: <td>BUILDLINK_AUTO_DIRS</td>
1.227   ! wiz      11903: <td>BUILDLINK_AUTO_VARS</td>
1.177     leot     11904: </tr>
                   11905: <tr>
1.225     gutterid 11906: <td>BUILDLINK_CFLAGS</td>
1.227   ! wiz      11907: <td>BUILDLINK_CONTENTS_FILTER</td>
1.156     leot     11908: </tr>
                   11909: <tr>
1.214     leot     11910: <td>BUILDLINK_CPPFLAGS</td>
1.227   ! wiz      11911: <td>BUILDLINK_DEPMETHOD</td>
1.156     leot     11912: </tr>
                   11913: <tr>
                   11914: <td>BUILDLINK_FILES</td>
1.216     gutterid 11915: <td>BUILDLINK_FILES_CMD</td>
1.205     wiz      11916: </tr>
                   11917: <tr>
                   11918: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.216     gutterid 11919: <td>BUILDLINK_LDFLAGS</td>
1.156     leot     11920: </tr>
                   11921: <tr>
1.205     wiz      11922: <td>BUILDLINK_LIBS</td>
1.216     gutterid 11923: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.156     leot     11924: </tr>
                   11925: <tr>
1.205     wiz      11926: <td>BUILDLINK_PKGNAME</td>
1.216     gutterid 11927: <td>BUILDLINK_PREFIX</td>
1.156     leot     11928: </tr>
                   11929: <tr>
1.205     wiz      11930: <td>BUILDLINK_RPATHDIRS</td>
1.216     gutterid 11931: <td>BUILDLINK_TREE</td>
1.156     leot     11932: </tr>
                   11933: <tr>
1.205     wiz      11934: <td>BUILD_DEFS</td>
1.216     gutterid 11935: <td>BUILD_DEFS_EFFECTS</td>
1.156     leot     11936: </tr>
                   11937: <tr>
1.205     wiz      11938: <td>BUILD_DEPENDS</td>
1.216     gutterid 11939: <td>BUILD_DIRS</td>
1.156     leot     11940: </tr>
                   11941: <tr>
1.205     wiz      11942: <td>BUILD_ENV_SHELL</td>
1.216     gutterid 11943: <td>BUILD_MAKE_CMD</td>
1.156     leot     11944: </tr>
                   11945: <tr>
1.205     wiz      11946: <td>BUILD_MAKE_FLAGS</td>
1.216     gutterid 11947: <td>BUILD_TARGET</td>
1.156     leot     11948: </tr>
                   11949: <tr>
1.205     wiz      11950: <td>BUILTIN_FIND_FILES</td>
1.216     gutterid 11951: <td>BUILTIN_FIND_FILES_VAR</td>
1.156     leot     11952: </tr>
                   11953: <tr>
1.205     wiz      11954: <td>BUILTIN_FIND_GREP</td>
1.216     gutterid 11955: <td>BUILTIN_FIND_HEADERS</td>
1.156     leot     11956: </tr>
                   11957: <tr>
1.205     wiz      11958: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.216     gutterid 11959: <td>BUILTIN_FIND_PKGCONFIG</td>
1.156     leot     11960: </tr>
                   11961: <tr>
1.205     wiz      11962: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.216     gutterid 11963: <td>BUILTIN_PKG</td>
1.195     gutterid 11964: </tr>
                   11965: <tr>
1.205     wiz      11966: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.216     gutterid 11967: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.156     leot     11968: </tr>
                   11969: <tr>
1.205     wiz      11970: <td>BUILTIN_VERSION_SCRIPT</td>
1.216     gutterid 11971: <td>BUILTIN_X11_TYPE</td>
1.156     leot     11972: </tr>
                   11973: <tr>
1.205     wiz      11974: <td>BUILTIN_X11_VERSION</td>
1.216     gutterid 11975: <td>CACTI_GROUP</td>
1.156     leot     11976: </tr>
                   11977: <tr>
1.205     wiz      11978: <td>CACTI_USER</td>
1.216     gutterid 11979: <td>CANNA_GROUP</td>
1.156     leot     11980: </tr>
                   11981: <tr>
1.205     wiz      11982: <td>CANNA_USER</td>
1.216     gutterid 11983: <td>CAT</td>
1.156     leot     11984: </tr>
                   11985: <tr>
1.205     wiz      11986: <td>CBLAS_LIBS</td>
1.216     gutterid 11987: <td>CCACHE_BASE</td>
1.156     leot     11988: </tr>
                   11989: <tr>
1.189     bacon    11990: <td>CCACHE_DIR</td>
1.216     gutterid 11991: <td>CCACHE_LOGFILE</td>
1.156     leot     11992: </tr>
                   11993: <tr>
1.189     bacon    11994: <td>CC_VERSION</td>
1.216     gutterid 11995: <td>CC_VERSION_STRING</td>
1.156     leot     11996: </tr>
                   11997: <tr>
1.189     bacon    11998: <td>CDRECORD_CONF</td>
1.216     gutterid 11999: <td>CDROM_PKG_URL_DIR</td>
1.156     leot     12000: </tr>
                   12001: <tr>
1.189     bacon    12002: <td>CDROM_PKG_URL_HOST</td>
1.226     gutterid 12003: <td>CHANGES</td>
1.223     nia      12004: </tr>
                   12005: <tr>
1.227   ! wiz      12006: <td>CHECKOUT_DATE</td>
1.226     gutterid 12007: <td>CHECK_COMPILER</td>
1.227   ! wiz      12008: </tr>
        !          12009: <tr>
1.223     nia      12010: <td>CHECK_FAKEHOME</td>
1.227   ! wiz      12011: <td>CHECK_FILES</td>
1.217     rillig   12012: </tr>
                   12013: <tr>
1.223     nia      12014: <td>CHECK_FILES_SKIP</td>
1.227   ! wiz      12015: <td>CHECK_FILES_STRICT</td>
1.214     leot     12016: </tr>
                   12017: <tr>
1.223     nia      12018: <td>CHECK_HEADERS</td>
1.227   ! wiz      12019: <td>CHECK_HEADERS_SKIP</td>
1.212     wiz      12020: </tr>
                   12021: <tr>
1.223     nia      12022: <td>CHECK_INTERPRETER</td>
1.227   ! wiz      12023: <td>CHECK_INTERPRETER_SKIP</td>
1.205     wiz      12024: </tr>
                   12025: <tr>
1.223     nia      12026: <td>CHECK_PERMS</td>
1.227   ! wiz      12027: <td>CHECK_PERMS_AUTOFIX</td>
1.197     leot     12028: </tr>
                   12029: <tr>
1.223     nia      12030: <td>CHECK_PERMS_SKIP</td>
1.227   ! wiz      12031: <td>CHECK_PIE</td>
1.177     leot     12032: </tr>
                   12033: <tr>
1.223     nia      12034: <td>CHECK_PIE_SKIP</td>
1.227   ! wiz      12035: <td>CHECK_PIE_SUPPORTED</td>
1.161     leot     12036: </tr>
                   12037: <tr>
1.223     nia      12038: <td>CHECK_PORTABILITY</td>
1.227   ! wiz      12039: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.216     gutterid 12040: </tr>
                   12041: <tr>
1.223     nia      12042: <td>CHECK_PORTABILITY_SKIP</td>
1.227   ! wiz      12043: <td>CHECK_RELRO</td>
1.159     rillig   12044: </tr>
                   12045: <tr>
1.223     nia      12046: <td>CHECK_RELRO_SKIP</td>
1.227   ! wiz      12047: <td>CHECK_RELRO_SUPPORTED</td>
1.156     leot     12048: </tr>
                   12049: <tr>
1.223     nia      12050: <td>CHECK_SHLIBS</td>
1.227   ! wiz      12051: <td>CHECK_SHLIBS_SKIP</td>
1.156     leot     12052: </tr>
                   12053: <tr>
1.223     nia      12054: <td>CHECK_SHLIBS_SUPPORTED</td>
1.227   ! wiz      12055: <td>CHECK_SHLIBS_TOXIC</td>
1.156     leot     12056: </tr>
                   12057: <tr>
1.223     nia      12058: <td>CHECK_SSP</td>
1.227   ! wiz      12059: <td>CHECK_SSP_SKIP</td>
1.156     leot     12060: </tr>
                   12061: <tr>
1.223     nia      12062: <td>CHECK_SSP_SUPPORTED</td>
1.227   ! wiz      12063: <td>CHECK_STRIPPED</td>
1.156     leot     12064: </tr>
                   12065: <tr>
1.223     nia      12066: <td>CHECK_STRIPPED_SKIP</td>
1.227   ! wiz      12067: <td>CHECK_WRKREF</td>
1.156     leot     12068: </tr>
                   12069: <tr>
1.223     nia      12070: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.227   ! wiz      12071: <td>CHECK_WRKREF_SKIP</td>
1.156     leot     12072: </tr>
                   12073: <tr>
1.223     nia      12074: <td>CLAMAV_DBDIR</td>
1.227   ! wiz      12075: <td>CLAMAV_GROUP</td>
1.156     leot     12076: </tr>
                   12077: <tr>
1.223     nia      12078: <td>CLAMAV_USER</td>
1.227   ! wiz      12079: <td>CLANGBASE</td>
1.156     leot     12080: </tr>
                   12081: <tr>
1.223     nia      12082: <td>CLEANDEPENDS</td>
1.227   ! wiz      12083: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156     leot     12084: </tr>
                   12085: <tr>
1.223     nia      12086: <td>CMAKE_INSTALL_NAME_DIR</td>
1.227   ! wiz      12087: <td>CMAKE_INSTALL_PREFIX</td>
1.156     leot     12088: </tr>
                   12089: <tr>
1.223     nia      12090: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.227   ! wiz      12091: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156     leot     12092: </tr>
                   12093: <tr>
1.223     nia      12094: <td>CMAKE_PREFIX_PATH</td>
1.227   ! wiz      12095: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
        !          12096: </tr>
        !          12097: <tr>
        !          12098: <td>COMMON_LISP_DOCFILES</td>
        !          12099: <td>COMMON_LISP_EXAMPLES</td>
        !          12100: </tr>
        !          12101: <tr>
        !          12102: <td>COMMON_LISP_EXTRAFILES</td>
        !          12103: <td>COMMON_LISP_PACKAGES</td>
1.177     leot     12104: </tr>
                   12105: <tr>
1.227   ! wiz      12106: <td>COMMON_LISP_SYSTEM</td>
1.191     bacon    12107: <td>COMPILER_RPATH_FLAG</td>
1.156     leot     12108: </tr>
                   12109: <tr>
1.226     gutterid 12110: <td>COMPILER_USE_SYMLINKS</td>
1.191     bacon    12111: <td>CONFIGURE_ARGS</td>
1.156     leot     12112: </tr>
                   12113: <tr>
1.226     gutterid 12114: <td>CONFIGURE_DIRS</td>
1.191     bacon    12115: <td>CONFIGURE_ENV</td>
1.156     leot     12116: </tr>
                   12117: <tr>
1.226     gutterid 12118: <td>CONFIGURE_ENV_SHELL</td>
1.191     bacon    12119: <td>CONFIGURE_HAS_INFODIR</td>
1.156     leot     12120: </tr>
                   12121: <tr>
1.226     gutterid 12122: <td>CONFIGURE_HAS_MANDIR</td>
1.191     bacon    12123: <td>CONFIGURE_SCRIPT</td>
1.156     leot     12124: </tr>
                   12125: <tr>
1.226     gutterid 12126: <td>CONFIG_SHELL</td>
1.191     bacon    12127: <td>CONFIG_SHELL_FLAGS</td>
1.156     leot     12128: </tr>
                   12129: <tr>
1.226     gutterid 12130: <td>CONF_FILES</td>
1.191     bacon    12131: <td>CONF_FILES_MODE</td>
1.156     leot     12132: </tr>
                   12133: <tr>
1.226     gutterid 12134: <td>CONF_FILES_PERMS</td>
1.191     bacon    12135: <td>CONSERVER_DEFAULTHOST</td>
1.156     leot     12136: </tr>
                   12137: <tr>
1.226     gutterid 12138: <td>CONSERVER_DEFAULTPORT</td>
1.191     bacon    12139: <td>CP</td>
1.156     leot     12140: </tr>
                   12141: <tr>
1.226     gutterid 12142: <td>CPP</td>
1.191     bacon    12143: <td>CPP_PRECOMP_FLAGS</td>
1.156     leot     12144: </tr>
                   12145: <tr>
1.226     gutterid 12146: <td>CREATE_WRKDIR_SYMLINK</td>
1.191     bacon    12147: <td>CROSSBASE</td>
1.156     leot     12148: </tr>
                   12149: <tr>
1.226     gutterid 12150: <td>CTFCONVERT</td>
1.191     bacon    12151: <td>CTF_FILES_SKIP</td>
1.156     leot     12152: </tr>
                   12153: <tr>
1.226     gutterid 12154: <td>CTF_SUPPORTED</td>
1.191     bacon    12155: <td>CTYPE</td>
1.156     leot     12156: </tr>
                   12157: <tr>
1.226     gutterid 12158: <td>CUPS_GROUP</td>
1.191     bacon    12159: <td>CUPS_SYSTEM_GROUPS</td>
1.156     leot     12160: </tr>
                   12161: <tr>
1.226     gutterid 12162: <td>CUPS_USER</td>
1.191     bacon    12163: <td>CURSES_DEFAULT</td>
1.177     leot     12164: </tr>
                   12165: <tr>
1.226     gutterid 12166: <td>CURSES_TYPE</td>
1.227   ! wiz      12167: <td>CVS_EXTRACTDIR</td>
        !          12168: </tr>
        !          12169: <tr>
        !          12170: <td>CVS_MODULE</td>
        !          12171: <td>CVS_PROJECT</td>
        !          12172: </tr>
        !          12173: <tr>
        !          12174: <td>CVS_REPOSITORIES</td>
        !          12175: <td>CVS_ROOT</td>
        !          12176: </tr>
        !          12177: <tr>
        !          12178: <td>CVS_ROOT_GNU</td>
        !          12179: <td>CVS_ROOT_NONGNU</td>
        !          12180: </tr>
        !          12181: <tr>
        !          12182: <td>CVS_ROOT_SOURCEFORGE</td>
        !          12183: <td>CVS_TAG</td>
        !          12184: </tr>
        !          12185: <tr>
1.160     brook    12186: <td>CXX</td>
1.227   ! wiz      12187: <td>CYRUS_GROUP</td>
1.217     rillig   12188: </tr>
                   12189: <tr>
                   12190: <td>CYRUS_IDLE</td>
1.227   ! wiz      12191: <td>CYRUS_USER</td>
1.214     leot     12192: </tr>
                   12193: <tr>
1.217     rillig   12194: <td>DAEMONTOOLS_GROUP</td>
1.227   ! wiz      12195: <td>DAEMONTOOLS_LOG_USER</td>
1.212     wiz      12196: </tr>
                   12197: <tr>
1.217     rillig   12198: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.227   ! wiz      12199: <td>DARWIN_REQUIRES_FILTER</td>
1.205     wiz      12200: </tr>
                   12201: <tr>
1.217     rillig   12202: <td>DBUS_GROUP</td>
1.227   ! wiz      12203: <td>DBUS_USER</td>
1.197     leot     12204: </tr>
                   12205: <tr>
1.217     rillig   12206: <td>DEFANG_GROUP</td>
1.227   ! wiz      12207: <td>DEFANG_USER</td>
1.159     rillig   12208: </tr>
                   12209: <tr>
1.217     rillig   12210: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.227   ! wiz      12211: <td>DEFAULT_DISTFILES</td>
1.156     leot     12212: </tr>
                   12213: <tr>
1.217     rillig   12214: <td>DEFAULT_IRC_SERVER</td>
1.227   ! wiz      12215: <td>DEFAULT_SERIAL_DEVICE</td>
1.156     leot     12216: </tr>
                   12217: <tr>
1.217     rillig   12218: <td>DEF_UMASK</td>
1.227   ! wiz      12219: <td>DEINSTALLDEPENDS</td>
1.195     gutterid 12220: </tr>
                   12221: <tr>
1.217     rillig   12222: <td>DEINSTALL_SRC</td>
1.227   ! wiz      12223: <td>DEINSTALL_TEMPLATES</td>
1.156     leot     12224: </tr>
                   12225: <tr>
1.217     rillig   12226: <td>DELAYED_ERROR_MSG</td>
1.227   ! wiz      12227: <td>DELAYED_WARNING_MSG</td>
1.156     leot     12228: </tr>
                   12229: <tr>
1.217     rillig   12230: <td>DEPENDS</td>
1.227   ! wiz      12231: <td>DEPENDS_TARGET</td>
1.156     leot     12232: </tr>
                   12233: <tr>
1.217     rillig   12234: <td>DEPENDS_TYPE</td>
1.227   ! wiz      12235: <td>DESTDIR</td>
1.156     leot     12236: </tr>
                   12237: <tr>
1.217     rillig   12238: <td>DESTDIR_VARNAME</td>
1.227   ! wiz      12239: <td>DIALER_GROUP</td>
1.156     leot     12240: </tr>
                   12241: <tr>
1.217     rillig   12242: <td>DIGEST_REQD</td>
1.227   ! wiz      12243: <td>DISTDIR</td>
1.156     leot     12244: </tr>
                   12245: <tr>
1.217     rillig   12246: <td>DISTFILES</td>
1.227   ! wiz      12247: <td>DISTINFO_FILE</td>
1.156     leot     12248: </tr>
                   12249: <tr>
1.217     rillig   12250: <td>DISTNAME</td>
1.227   ! wiz      12251: <td>DIST_PATH</td>
1.156     leot     12252: </tr>
                   12253: <tr>
1.217     rillig   12254: <td>DIST_SUBDIR</td>
1.227   ! wiz      12255: <td>DJBDNS_AXFR_USER</td>
1.156     leot     12256: </tr>
                   12257: <tr>
1.217     rillig   12258: <td>DJBDNS_CACHE_USER</td>
1.227   ! wiz      12259: <td>DJBDNS_DJBDNS_GROUP</td>
1.156     leot     12260: </tr>
                   12261: <tr>
1.217     rillig   12262: <td>DJBDNS_LOG_USER</td>
1.227   ! wiz      12263: <td>DJBDNS_RBL_USER</td>
1.156     leot     12264: </tr>
                   12265: <tr>
1.217     rillig   12266: <td>DJBDNS_TINY_USER</td>
1.227   ! wiz      12267: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156     leot     12268: </tr>
                   12269: <tr>
1.217     rillig   12270: <td>DL_AUTO_VARS</td>
1.227   ! wiz      12271: <td>DL_CFLAGS</td>
1.156     leot     12272: </tr>
                   12273: <tr>
1.217     rillig   12274: <td>DL_LDFLAGS</td>
1.227   ! wiz      12275: <td>DL_LIBS</td>
1.156     leot     12276: </tr>
                   12277: <tr>
1.217     rillig   12278: <td>DNS</td>
1.227   ! wiz      12279: <td>DOCOWN</td>
1.156     leot     12280: </tr>
                   12281: <tr>
1.217     rillig   12282: <td>DOWNLOADED_DISTFILE</td>
1.227   ! wiz      12283: <td>DQCACHE_GROUP</td>
1.156     leot     12284: </tr>
                   12285: <tr>
1.218     nia      12286: <td>DQCACHE_USER</td>
1.227   ! wiz      12287: <td>DT_LAYOUT</td>
1.218     nia      12288: </tr>
                   12289: <tr>
1.217     rillig   12290: <td>DYNAMIC_SITES_CMD</td>
1.227   ! wiz      12291: <td>DYNAMIC_SITES_SCRIPT</td>
1.156     leot     12292: </tr>
                   12293: <tr>
1.217     rillig   12294: <td>ECHO</td>
1.227   ! wiz      12295: <td>ECHO_N</td>
1.156     leot     12296: </tr>
                   12297: <tr>
1.217     rillig   12298: <td>ELK_GUI</td>
1.227   ! wiz      12299: <td>EMACS_TYPE</td>
1.156     leot     12300: </tr>
                   12301: <tr>
1.217     rillig   12302: <td>EMULDIR</td>
1.227   ! wiz      12303: <td>EMULSUBDIR</td>
1.156     leot     12304: </tr>
                   12305: <tr>
1.217     rillig   12306: <td>EMULSUBDIRSLASH</td>
1.227   ! wiz      12307: <td>EMUL_ARCH</td>
1.156     leot     12308: </tr>
                   12309: <tr>
1.217     rillig   12310: <td>EMUL_DISTRO</td>
1.227   ! wiz      12311: <td>EMUL_EXEC_FMT</td>
1.156     leot     12312: </tr>
                   12313: <tr>
1.217     rillig   12314: <td>EMUL_IS_NATIVE</td>
1.227   ! wiz      12315: <td>EMUL_MODULES</td>
1.156     leot     12316: </tr>
                   12317: <tr>
1.217     rillig   12318: <td>EMUL_OPSYS</td>
1.227   ! wiz      12319: <td>EMUL_PKG_FMT</td>
1.156     leot     12320: </tr>
                   12321: <tr>
1.217     rillig   12322: <td>EMUL_PLATFORM</td>
1.227   ! wiz      12323: <td>EMUL_PLATFORMS</td>
1.156     leot     12324: </tr>
                   12325: <tr>
1.217     rillig   12326: <td>EMUL_PREFER</td>
1.227   ! wiz      12327: <td>EMUL_REQD</td>
1.156     leot     12328: </tr>
                   12329: <tr>
1.217     rillig   12330: <td>EMUL_TYPE</td>
1.227   ! wiz      12331: <td>ERROR_MSG</td>
1.156     leot     12332: </tr>
                   12333: <tr>
1.217     rillig   12334: <td>EXIM_GROUP</td>
1.227   ! wiz      12335: <td>EXIM_USER</td>
1.156     leot     12336: </tr>
                   12337: <tr>
1.217     rillig   12338: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.227   ! wiz      12339: <td>EXTRACTOR</td>
1.156     leot     12340: </tr>
                   12341: <tr>
1.217     rillig   12342: <td>EXTRACT_CMD</td>
1.227   ! wiz      12343: <td>EXTRACT_CMD_DEFAULT</td>
1.223     nia      12344: </tr>
                   12345: <tr>
                   12346: <td>EXTRACT_DIR</td>
1.227   ! wiz      12347: <td>EXTRACT_ELEMENTS</td>
1.156     leot     12348: </tr>
                   12349: <tr>
1.223     nia      12350: <td>EXTRACT_ENV</td>
1.227   ! wiz      12351: <td>EXTRACT_ONLY</td>
1.156     leot     12352: </tr>
                   12353: <tr>
1.223     nia      12354: <td>EXTRACT_OPTS</td>
1.227   ! wiz      12355: <td>EXTRACT_SUFX</td>
1.156     leot     12356: </tr>
                   12357: <tr>
1.223     nia      12358: <td>EXTRACT_USING</td>
1.227   ! wiz      12359: <td>FAIL</td>
1.156     leot     12360: </tr>
                   12361: <tr>
1.223     nia      12362: <td>FAILOVER_FETCH</td>
1.227   ! wiz      12363: <td>FAIL_MSG</td>
1.156     leot     12364: </tr>
                   12365: <tr>
1.223     nia      12366: <td>FAKE_NCURSES</td>
1.227   ! wiz      12367: <td>FAM</td>
1.156     leot     12368: </tr>
                   12369: <tr>
1.223     nia      12370: <td>FAM_ACCEPTED</td>
1.227   ! wiz      12371: <td>FAM_DEFAULT</td>
1.156     leot     12372: </tr>
                   12373: <tr>
1.223     nia      12374: <td>FAM_SERVER</td>
1.227   ! wiz      12375: <td>FCPATH</td>
1.156     leot     12376: </tr>
                   12377: <tr>
1.223     nia      12378: <td>FEATURE_CPPFLAGS</td>
1.227   ! wiz      12379: <td>FEATURE_LDFLAGS</td>
1.156     leot     12380: </tr>
                   12381: <tr>
1.223     nia      12382: <td>FEATURE_LIBS</td>
1.227   ! wiz      12383: <td>FETCH_AFTER_ARGS</td>
1.177     leot     12384: </tr>
                   12385: <tr>
1.223     nia      12386: <td>FETCH_BEFORE_ARGS</td>
1.227   ! wiz      12387: <td>FETCH_CMD</td>
1.156     leot     12388: </tr>
                   12389: <tr>
1.223     nia      12390: <td>FETCH_OUTPUT_ARGS</td>
1.227   ! wiz      12391: <td>FETCH_PROXY</td>
1.156     leot     12392: </tr>
                   12393: <tr>
1.223     nia      12394: <td>FETCH_RESUME_ARGS</td>
1.227   ! wiz      12395: <td>FETCH_TIMEOUT</td>
1.156     leot     12396: </tr>
                   12397: <tr>
1.223     nia      12398: <td>FETCH_USE_IPV4_ONLY</td>
1.227   ! wiz      12399: <td>FETCH_USING</td>
1.156     leot     12400: </tr>
                   12401: <tr>
1.223     nia      12402: <td>FILES_SUBST</td>
1.227   ! wiz      12403: <td>FILES_SUBST_SED</td>
1.156     leot     12404: </tr>
                   12405: <tr>
1.223     nia      12406: <td>FIX_SYSTEM_HEADERS</td>
1.227   ! wiz      12407: <td>FONTDIR</td>
1.161     leot     12408: </tr>
                   12409: <tr>
1.226     gutterid 12410: <td>FONTS_DIRS</td>
1.191     bacon    12411: <td>FONTS_VERBOSE</td>
1.177     leot     12412: </tr>
                   12413: <tr>
1.226     gutterid 12414: <td>FOO_HACKS_MK</td>
1.227   ! wiz      12415: <td>FOSSIL_EXTRACTDIR</td>
        !          12416: </tr>
        !          12417: <tr>
        !          12418: <td>FOSSIL_REPO</td>
        !          12419: <td>FOSSIL_REPOSITORIES</td>
        !          12420: </tr>
        !          12421: <tr>
        !          12422: <td>FOSSIL_VERSION</td>
1.191     bacon    12423: <td>FOX_USE_XUNICODE</td>
1.156     leot     12424: </tr>
                   12425: <tr>
1.226     gutterid 12426: <td>FREEWNN_GROUP</td>
1.191     bacon    12427: <td>FREEWNN_USER</td>
1.156     leot     12428: </tr>
                   12429: <tr>
1.226     gutterid 12430: <td>FTP_PKG_URL_DIR</td>
1.191     bacon    12431: <td>FTP_PKG_URL_HOST</td>
1.156     leot     12432: </tr>
                   12433: <tr>
1.226     gutterid 12434: <td>GAMEDATAMODE</td>
1.191     bacon    12435: <td>GAMEDATA_PERMS</td>
1.156     leot     12436: </tr>
                   12437: <tr>
1.226     gutterid 12438: <td>GAMEDIRMODE</td>
1.191     bacon    12439: <td>GAMEDIR_PERMS</td>
1.156     leot     12440: </tr>
                   12441: <tr>
1.226     gutterid 12442: <td>GAMEGRP</td>
1.191     bacon    12443: <td>GAMEMODE</td>
1.156     leot     12444: </tr>
                   12445: <tr>
1.226     gutterid 12446: <td>GAMEOWN</td>
1.191     bacon    12447: <td>GAMES_GROUP</td>
1.156     leot     12448: </tr>
                   12449: <tr>
1.226     gutterid 12450: <td>GAMES_USER</td>
1.191     bacon    12451: <td>GCC</td>
1.156     leot     12452: </tr>
                   12453: <tr>
1.226     gutterid 12454: <td>GCCBASE</td>
1.191     bacon    12455: <td>GCC_REQD</td>
1.156     leot     12456: </tr>
                   12457: <tr>
1.226     gutterid 12458: <td>GCC_VERSION_SUFFIX</td>
1.191     bacon    12459: <td>GEM_BUILD</td>
1.156     leot     12460: </tr>
                   12461: <tr>
1.226     gutterid 12462: <td>GEM_CLEANBUILD</td>
1.191     bacon    12463: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156     leot     12464: </tr>
                   12465: <tr>
1.226     gutterid 12466: <td>GEM_DOCDIR</td>
1.191     bacon    12467: <td>GEM_EXTSDIR</td>
1.177     leot     12468: </tr>
                   12469: <tr>
1.226     gutterid 12470: <td>GEM_HOME</td>
1.191     bacon    12471: <td>GEM_KEEPBUILD</td>
1.156     leot     12472: </tr>
                   12473: <tr>
1.226     gutterid 12474: <td>GEM_LIBDIR</td>
1.191     bacon    12475: <td>GEM_NAME</td>
1.156     leot     12476: </tr>
                   12477: <tr>
1.226     gutterid 12478: <td>GEM_PATH</td>
1.198     leot     12479: <td>GEM_PLUGINSDIR</td>
                   12480: </tr>
                   12481: <tr>
1.226     gutterid 12482: <td>GEM_SPECFILE</td>
1.180     rillig   12483: <td>GENERATE_PLIST</td>
1.156     leot     12484: </tr>
                   12485: <tr>
1.226     gutterid 12486: <td>GHC</td>
1.201     cirnatda 12487: <td>GHOSTSCRIPT_REQD</td>
1.156     leot     12488: </tr>
                   12489: <tr>
1.226     gutterid 12490: <td>GITHUB_PROJECT</td>
1.201     cirnatda 12491: <td>GITHUB_RELEASE</td>
1.177     leot     12492: </tr>
                   12493: <tr>
1.226     gutterid 12494: <td>GITHUB_SUBMODULES</td>
1.201     cirnatda 12495: <td>GITHUB_TAG</td>
1.159     rillig   12496: </tr>
                   12497: <tr>
1.226     gutterid 12498: <td>GITHUB_TYPE</td>
1.223     nia      12499: <td>GITLAB_PROJECT</td>
                   12500: </tr>
                   12501: <tr>
1.226     gutterid 12502: <td>GITLAB_RELEASE</td>
1.225     gutterid 12503: <td>GITLAB_SUBMODULES</td>
1.223     nia      12504: </tr>
                   12505: <tr>
1.226     gutterid 12506: <td>GITLAB_TAG</td>
1.225     gutterid 12507: <td>GITLAB_TYPE</td>
1.223     nia      12508: </tr>
                   12509: <tr>
1.227   ! wiz      12510: <td>GIT_BRANCH</td>
        !          12511: <td>GIT_ENV</td>
        !          12512: </tr>
        !          12513: <tr>
        !          12514: <td>GIT_EXTRACTDIR</td>
        !          12515: <td>GIT_REPO</td>
        !          12516: </tr>
        !          12517: <tr>
        !          12518: <td>GIT_REPOSITORIES</td>
        !          12519: <td>GIT_REVISION</td>
        !          12520: </tr>
        !          12521: <tr>
        !          12522: <td>GIT_TAG</td>
1.226     gutterid 12523: <td>GNU</td>
1.227   ! wiz      12524: </tr>
        !          12525: <tr>
1.191     bacon    12526: <td>GNU_CONFIGURE</td>
1.227   ! wiz      12527: <td>GNU_CONFIGURE_INFODIR</td>
1.156     leot     12528: </tr>
                   12529: <tr>
1.191     bacon    12530: <td>GNU_CONFIGURE_MANDIR</td>
1.227   ! wiz      12531: <td>GNU_CONFIGURE_QUIET</td>
1.156     leot     12532: </tr>
                   12533: <tr>
1.191     bacon    12534: <td>GNU_CONFIGURE_STRICT</td>
1.227   ! wiz      12535: <td>GODEP_REDIRECTS</td>
1.156     leot     12536: </tr>
                   12537: <tr>
1.191     bacon    12538: <td>GO_BUILD_PATTERN</td>
1.227   ! wiz      12539: <td>GO_DEPS</td>
1.156     leot     12540: </tr>
                   12541: <tr>
1.191     bacon    12542: <td>GO_DIST_BASE</td>
1.227   ! wiz      12543: <td>GO_EXTRA_MOD_DIRS</td>
1.156     leot     12544: </tr>
                   12545: <tr>
1.201     cirnatda 12546: <td>GO_MODULE_FILES</td>
1.227   ! wiz      12547: <td>GO_SRCPATH</td>
1.156     leot     12548: </tr>
                   12549: <tr>
1.201     cirnatda 12550: <td>GO_VERSION_DEFAULT</td>
1.227   ! wiz      12551: <td>GROUP_SPECIFIC_PKGS</td>
1.156     leot     12552: </tr>
                   12553: <tr>
1.201     cirnatda 12554: <td>GRUB_NETWORK_CARDS</td>
1.227   ! wiz      12555: <td>GRUB_PRESET_COMMAND</td>
1.156     leot     12556: </tr>
                   12557: <tr>
1.201     cirnatda 12558: <td>GRUB_SCAN_ARGS</td>
1.227   ! wiz      12559: <td>GZIP</td>
1.223     nia      12560: </tr>
                   12561: <tr>
1.227   ! wiz      12562: <td>HASKELL_COMPILER</td>
1.222     gutterid 12563: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.217     rillig   12564: </tr>
                   12565: <tr>
1.226     gutterid 12566: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.222     gutterid 12567: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.226     gutterid 12568: </tr>
                   12569: <tr>
1.223     nia      12570: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.226     gutterid 12571: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.220     nia      12572: </tr>
                   12573: <tr>
1.223     nia      12574: <td>HAS_CONFIGURE</td>
1.226     gutterid 12575: <td>HEADER_TEMPLATES</td>
1.214     leot     12576: </tr>
                   12577: <tr>
1.227   ! wiz      12578: <td>HG_REPO</td>
        !          12579: <td>HG_REPOSITORIES</td>
        !          12580: </tr>
        !          12581: <tr>
        !          12582: <td>HG_TAG</td>
1.225     gutterid 12583: <td>HOMEPAGE</td>
1.227   ! wiz      12584: </tr>
        !          12585: <tr>
1.226     gutterid 12586: <td>HOST_PKGTOOLS_ARGS</td>
1.227   ! wiz      12587: <td>HOST_SPECIFIC_PKGS</td>
1.223     nia      12588: </tr>
                   12589: <tr>
1.226     gutterid 12590: <td>HOWL_GROUP</td>
1.227   ! wiz      12591: <td>HOWL_USER</td>
1.156     leot     12592: </tr>
                   12593: <tr>
1.226     gutterid 12594: <td>ICCBASE</td>
1.227   ! wiz      12595: <td>ICECAST_CHROOTDIR</td>
1.156     leot     12596: </tr>
                   12597: <tr>
1.226     gutterid 12598: <td>ICON_THEMES</td>
1.227   ! wiz      12599: <td>IDOBASE</td>
1.191     bacon    12600: </tr>
                   12601: <tr>
1.226     gutterid 12602: <td>IGNORE_CCACHE</td>
1.227   ! wiz      12603: <td>IGNORE_INFO_DIRS</td>
1.156     leot     12604: </tr>
                   12605: <tr>
1.226     gutterid 12606: <td>IGNORE_INTERACTIVE_FETCH</td>
1.227   ! wiz      12607: <td>IMAKE</td>
1.156     leot     12608: </tr>
                   12609: <tr>
1.226     gutterid 12610: <td>IMAKEOPTS</td>
1.227   ! wiz      12611: <td>IMAKE_MAKE</td>
1.156     leot     12612: </tr>
                   12613: <tr>
1.226     gutterid 12614: <td>IMAKE_MANINSTALL</td>
1.227   ! wiz      12615: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156     leot     12616: </tr>
                   12617: <tr>
1.226     gutterid 12618: <td>IMDICTDIR</td>
1.227   ! wiz      12619: <td>INCOMPAT_CURSES</td>
1.156     leot     12620: </tr>
                   12621: <tr>
1.226     gutterid 12622: <td>INFO_DIR</td>
1.227   ! wiz      12623: <td>INFO_FILES</td>
1.156     leot     12624: </tr>
                   12625: <tr>
1.226     gutterid 12626: <td>INFO_FILES_VERBOSE</td>
1.227   ! wiz      12627: <td>INFO_MSG</td>
1.156     leot     12628: </tr>
                   12629: <tr>
1.226     gutterid 12630: <td>INIT_SYSTEM</td>
1.227   ! wiz      12631: <td>INN_DATA_DIR</td>
1.156     leot     12632: </tr>
                   12633: <tr>
1.226     gutterid 12634: <td>INN_GROUP</td>
1.227   ! wiz      12635: <td>INN_USER</td>
1.156     leot     12636: </tr>
                   12637: <tr>
1.226     gutterid 12638: <td>INSTALLATION_DIRS</td>
1.227   ! wiz      12639: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.172     rillig   12640: </tr>
                   12641: <tr>
1.226     gutterid 12642: <td>INSTALL_ENV</td>
1.227   ! wiz      12643: <td>INSTALL_SH_OVERRIDE</td>
1.156     leot     12644: </tr>
                   12645: <tr>
1.226     gutterid 12646: <td>INSTALL_SRC</td>
1.227   ! wiz      12647: <td>INSTALL_TEMPLATES</td>
1.156     leot     12648: </tr>
                   12649: <tr>
1.226     gutterid 12650: <td>INSTALL_UNSTRIPPED</td>
1.227   ! wiz      12651: <td>IRCD_HYBRID_IRC_GROUP</td>
1.156     leot     12652: </tr>
                   12653: <tr>
1.226     gutterid 12654: <td>IRCD_HYBRID_IRC_USER</td>
1.227   ! wiz      12655: <td>IRCD_HYBRID_MAXCONN</td>
1.156     leot     12656: </tr>
                   12657: <tr>
1.226     gutterid 12658: <td>IRCD_HYBRID_NICLEN</td>
1.227   ! wiz      12659: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.156     leot     12660: </tr>
                   12661: <tr>
1.226     gutterid 12662: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.227   ! wiz      12663: <td>IRCD_HYBRID_TOPICLEN</td>
1.156     leot     12664: </tr>
                   12665: <tr>
1.226     gutterid 12666: <td>IRIX</td>
1.227   ! wiz      12667: <td>IRRD_USE_PGP</td>
1.156     leot     12668: </tr>
                   12669: <tr>
1.226     gutterid 12670: <td>JABBERD_GROUP</td>
1.227   ! wiz      12671: <td>JABBERD_LOGDIR</td>
1.156     leot     12672: </tr>
                   12673: <tr>
1.226     gutterid 12674: <td>JABBERD_PIDDIR</td>
1.227   ! wiz      12675: <td>JABBERD_SPOOLDIR</td>
1.156     leot     12676: </tr>
                   12677: <tr>
1.226     gutterid 12678: <td>JABBERD_USER</td>
1.227   ! wiz      12679: <td>JAVA_APP_PATH</td>
1.156     leot     12680: </tr>
                   12681: <tr>
1.227   ! wiz      12682: <td>JAVA_APP_TARGETS</td>
1.225     gutterid 12683: <td>JAVA_BINPREFIX</td>
1.227   ! wiz      12684: </tr>
        !          12685: <tr>
1.226     gutterid 12686: <td>JAVA_CLASSPATH</td>
1.227   ! wiz      12687: <td>JAVA_HOME</td>
1.177     leot     12688: </tr>
                   12689: <tr>
1.226     gutterid 12690: <td>JAVA_LD_LIBRARY_PATH</td>
1.227   ! wiz      12691: <td>JAVA_NAME</td>
1.156     leot     12692: </tr>
                   12693: <tr>
1.226     gutterid 12694: <td>JAVA_UNLIMIT</td>
1.227   ! wiz      12695: <td>JAVA_WRAPPERS</td>
1.217     rillig   12696: </tr>
                   12697: <tr>
1.226     gutterid 12698: <td>JPEG_ACCEPTED</td>
1.227   ! wiz      12699: <td>JPEG_DEFAULT</td>
1.217     rillig   12700: </tr>
                   12701: <tr>
1.226     gutterid 12702: <td>KERBEROS</td>
1.227   ! wiz      12703: <td>KERMIT_SUID_UUCP</td>
1.156     leot     12704: </tr>
                   12705: <tr>
1.226     gutterid 12706: <td>KJS_USE_PCRE</td>
1.227   ! wiz      12707: <td>KNEWS_DOMAIN_FILE</td>
1.156     leot     12708: </tr>
                   12709: <tr>
1.226     gutterid 12710: <td>KNEWS_DOMAIN_NAME</td>
1.227   ! wiz      12711: <td>KRB5_ACCEPTED</td>
1.156     leot     12712: </tr>
                   12713: <tr>
1.226     gutterid 12714: <td>KRB5_DEFAULT</td>
1.227   ! wiz      12715: <td>LANGUAGES</td>
1.156     leot     12716: </tr>
                   12717: <tr>
1.226     gutterid 12718: <td>LAPACKE_LIBS</td>
1.227   ! wiz      12719: <td>LAPACK_LIBS</td>
1.156     leot     12720: </tr>
                   12721: <tr>
1.226     gutterid 12722: <td>LATEX2HTML_ICONPATH</td>
1.227   ! wiz      12723: <td>LDCONFIG_ADD_CMD</td>
1.177     leot     12724: </tr>
                   12725: <tr>
1.226     gutterid 12726: <td>LDCONFIG_REMOVE_CMD</td>
1.227   ! wiz      12727: <td>LDD</td>
1.156     leot     12728: </tr>
                   12729: <tr>
1.226     gutterid 12730: <td>LEAFNODE_DATA_DIR</td>
1.227   ! wiz      12731: <td>LEAFNODE_GROUP</td>
1.156     leot     12732: </tr>
                   12733: <tr>
1.226     gutterid 12734: <td>LEAFNODE_USER</td>
1.227   ! wiz      12735: <td>LIBDVDCSS_HOMEPAGE</td>
1.156     leot     12736: </tr>
                   12737: <tr>
1.226     gutterid 12738: <td>LIBDVDCSS_MASTER_SITES</td>
1.227   ! wiz      12739: <td>LIBRSVG_TYPE</td>
1.156     leot     12740: </tr>
                   12741: <tr>
1.226     gutterid 12742: <td>LIBTOOL</td>
1.227   ! wiz      12743: <td>LIBTOOLIZE_PLIST</td>
1.205     wiz      12744: </tr>
                   12745: <tr>
1.226     gutterid 12746: <td>LIBTOOL_M4_OVERRIDE</td>
1.227   ! wiz      12747: <td>LIBUSB_TYPE</td>
1.157     leot     12748: </tr>
                   12749: <tr>
1.226     gutterid 12750: <td>LICENSE</td>
1.227   ! wiz      12751: <td>LINKER_RPATH_FLAG</td>
1.212     wiz      12752: </tr>
                   12753: <tr>
1.226     gutterid 12754: <td>LINK_RPATH_FLAG</td>
1.227   ! wiz      12755: <td>LINUX_BASE_NODEPS</td>
        !          12756: </tr>
        !          12757: <tr>
        !          12758: <td>LINUX_BASE_PREFERRED</td>
        !          12759: <td>LINUX_BASE_REQUIRED</td>
1.156     leot     12760: </tr>
                   12761: <tr>
1.220     nia      12762: <td>LINUX_LOCALES</td>
1.226     gutterid 12763: <td>LOCALBASE</td>
1.223     nia      12764: </tr>
                   12765: <tr>
                   12766: <td>LOCALBASE_LOCKTYPE</td>
1.226     gutterid 12767: <td>LOCALPATCHES</td>
1.177     leot     12768: </tr>
                   12769: <tr>
1.223     nia      12770: <td>LOVE_DATA</td>
1.226     gutterid 12771: <td>LOVE_GAME</td>
1.214     leot     12772: </tr>
                   12773: <tr>
1.223     nia      12774: <td>LOVE_VERSION</td>
1.226     gutterid 12775: <td>LP32PLATFORMS</td>
1.197     leot     12776: </tr>
                   12777: <tr>
1.223     nia      12778: <td>LP64PLATFORMS</td>
1.226     gutterid 12779: <td>LUA_BUSTED_ARGS</td>
1.156     leot     12780: </tr>
                   12781: <tr>
1.223     nia      12782: <td>LUA_CDIR</td>
1.226     gutterid 12783: <td>LUA_COMPILER</td>
1.156     leot     12784: </tr>
                   12785: <tr>
1.223     nia      12786: <td>LUA_DOCDIR</td>
1.226     gutterid 12787: <td>LUA_EXAMPLESDIR</td>
1.221     nia      12788: </tr>
                   12789: <tr>
1.223     nia      12790: <td>LUA_INCDIR</td>
1.226     gutterid 12791: <td>LUA_INTERPRETER</td>
1.218     nia      12792: </tr>
                   12793: <tr>
1.223     nia      12794: <td>LUA_LDIR</td>
1.226     gutterid 12795: <td>LUA_LINKER_MAGIC</td>
1.218     nia      12796: </tr>
                   12797: <tr>
1.223     nia      12798: <td>LUA_PKGPREFIX</td>
1.226     gutterid 12799: <td>LUA_SELF_CONFLICT</td>
1.218     nia      12800: </tr>
                   12801: <tr>
1.223     nia      12802: <td>LUA_USE_BUSTED</td>
1.226     gutterid 12803: <td>LUA_VERSIONS_ACCEPTED</td>
1.218     nia      12804: </tr>
                   12805: <tr>
1.223     nia      12806: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.226     gutterid 12807: <td>LUA_VERSION_DEFAULT</td>
1.218     nia      12808: </tr>
                   12809: <tr>
1.223     nia      12810: <td>LUA_VERSION_REQD</td>
1.226     gutterid 12811: <td>Lua</td>
1.218     nia      12812: </tr>
                   12813: <tr>
1.223     nia      12814: <td>MACHINE_PLATFORM</td>
1.226     gutterid 12815: <td>MAILAGENT_DOMAIN</td>
1.218     nia      12816: </tr>
                   12817: <tr>
1.223     nia      12818: <td>MAILAGENT_EMAIL</td>
1.226     gutterid 12819: <td>MAILAGENT_FQDN</td>
1.156     leot     12820: </tr>
                   12821: <tr>
1.223     nia      12822: <td>MAILAGENT_ORGANIZATION</td>
1.226     gutterid 12823: <td>MAJORDOMO_HOMEDIR</td>
1.205     wiz      12824: </tr>
                   12825: <tr>
1.227   ! wiz      12826: <td>MAJOR_OS_VERSION</td>
1.225     gutterid 12827: <td>MAKEINFO_ARGS</td>
1.227   ! wiz      12828: </tr>
        !          12829: <tr>
1.226     gutterid 12830: <td>MAKE_DIRS</td>
1.227   ! wiz      12831: <td>MAKE_DIRS_PERMS</td>
1.156     leot     12832: </tr>
                   12833: <tr>
1.226     gutterid 12834: <td>MAKE_ENV</td>
1.227   ! wiz      12835: <td>MAKE_FILE</td>
1.212     wiz      12836: </tr>
                   12837: <tr>
1.226     gutterid 12838: <td>MAKE_FLAGS</td>
1.227   ! wiz      12839: <td>MAKE_JOBS</td>
1.156     leot     12840: </tr>
                   12841: <tr>
1.226     gutterid 12842: <td>MAKE_JOBS_SAFE</td>
1.227   ! wiz      12843: <td>MAKE_PROGRAM</td>
1.156     leot     12844: </tr>
                   12845: <tr>
1.226     gutterid 12846: <td>MANCOMPRESSED_IF_MANZ</td>
1.227   ! wiz      12847: <td>MANINSTALL</td>
1.156     leot     12848: </tr>
                   12849: <tr>
1.226     gutterid 12850: <td>MANZ</td>
1.227   ! wiz      12851: <td>MASTER_SITES</td>
1.156     leot     12852: </tr>
                   12853: <tr>
1.226     gutterid 12854: <td>MASTER_SITE_BACKUP</td>
1.227   ! wiz      12855: <td>MASTER_SITE_LOCAL</td>
1.189     bacon    12856: </tr>
                   12857: <tr>
1.226     gutterid 12858: <td>MASTER_SITE_MOZILLA</td>
1.227   ! wiz      12859: <td>MASTER_SITE_OVERRIDE</td>
1.156     leot     12860: </tr>
                   12861: <tr>
1.226     gutterid 12862: <td>MASTER_SITE_PERL_CPAN</td>
1.227   ! wiz      12863: <td>MASTER_SORT</td>
1.156     leot     12864: </tr>
                   12865: <tr>
1.226     gutterid 12866: <td>MASTER_SORT_RANDOM</td>
1.227   ! wiz      12867: <td>MASTER_SORT_REGEX</td>
1.156     leot     12868: </tr>
                   12869: <tr>
1.226     gutterid 12870: <td>MECAB_CHARSET</td>
1.227   ! wiz      12871: <td>MEDIATOMB_GROUP</td>
1.156     leot     12872: </tr>
                   12873: <tr>
1.226     gutterid 12874: <td>MEDIATOMB_USER</td>
1.227   ! wiz      12875: <td>MIPSPROBASE</td>
1.156     leot     12876: </tr>
                   12877: <tr>
1.226     gutterid 12878: <td>MIREDO_GROUP</td>
1.227   ! wiz      12879: <td>MIREDO_USER</td>
1.156     leot     12880: </tr>
                   12881: <tr>
1.226     gutterid 12882: <td>MISSING_FEATURES</td>
1.227   ! wiz      12883: <td>MKDIR</td>
1.156     leot     12884: </tr>
                   12885: <tr>
1.226     gutterid 12886: <td>MKPIE_SUPPORTED</td>
1.227   ! wiz      12887: <td>MLDONKEY_GROUP</td>
1.156     leot     12888: </tr>
                   12889: <tr>
1.226     gutterid 12890: <td>MLDONKEY_HOME</td>
1.227   ! wiz      12891: <td>MLDONKEY_USER</td>
1.156     leot     12892: </tr>
                   12893: <tr>
1.226     gutterid 12894: <td>MONOTONE_GROUP</td>
1.227   ! wiz      12895: <td>MONOTONE_USER</td>
1.207     leot     12896: </tr>
                   12897: <tr>
1.226     gutterid 12898: <td>MOTIFBASE</td>
1.227   ! wiz      12899: <td>MOTIF_TYPE</td>
1.156     leot     12900: </tr>
                   12901: <tr>
1.226     gutterid 12902: <td>MOTIF_TYPE_DEFAULT</td>
1.227   ! wiz      12903: <td>MPI_TYPE</td>
1.156     leot     12904: </tr>
                   12905: <tr>
1.226     gutterid 12906: <td>MSGFMT_STRIP_MSGCTXT</td>
1.227   ! wiz      12907: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.156     leot     12908: </tr>
                   12909: <tr>
1.226     gutterid 12910: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.227   ! wiz      12911: <td>MUST</td>
1.156     leot     12912: </tr>
                   12913: <tr>
1.221     nia      12914: <td>MV</td>
1.226     gutterid 12915: <td>MYSQL_CHARSET</td>
1.223     nia      12916: </tr>
                   12917: <tr>
                   12918: <td>MYSQL_DATADIR</td>
1.226     gutterid 12919: <td>MYSQL_EXTRA_CHARSET</td>
1.214     leot     12920: </tr>
                   12921: <tr>
1.223     nia      12922: <td>MYSQL_GROUP</td>
1.226     gutterid 12923: <td>MYSQL_USER</td>
1.197     leot     12924: </tr>
                   12925: <tr>
1.223     nia      12926: <td>MYSQL_VERSION</td>
1.226     gutterid 12927: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.205     wiz      12928: </tr>
                   12929: <tr>
1.223     nia      12930: <td>MYSQL_VERSIONS_ALL</td>
1.226     gutterid 12931: <td>MYSQL_VERSION_DEFAULT</td>
1.156     leot     12932: </tr>
                   12933: <tr>
1.223     nia      12934: <td>NAGIOSCMD_GROUP</td>
1.226     gutterid 12935: <td>NAGIOSDIR</td>
1.156     leot     12936: </tr>
                   12937: <tr>
1.223     nia      12938: <td>NAGIOS_GROUP</td>
1.226     gutterid 12939: <td>NAGIOS_USER</td>
1.156     leot     12940: </tr>
                   12941: <tr>
1.223     nia      12942: <td>NATIVE_APPEND_ABI</td>
1.226     gutterid 12943: <td>NATIVE_APPEND_ELF</td>
1.156     leot     12944: </tr>
                   12945: <tr>
1.223     nia      12946: <td>NATIVE_EXEC_FMT</td>
1.226     gutterid 12947: <td>NATIVE_MACHINE_PLATFORM</td>
1.195     gutterid 12948: </tr>
                   12949: <tr>
1.223     nia      12950: <td>NATIVE_OBJECT_FMT</td>
1.226     gutterid 12951: <td>NBPAX_PROGRAM_PREFIX</td>
1.156     leot     12952: </tr>
                   12953: <tr>
1.223     nia      12954: <td>NETBSD_LOGIN_NAME</td>
1.226     gutterid 12955: <td>NMH_EDITOR</td>
1.156     leot     12956: </tr>
                   12957: <tr>
1.223     nia      12958: <td>NMH_MTA</td>
1.226     gutterid 12959: <td>NMH_PAGER</td>
1.156     leot     12960: </tr>
                   12961: <tr>
1.223     nia      12962: <td>NODE_VERSIONS_ACCEPTED</td>
1.226     gutterid 12963: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.156     leot     12964: </tr>
                   12965: <tr>
1.223     nia      12966: <td>NODE_VERSION_DEFAULT</td>
1.226     gutterid 12967: <td>NODE_VERSION_REQD</td>
1.156     leot     12968: </tr>
                   12969: <tr>
1.223     nia      12970: <td>NOLOGIN</td>
1.226     gutterid 12971: <td>NOTE</td>
1.218     nia      12972: </tr>
                   12973: <tr>
1.223     nia      12974: <td>NOT_FOR_PLATFORM</td>
1.226     gutterid 12975: <td>NOT_PAX_ASLR_SAFE</td>
1.218     nia      12976: </tr>
                   12977: <tr>
1.223     nia      12978: <td>NOT_PAX_MPROTECT_SAFE</td>
1.226     gutterid 12979: <td>NO_BUILD</td>
1.156     leot     12980: </tr>
                   12981: <tr>
1.223     nia      12982: <td>NO_CHECKSUM</td>
1.226     gutterid 12983: <td>NO_CONFIGURE</td>
1.178     rillig   12984: </tr>
                   12985: <tr>
1.223     nia      12986: <td>NO_SKIP</td>
1.226     gutterid 12987: <td>NS_PREFERRED</td>
1.156     leot     12988: </tr>
                   12989: <tr>
1.223     nia      12990: <td>NULLMAILER_GROUP</td>
1.226     gutterid 12991: <td>NULLMAILER_USER</td>
1.156     leot     12992: </tr>
                   12993: <tr>
1.223     nia      12994: <td>OASIS</td>
1.226     gutterid 12995: <td>OASIS_BUILD_ARGS</td>
1.156     leot     12996: </tr>
                   12997: <tr>
1.223     nia      12998: <td>OBJHOSTNAME</td>
1.226     gutterid 12999: <td>OBJMACHINE</td>
1.156     leot     13000: </tr>
                   13001: <tr>
1.223     nia      13002: <td>OCAML_FINDLIB_DIRS</td>
1.226     gutterid 13003: <td>OCAML_FINDLIB_REGISTER</td>
1.156     leot     13004: </tr>
                   13005: <tr>
1.223     nia      13006: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.226     gutterid 13007: <td>OCAML_SITELIBDIR</td>
1.156     leot     13008: </tr>
                   13009: <tr>
1.223     nia      13010: <td>OCAML_TOPKG_DOCDIR</td>
1.226     gutterid 13011: <td>OCAML_USE_DUNE</td>
1.156     leot     13012: </tr>
                   13013: <tr>
1.223     nia      13014: <td>OCAML_USE_FINDLIB</td>
1.226     gutterid 13015: <td>OCAML_USE_OASIS</td>
1.156     leot     13016: </tr>
                   13017: <tr>
1.223     nia      13018: <td>OCAML_USE_OASIS_DYNRUN</td>
1.226     gutterid 13019: <td>OCAML_USE_OPAM</td>
1.156     leot     13020: </tr>
                   13021: <tr>
1.225     gutterid 13022: <td>OCAML_USE_TOPKG</td>
1.226     gutterid 13023: <td>OMF</td>
1.156     leot     13024: </tr>
                   13025: <tr>
1.225     gutterid 13026: <td>ONLY_FOR_COMPILER</td>
1.226     gutterid 13027: <td>ONLY_FOR_PLATFORM</td>
1.156     leot     13028: </tr>
                   13029: <tr>
1.225     gutterid 13030: <td>OPENSSH_CHROOT</td>
1.226     gutterid 13031: <td>OPENSSH_GROUP</td>
1.156     leot     13032: </tr>
                   13033: <tr>
1.225     gutterid 13034: <td>OPENSSH_USER</td>
1.226     gutterid 13035: <td>OPSYS</td>
1.156     leot     13036: </tr>
                   13037: <tr>
1.225     gutterid 13038: <td>OPSYS_EMULDIR</td>
1.226     gutterid 13039: <td>OPSYS_VERSION</td>
1.156     leot     13040: </tr>
                   13041: <tr>
1.225     gutterid 13042: <td>OS</td>
1.226     gutterid 13043: <td>OSS_TYPE</td>
1.156     leot     13044: </tr>
                   13045: <tr>
1.225     gutterid 13046: <td>OSX</td>
1.226     gutterid 13047: <td>OSX_TOLERATE_SDK_SKEW</td>
1.156     leot     13048: </tr>
                   13049: <tr>
1.227   ! wiz      13050: <td>OS_HAVE_ALSA</td>
        !          13051: <td>OS_HAVE_RCD</td>
        !          13052: </tr>
        !          13053: <tr>
1.225     gutterid 13054: <td>OS_VARIANT</td>
1.226     gutterid 13055: <td>OS_VERSION</td>
1.223     nia      13056: </tr>
                   13057: <tr>
1.225     gutterid 13058: <td>OTF_FONTS_DIR</td>
1.226     gutterid 13059: <td>OVERRIDE_DIRDEPTH</td>
1.212     wiz      13060: </tr>
                   13061: <tr>
1.225     gutterid 13062: <td>OVERRIDE_GEMSPEC</td>
1.226     gutterid 13063: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.214     leot     13064: </tr>
                   13065: <tr>
1.227   ! wiz      13066: <td>OVERRIDE_ROCKSPEC</td>
1.221     nia      13067: <td>OWN_DIRS</td>
1.227   ! wiz      13068: </tr>
        !          13069: <tr>
1.226     gutterid 13070: <td>OWN_DIRS_PERMS</td>
1.227   ! wiz      13071: <td>P4GROUP</td>
1.205     wiz      13072: </tr>
                   13073: <tr>
1.226     gutterid 13074: <td>P4PORT</td>
1.227   ! wiz      13075: <td>P4ROOT</td>
1.161     leot     13076: </tr>
                   13077: <tr>
1.226     gutterid 13078: <td>P4USER</td>
1.227   ! wiz      13079: <td>PACKAGES</td>
1.156     leot     13080: </tr>
                   13081: <tr>
1.226     gutterid 13082: <td>PALMOS_DEFAULT_SDK</td>
1.227   ! wiz      13083: <td>PAMBASE</td>
1.156     leot     13084: </tr>
                   13085: <tr>
1.226     gutterid 13086: <td>PAM_DEFAULT</td>
1.227   ! wiz      13087: <td>PAPERSIZE</td>
1.156     leot     13088: </tr>
                   13089: <tr>
1.226     gutterid 13090: <td>PASSIVE_FETCH</td>
1.227   ! wiz      13091: <td>PATCHDIR</td>
1.156     leot     13092: </tr>
                   13093: <tr>
1.226     gutterid 13094: <td>PATCHFILES</td>
1.227   ! wiz      13095: <td>PATCH_ARGS</td>
1.156     leot     13096: </tr>
                   13097: <tr>
1.226     gutterid 13098: <td>PATCH_DEBUG</td>
1.227   ! wiz      13099: <td>PATCH_DIST_ARGS</td>
1.209     nia      13100: </tr>
                   13101: <tr>
1.226     gutterid 13102: <td>PATCH_DIST_CAT</td>
1.227   ! wiz      13103: <td>PATCH_DIST_STRIP</td>
1.156     leot     13104: </tr>
                   13105: <tr>
1.226     gutterid 13106: <td>PATCH_FUZZ_FACTOR</td>
1.227   ! wiz      13107: <td>PATCH_STRIP</td>
1.156     leot     13108: </tr>
                   13109: <tr>
1.226     gutterid 13110: <td>PATH</td>
1.227   ! wiz      13111: <td>PCCBASE</td>
        !          13112: </tr>
        !          13113: <tr>
        !          13114: <td>PEAR</td>
        !          13115: <td>PEAR_CHANNEL</td>
        !          13116: </tr>
        !          13117: <tr>
        !          13118: <td>PEAR_CHANNEL_ALIAS</td>
        !          13119: <td>PEAR_CHANNEL_VERSION</td>
1.169     rillig   13120: </tr>
                   13121: <tr>
1.226     gutterid 13122: <td>PEAR_CMD</td>
1.227   ! wiz      13123: <td>PEAR_LIB</td>
1.156     leot     13124: </tr>
                   13125: <tr>
1.226     gutterid 13126: <td>PEAR_PACKAGE_XML</td>
1.227   ! wiz      13127: <td>PERL5</td>
1.217     rillig   13128: </tr>
                   13129: <tr>
1.226     gutterid 13130: <td>PERL5_CONFIGURE</td>
1.227   ! wiz      13131: <td>PERL5_CONFIGURE_DIRS</td>
1.205     wiz      13132: </tr>
                   13133: <tr>
1.226     gutterid 13134: <td>PERL5_LDFLAGS</td>
1.227   ! wiz      13135: <td>PERL5_LICENSE</td>
1.177     leot     13136: </tr>
                   13137: <tr>
1.226     gutterid 13138: <td>PERL5_MODULE_TYPE</td>
1.227   ! wiz      13139: <td>PERL5_PACKLIST</td>
1.161     leot     13140: </tr>
                   13141: <tr>
1.226     gutterid 13142: <td>PERL5_PACKLIST_DIR</td>
1.227   ! wiz      13143: <td>PERL5_PERLBASE</td>
1.161     leot     13144: </tr>
                   13145: <tr>
1.226     gutterid 13146: <td>PERL5_SITEBASE</td>
1.227   ! wiz      13147: <td>PERL5_USE_PACKLIST</td>
1.156     leot     13148: </tr>
                   13149: <tr>
1.226     gutterid 13150: <td>PERL5_VENDORBASE</td>
1.227   ! wiz      13151: <td>PFCTL</td>
1.156     leot     13152: </tr>
                   13153: <tr>
1.226     gutterid 13154: <td>PFVAR_H</td>
1.227   ! wiz      13155: <td>PF_VERSION</td>
1.156     leot     13156: </tr>
                   13157: <tr>
1.226     gutterid 13158: <td>PGGROUP</td>
1.227   ! wiz      13159: <td>PGHOME</td>
1.156     leot     13160: </tr>
                   13161: <tr>
1.226     gutterid 13162: <td>PGPKGSRCDIR</td>
1.227   ! wiz      13163: <td>PGSQL_TYPE</td>
1.156     leot     13164: </tr>
                   13165: <tr>
1.226     gutterid 13166: <td>PGSQL_VERSION</td>
1.227   ! wiz      13167: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156     leot     13168: </tr>
                   13169: <tr>
1.226     gutterid 13170: <td>PGSQL_VERSION_DEFAULT</td>
1.227   ! wiz      13171: <td>PGUSER</td>
1.156     leot     13172: </tr>
                   13173: <tr>
1.226     gutterid 13174: <td>PG_LIB_EXT</td>
1.227   ! wiz      13175: <td>PHP</td>
1.156     leot     13176: </tr>
                   13177: <tr>
1.226     gutterid 13178: <td>PHPCOMMON_MK</td>
1.227   ! wiz      13179: <td>PHPPKGSRCDIR</td>
1.156     leot     13180: </tr>
                   13181: <tr>
1.226     gutterid 13182: <td>PHP_BASE_VERS</td>
1.227   ! wiz      13183: <td>PHP_CHECK_INSTALLED</td>
1.156     leot     13184: </tr>
                   13185: <tr>
1.226     gutterid 13186: <td>PHP_EXTENSION_DIR</td>
1.227   ! wiz      13187: <td>PHP_INITIAL_TEENY</td>
1.156     leot     13188: </tr>
                   13189: <tr>
1.226     gutterid 13190: <td>PHP_PKG_PREFIX</td>
1.227   ! wiz      13191: <td>PHP_VERSION</td>
1.156     leot     13192: </tr>
                   13193: <tr>
1.226     gutterid 13194: <td>PHP_VERSIONS_ACCEPTED</td>
1.227   ! wiz      13195: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156     leot     13196: </tr>
                   13197: <tr>
1.226     gutterid 13198: <td>PHP_VERSION_DEFAULT</td>
1.227   ! wiz      13199: <td>PHP_VERSION_REQD</td>
1.156     leot     13200: </tr>
                   13201: <tr>
1.226     gutterid 13202: <td>PILRC_USE_GTK</td>
1.227   ! wiz      13203: <td>PKGCONFIG_BASE</td>
1.156     leot     13204: </tr>
                   13205: <tr>
1.226     gutterid 13206: <td>PKGCONFIG_FILE</td>
1.227   ! wiz      13207: <td>PKGCONFIG_OVERRIDE</td>
1.156     leot     13208: </tr>
                   13209: <tr>
1.226     gutterid 13210: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.227   ! wiz      13211: <td>PKGDIR</td>
1.156     leot     13212: </tr>
                   13213: <tr>
1.226     gutterid 13214: <td>PKGGNUDIR</td>
1.227   ! wiz      13215: <td>PKGINFODIR</td>
1.156     leot     13216: </tr>
                   13217: <tr>
1.226     gutterid 13218: <td>PKGLOCALEDIR</td>
1.227   ! wiz      13219: <td>PKGMANDIR</td>
1.156     leot     13220: </tr>
                   13221: <tr>
1.226     gutterid 13222: <td>PKGNAME</td>
1.227   ! wiz      13223: <td>PKGNAME_REQD</td>
1.156     leot     13224: </tr>
                   13225: <tr>
1.226     gutterid 13226: <td>PKGPATH</td>
1.227   ! wiz      13227: <td>PKGREVISION</td>
1.156     leot     13228: </tr>
                   13229: <tr>
1.226     gutterid 13230: <td>PKGSRC_BLAS_TYPES</td>
1.227   ! wiz      13231: <td>PKGSRC_CHANGES</td>
1.156     leot     13232: </tr>
                   13233: <tr>
1.226     gutterid 13234: <td>PKGSRC_COMPILER</td>
1.227   ! wiz      13235: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156     leot     13236: </tr>
                   13237: <tr>
1.226     gutterid 13238: <td>PKGSRC_LOCKTYPE</td>
1.227   ! wiz      13239: <td>PKGSRC_MAKE_ENV</td>
1.156     leot     13240: </tr>
                   13241: <tr>
1.226     gutterid 13242: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.227   ! wiz      13243: <td>PKGSRC_MKPIE</td>
1.177     leot     13244: </tr>
                   13245: <tr>
1.226     gutterid 13246: <td>PKGSRC_MKREPRO</td>
1.227   ! wiz      13247: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.156     leot     13248: </tr>
                   13249: <tr>
1.226     gutterid 13250: <td>PKGSRC_RUN_TEST</td>
1.227   ! wiz      13251: <td>PKGSRC_SETENV</td>
1.159     rillig   13252: </tr>
                   13253: <tr>
1.226     gutterid 13254: <td>PKGSRC_SLEEPSECS</td>
1.227   ! wiz      13255: <td>PKGSRC_TODO</td>
1.156     leot     13256: </tr>
                   13257: <tr>
1.226     gutterid 13258: <td>PKGSRC_USE_CTF</td>
1.227   ! wiz      13259: <td>PKGSRC_USE_FORTIFY</td>
1.156     leot     13260: </tr>
                   13261: <tr>
1.226     gutterid 13262: <td>PKGSRC_USE_MKTOOLS</td>
1.227   ! wiz      13263: <td>PKGSRC_USE_RELRO</td>
1.156     leot     13264: </tr>
                   13265: <tr>
1.221     nia      13266: <td>PKGSRC_USE_SSP</td>
1.227   ! wiz      13267: <td>PKGSRC_USE_STACK_CHECK</td>
1.156     leot     13268: </tr>
                   13269: <tr>
1.221     nia      13270: <td>PKGTASKS_DATAFILE</td>
1.227   ! wiz      13271: <td>PKGTOOLS_ARGS</td>
1.156     leot     13272: </tr>
                   13273: <tr>
1.221     nia      13274: <td>PKGTOOLS_ENV</td>
1.227   ! wiz      13275: <td>PKG_ALTERNATIVES</td>
1.156     leot     13276: </tr>
                   13277: <tr>
1.221     nia      13278: <td>PKG_APACHE</td>
1.227   ! wiz      13279: <td>PKG_APACHE_ACCEPTED</td>
1.156     leot     13280: </tr>
                   13281: <tr>
1.221     nia      13282: <td>PKG_APACHE_DEFAULT</td>
1.227   ! wiz      13283: <td>PKG_BEST_EXISTS</td>
1.156     leot     13284: </tr>
                   13285: <tr>
1.221     nia      13286: <td>PKG_BUILD_OPTIONS</td>
1.227   ! wiz      13287: <td>PKG_COMPRESSION</td>
1.156     leot     13288: </tr>
                   13289: <tr>
1.221     nia      13290: <td>PKG_CONFIG</td>
1.227   ! wiz      13291: <td>PKG_CONFIG_PERMS</td>
1.156     leot     13292: </tr>
                   13293: <tr>
1.221     nia      13294: <td>PKG_CREATE_USERGROUP</td>
1.227   ! wiz      13295: <td>PKG_DB_TMPDIR</td>
1.156     leot     13296: </tr>
                   13297: <tr>
1.221     nia      13298: <td>PKG_DEBUG_LEVEL</td>
1.227   ! wiz      13299: <td>PKG_DEFAULT_OPTIONS</td>
1.156     leot     13300: </tr>
                   13301: <tr>
1.221     nia      13302: <td>PKG_DESTDIR_SUPPORT</td>
1.227   ! wiz      13303: <td>PKG_DEVELOPER</td>
1.156     leot     13304: </tr>
                   13305: <tr>
1.221     nia      13306: <td>PKG_DISABLED_OPTIONS</td>
1.227   ! wiz      13307: <td>PKG_FATAL_ERRORS</td>
1.156     leot     13308: </tr>
                   13309: <tr>
1.221     nia      13310: <td>PKG_FC</td>
1.227   ! wiz      13311: <td>PKG_FILELIST_CMD</td>
1.156     leot     13312: </tr>
                   13313: <tr>
1.221     nia      13314: <td>PKG_GECOS</td>
1.227   ! wiz      13315: <td>PKG_GID</td>
1.156     leot     13316: </tr>
                   13317: <tr>
1.221     nia      13318: <td>PKG_GROUPS</td>
1.227   ! wiz      13319: <td>PKG_GROUPS_VARS</td>
1.156     leot     13320: </tr>
                   13321: <tr>
1.221     nia      13322: <td>PKG_HOME</td>
1.227   ! wiz      13323: <td>PKG_INIT_SCRIPTS</td>
1.156     leot     13324: </tr>
                   13325: <tr>
1.221     nia      13326: <td>PKG_JAVA_HOME</td>
1.227   ! wiz      13327: <td>PKG_JVM</td>
1.156     leot     13328: </tr>
                   13329: <tr>
1.221     nia      13330: <td>PKG_JVMS_ACCEPTED</td>
1.227   ! wiz      13331: <td>PKG_JVM_DEFAULT</td>
1.156     leot     13332: </tr>
                   13333: <tr>
1.221     nia      13334: <td>PKG_LEGACY_OPTIONS</td>
1.227   ! wiz      13335: <td>PKG_LIBTOOL</td>
1.156     leot     13336: </tr>
                   13337: <tr>
1.226     gutterid 13338: <td>PKG_MKSYMLINKS</td>
1.227   ! wiz      13339: <td>PKG_OPTIONS</td>
1.226     gutterid 13340: </tr>
                   13341: <tr>
                   13342: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.227   ! wiz      13343: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156     leot     13344: </tr>
                   13345: <tr>
1.226     gutterid 13346: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.227   ! wiz      13347: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156     leot     13348: </tr>
                   13349: <tr>
1.226     gutterid 13350: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.227   ! wiz      13351: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.156     leot     13352: </tr>
                   13353: <tr>
1.226     gutterid 13354: <td>PKG_OPTIONS_VAR</td>
1.227   ! wiz      13355: <td>PKG_PHP</td>
1.156     leot     13356: </tr>
                   13357: <tr>
1.226     gutterid 13358: <td>PKG_PHP_MAJOR_VERS</td>
1.227   ! wiz      13359: <td>PKG_PHP_VERSION</td>
1.156     leot     13360: </tr>
                   13361: <tr>
1.226     gutterid 13362: <td>PKG_RCD_SCRIPTS</td>
1.227   ! wiz      13363: <td>PKG_REFCOUNT_DBDIR</td>
1.156     leot     13364: </tr>
                   13365: <tr>
1.226     gutterid 13366: <td>PKG_REGISTER_SHELLS</td>
1.227   ! wiz      13367: <td>PKG_RESUME_TRANSFERS</td>
1.156     leot     13368: </tr>
                   13369: <tr>
1.226     gutterid 13370: <td>PKG_SHELL</td>
1.227   ! wiz      13371: <td>PKG_SUGGESTED_OPTIONS</td>
1.156     leot     13372: </tr>
                   13373: <tr>
1.226     gutterid 13374: <td>PKG_SUPPORTED_OPTIONS</td>
1.227   ! wiz      13375: <td>PKG_SYSCONFBASE</td>
1.156     leot     13376: </tr>
                   13377: <tr>
1.226     gutterid 13378: <td>PKG_SYSCONFBASEDIR</td>
1.227   ! wiz      13379: <td>PKG_SYSCONFDIR</td>
1.156     leot     13380: </tr>
                   13381: <tr>
1.226     gutterid 13382: <td>PKG_SYSCONFDIR_PERMS</td>
1.227   ! wiz      13383: <td>PKG_SYSCONFSUBDIR</td>
1.156     leot     13384: </tr>
                   13385: <tr>
1.226     gutterid 13386: <td>PKG_SYSCONFVAR</td>
1.227   ! wiz      13387: <td>PKG_TOOLS_BIN</td>
1.156     leot     13388: </tr>
                   13389: <tr>
1.226     gutterid 13390: <td>PKG_UID</td>
1.227   ! wiz      13391: <td>PKG_UPDATE_FONTS_DB</td>
1.156     leot     13392: </tr>
                   13393: <tr>
1.226     gutterid 13394: <td>PKG_USERS</td>
1.227   ! wiz      13395: <td>PKG_USERS_VARS</td>
1.156     leot     13396: </tr>
                   13397: <tr>
1.226     gutterid 13398: <td>PKG_VERBOSE</td>
1.227   ! wiz      13399: <td>PLEASE</td>
1.156     leot     13400: </tr>
                   13401: <tr>
1.226     gutterid 13402: <td>PLIST</td>
1.227   ! wiz      13403: <td>PLIST_AWK</td>
1.156     leot     13404: </tr>
                   13405: <tr>
1.226     gutterid 13406: <td>PLIST_AWK_ENV</td>
1.227   ! wiz      13407: <td>PLIST_SRC</td>
1.156     leot     13408: </tr>
                   13409: <tr>
1.226     gutterid 13410: <td>PLIST_SUBST</td>
1.227   ! wiz      13411: <td>PLIST_TYPE</td>
1.156     leot     13412: </tr>
                   13413: <tr>
1.226     gutterid 13414: <td>PLIST_VARS</td>
1.227   ! wiz      13415: <td>POPTOP_USE_MPPE</td>
1.156     leot     13416: </tr>
                   13417: <tr>
1.226     gutterid 13418: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.227   ! wiz      13419: <td>POST_FETCH_HOOK</td>
1.156     leot     13420: </tr>
                   13421: <tr>
1.226     gutterid 13422: <td>PREFER</td>
1.227   ! wiz      13423: <td>PREFER_NATIVE</td>
1.156     leot     13424: </tr>
                   13425: <tr>
1.226     gutterid 13426: <td>PREFER_NATIVE_PTHREADS</td>
1.227   ! wiz      13427: <td>PREFER_PKGSRC</td>
1.156     leot     13428: </tr>
                   13429: <tr>
1.226     gutterid 13430: <td>PREFIX</td>
1.227   ! wiz      13431: <td>PREPEND_PATH</td>
1.156     leot     13432: </tr>
                   13433: <tr>
1.226     gutterid 13434: <td>PRE_ROOT_CMD</td>
1.227   ! wiz      13435: <td>PRIVILEGED_STAGES</td>
1.156     leot     13436: </tr>
                   13437: <tr>
1.226     gutterid 13438: <td>PS</td>
1.227   ! wiz      13439: <td>PTHREAD_AUTO_VARS</td>
1.156     leot     13440: </tr>
                   13441: <tr>
1.226     gutterid 13442: <td>PTHREAD_CFLAGS</td>
1.227   ! wiz      13443: <td>PTHREAD_LDFLAGS</td>
1.156     leot     13444: </tr>
                   13445: <tr>
1.226     gutterid 13446: <td>PTHREAD_LIBS</td>
1.227   ! wiz      13447: <td>PTHREAD_OPTS</td>
1.156     leot     13448: </tr>
                   13449: <tr>
1.226     gutterid 13450: <td>PTHREAD_TYPE</td>
1.227   ! wiz      13451: <td>PVM_SSH</td>
1.156     leot     13452: </tr>
                   13453: <tr>
1.226     gutterid 13454: <td>PYPKGPREFIX</td>
1.227   ! wiz      13455: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156     leot     13456: </tr>
                   13457: <tr>
1.226     gutterid 13458: <td>PYTHON_SELF_CONFLICT</td>
1.227   ! wiz      13459: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156     leot     13460: </tr>
                   13461: <tr>
1.226     gutterid 13462: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.227   ! wiz      13463: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156     leot     13464: </tr>
                   13465: <tr>
1.226     gutterid 13466: <td>PYTHON_VERSION_DEFAULT</td>
1.227   ! wiz      13467: <td>PYTHON_VERSION_REQD</td>
1.156     leot     13468: </tr>
                   13469: <tr>
1.226     gutterid 13470: <td>PYVERSSUFFIX</td>
1.227   ! wiz      13471: <td>QMAILDIR</td>
1.156     leot     13472: </tr>
                   13473: <tr>
1.226     gutterid 13474: <td>QMAIL_ALIAS_USER</td>
1.227   ! wiz      13475: <td>QMAIL_DAEMON_USER</td>
1.156     leot     13476: </tr>
                   13477: <tr>
1.226     gutterid 13478: <td>QMAIL_LOG_USER</td>
1.227   ! wiz      13479: <td>QMAIL_NOFILES_GROUP</td>
1.156     leot     13480: </tr>
                   13481: <tr>
1.226     gutterid 13482: <td>QMAIL_PASSWD_USER</td>
1.227   ! wiz      13483: <td>QMAIL_QMAIL_GROUP</td>
1.156     leot     13484: </tr>
                   13485: <tr>
1.226     gutterid 13486: <td>QMAIL_QUEUE_DIR</td>
1.227   ! wiz      13487: <td>QMAIL_QUEUE_EXTRA</td>
1.156     leot     13488: </tr>
                   13489: <tr>
1.226     gutterid 13490: <td>QMAIL_QUEUE_USER</td>
1.227   ! wiz      13491: <td>QMAIL_REMOTE_USER</td>
1.156     leot     13492: </tr>
                   13493: <tr>
1.226     gutterid 13494: <td>QMAIL_ROOT_USER</td>
1.227   ! wiz      13495: <td>QMAIL_SEND_USER</td>
1.156     leot     13496: </tr>
                   13497: <tr>
1.226     gutterid 13498: <td>QORE_LATEST_MODULE_API</td>
1.227   ! wiz      13499: <td>QORE_MODULE_API</td>
1.156     leot     13500: </tr>
                   13501: <tr>
1.226     gutterid 13502: <td>QORE_MODULE_DIR</td>
1.227   ! wiz      13503: <td>QORE_USER_MODULE_DIR</td>
1.156     leot     13504: </tr>
                   13505: <tr>
1.226     gutterid 13506: <td>QORE_VERSION</td>
1.227   ! wiz      13507: <td>QPOPPER_FAC</td>
1.218     nia      13508: </tr>
                   13509: <tr>
1.226     gutterid 13510: <td>QPOPPER_SPOOL_DIR</td>
1.227   ! wiz      13511: <td>QPOPPER_USER</td>
1.218     nia      13512: </tr>
                   13513: <tr>
1.226     gutterid 13514: <td>RAKE_NAME</td>
1.227   ! wiz      13515: <td>RASMOL_DEPTH</td>
        !          13516: </tr>
        !          13517: <tr>
        !          13518: <td>RCD_DIR</td>
        !          13519: <td>RCD_ORDER</td>
1.218     nia      13520: </tr>
                   13521: <tr>
1.226     gutterid 13522: <td>RCD_SCRIPTS</td>
1.227   ! wiz      13523: <td>RCD_SCRIPTS_DIR</td>
1.156     leot     13524: </tr>
                   13525: <tr>
1.226     gutterid 13526: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.227   ! wiz      13527: <td>RCD_SCRIPTS_MODE</td>
1.214     leot     13528: </tr>
                   13529: <tr>
1.226     gutterid 13530: <td>RCD_SCRIPTS_SHELL</td>
1.227   ! wiz      13531: <td>RCD_SCRIPT_SRC</td>
1.217     rillig   13532: </tr>
                   13533: <tr>
1.227   ! wiz      13534: <td>RCD_SUBR</td>
1.226     gutterid 13535: <td>RDOC</td>
1.205     wiz      13536: </tr>
                   13537: <tr>
1.225     gutterid 13538: <td>READLINE_DEFAULT</td>
1.226     gutterid 13539: <td>READLINE_TYPE</td>
1.223     nia      13540: </tr>
                   13541: <tr>
1.225     gutterid 13542: <td>REAL_ROOT_GROUP</td>
1.226     gutterid 13543: <td>REAL_ROOT_USER</td>
1.177     leot     13544: </tr>
                   13545: <tr>
1.225     gutterid 13546: <td>RECURSIVE_MAKE</td>
1.226     gutterid 13547: <td>RELAY_CTRL_DIR</td>
1.214     leot     13548: </tr>
                   13549: <tr>
1.225     gutterid 13550: <td>RELRO_SUPPORTED</td>
1.226     gutterid 13551: <td>REPLACE_AWK</td>
1.212     wiz      13552: </tr>
                   13553: <tr>
1.225     gutterid 13554: <td>REPLACE_BASH</td>
1.226     gutterid 13555: <td>REPLACE_CSH</td>
1.156     leot     13556: </tr>
                   13557: <tr>
1.225     gutterid 13558: <td>REPLACE_KSH</td>
1.226     gutterid 13559: <td>REPLACE_LUA</td>
1.205     wiz      13560: </tr>
                   13561: <tr>
1.225     gutterid 13562: <td>REPLACE_NODEJS</td>
1.226     gutterid 13563: <td>REPLACE_OCTAVE</td>
1.197     leot     13564: </tr>
                   13565: <tr>
1.225     gutterid 13566: <td>REPLACE_PERL</td>
1.226     gutterid 13567: <td>REPLACE_PERL6</td>
1.156     leot     13568: </tr>
                   13569: <tr>
1.225     gutterid 13570: <td>REPLACE_PHP</td>
1.226     gutterid 13571: <td>REPLACE_PYTHON</td>
1.218     nia      13572: </tr>
                   13573: <tr>
1.225     gutterid 13574: <td>REPLACE_QORE</td>
1.226     gutterid 13575: <td>REPLACE_R</td>
1.161     leot     13576: </tr>
                   13577: <tr>
1.225     gutterid 13578: <td>REPLACE_RUBY</td>
1.226     gutterid 13579: <td>REPLACE_RUBY_DIRS</td>
1.216     gutterid 13580: </tr>
                   13581: <tr>
1.225     gutterid 13582: <td>REPLACE_RUBY_PAT</td>
1.226     gutterid 13583: <td>REPLACE_SH</td>
1.156     leot     13584: </tr>
                   13585: <tr>
1.225     gutterid 13586: <td>REPLACE_TEXLUA</td>
1.226     gutterid 13587: <td>REPLACE_WISH</td>
1.218     nia      13588: </tr>
                   13589: <tr>
1.225     gutterid 13590: <td>REQD_DIRS</td>
1.226     gutterid 13591: <td>REQD_DIRS_PERMS</td>
1.156     leot     13592: </tr>
                   13593: <tr>
1.225     gutterid 13594: <td>REQD_FILES</td>
1.226     gutterid 13595: <td>REQD_FILES_MODE</td>
1.156     leot     13596: </tr>
                   13597: <tr>
1.225     gutterid 13598: <td>REQD_FILES_PERMS</td>
1.226     gutterid 13599: <td>RESOLV_AUTO_VARS</td>
1.156     leot     13600: </tr>
                   13601: <tr>
1.225     gutterid 13602: <td>RESOLV_LDFLAGS</td>
1.226     gutterid 13603: <td>RESOLV_LIBS</td>
1.156     leot     13604: </tr>
                   13605: <tr>
1.220     nia      13606: <td>RM</td>
1.227   ! wiz      13607: <td>ROCKSPEC_NAME</td>
        !          13608: </tr>
        !          13609: <tr>
        !          13610: <td>ROCKSPEC_SPECFILE</td>
1.226     gutterid 13611: <td>ROOT_CMD</td>
1.156     leot     13612: </tr>
                   13613: <tr>
1.225     gutterid 13614: <td>ROOT_GROUP</td>
1.226     gutterid 13615: <td>ROOT_USER</td>
1.205     wiz      13616: </tr>
                   13617: <tr>
1.225     gutterid 13618: <td>RPCGEN</td>
1.226     gutterid 13619: <td>RPM</td>
1.217     rillig   13620: </tr>
                   13621: <tr>
1.225     gutterid 13622: <td>RPM2PKG_PLIST</td>
1.226     gutterid 13623: <td>RPM2PKG_PREFIX</td>
1.214     leot     13624: </tr>
                   13625: <tr>
1.225     gutterid 13626: <td>RPM2PKG_STAGE</td>
1.226     gutterid 13627: <td>RPM2PKG_STRIP</td>
1.212     wiz      13628: </tr>
                   13629: <tr>
1.225     gutterid 13630: <td>RPM2PKG_SUBPREFIX</td>
1.226     gutterid 13631: <td>RPMFILES</td>
1.156     leot     13632: </tr>
                   13633: <tr>
1.225     gutterid 13634: <td>RPMIGNOREPATH</td>
1.226     gutterid 13635: <td>RPM_DB_PREFIX</td>
1.197     leot     13636: </tr>
                   13637: <tr>
1.225     gutterid 13638: <td>RSSH_CVS_PATH</td>
1.226     gutterid 13639: <td>RSSH_RDIST_PATH</td>
1.156     leot     13640: </tr>
                   13641: <tr>
1.225     gutterid 13642: <td>RSSH_RSYNC_PATH</td>
1.226     gutterid 13643: <td>RSSH_SCP_PATH</td>
1.156     leot     13644: </tr>
                   13645: <tr>
1.225     gutterid 13646: <td>RSSH_SFTP_SERVER_PATH</td>
1.226     gutterid 13647: <td>RUBY</td>
1.156     leot     13648: </tr>
                   13649: <tr>
1.225     gutterid 13650: <td>RUBYGEM</td>
1.226     gutterid 13651: <td>RUBYGEM_NAME</td>
1.156     leot     13652: </tr>
                   13653: <tr>
1.225     gutterid 13654: <td>RUBYGEM_OPTIONS</td>
1.226     gutterid 13655: <td>RUBYGEM_VERBOSE</td>
1.156     leot     13656: </tr>
                   13657: <tr>
1.225     gutterid 13658: <td>RUBY_ABI_VERSION</td>
1.226     gutterid 13659: <td>RUBY_ARCH</td>
1.156     leot     13660: </tr>
                   13661: <tr>
1.225     gutterid 13662: <td>RUBY_ARCHINC</td>
1.226     gutterid 13663: <td>RUBY_ARCHLIB</td>
1.156     leot     13664: </tr>
                   13665: <tr>
1.225     gutterid 13666: <td>RUBY_BASE</td>
1.226     gutterid 13667: <td>RUBY_BASERIDIR</td>
1.156     leot     13668: </tr>
                   13669: <tr>
1.225     gutterid 13670: <td>RUBY_BUILD_DOCUMENT</td>
1.226     gutterid 13671: <td>RUBY_DLEXT</td>
1.156     leot     13672: </tr>
                   13673: <tr>
1.225     gutterid 13674: <td>RUBY_DOC</td>
1.226     gutterid 13675: <td>RUBY_DYNAMIC_DIRS</td>
1.156     leot     13676: </tr>
                   13677: <tr>
1.225     gutterid 13678: <td>RUBY_EG</td>
1.226     gutterid 13679: <td>RUBY_ENCODING_ARG</td>
1.198     leot     13680: </tr>
                   13681: <tr>
1.225     gutterid 13682: <td>RUBY_EXTCONF</td>
1.226     gutterid 13683: <td>RUBY_EXTCONF_CHECK</td>
1.156     leot     13684: </tr>
                   13685: <tr>
1.225     gutterid 13686: <td>RUBY_EXTCONF_DEBUG</td>
1.226     gutterid 13687: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156     leot     13688: </tr>
                   13689: <tr>
1.225     gutterid 13690: <td>RUBY_GEM_ARCH</td>
1.226     gutterid 13691: <td>RUBY_GEM_BASE</td>
1.156     leot     13692: </tr>
                   13693: <tr>
1.225     gutterid 13694: <td>RUBY_INC</td>
1.226     gutterid 13695: <td>RUBY_LIB</td>
1.156     leot     13696: </tr>
                   13697: <tr>
1.225     gutterid 13698: <td>RUBY_LIB_BASE</td>
1.226     gutterid 13699: <td>RUBY_NAME</td>
1.223     nia      13700: </tr>
                   13701: <tr>
1.225     gutterid 13702: <td>RUBY_NOVERSION</td>
1.226     gutterid 13703: <td>RUBY_PKGPREFIX</td>
1.156     leot     13704: </tr>
                   13705: <tr>
1.225     gutterid 13706: <td>RUBY_RAILS</td>
1.226     gutterid 13707: <td>RUBY_RAILS52_VERSION</td>
1.156     leot     13708: </tr>
                   13709: <tr>
1.225     gutterid 13710: <td>RUBY_RAILS60_VERSION</td>
1.226     gutterid 13711: <td>RUBY_RAILS61_VERSION</td>
1.156     leot     13712: </tr>
                   13713: <tr>
1.225     gutterid 13714: <td>RUBY_RAILS70_VERSION</td>
1.226     gutterid 13715: <td>RUBY_RAILS_ACCEPTED</td>
1.156     leot     13716: </tr>
                   13717: <tr>
1.225     gutterid 13718: <td>RUBY_RAILS_DEFAULT</td>
1.226     gutterid 13719: <td>RUBY_RAILS_REQD</td>
1.156     leot     13720: </tr>
                   13721: <tr>
1.225     gutterid 13722: <td>RUBY_RAILS_STRICT_DEP</td>
1.226     gutterid 13723: <td>RUBY_RIDIR</td>
1.156     leot     13724: </tr>
                   13725: <tr>
1.225     gutterid 13726: <td>RUBY_SETUP</td>
1.226     gutterid 13727: <td>RUBY_SHLIB</td>
1.156     leot     13728: </tr>
                   13729: <tr>
1.225     gutterid 13730: <td>RUBY_SHLIBALIAS</td>
1.226     gutterid 13731: <td>RUBY_SHLIBVER</td>
1.156     leot     13732: </tr>
                   13733: <tr>
1.225     gutterid 13734: <td>RUBY_SIMPLE_INSTALL</td>
1.226     gutterid 13735: <td>RUBY_SITEARCHLIB</td>
1.156     leot     13736: </tr>
                   13737: <tr>
1.225     gutterid 13738: <td>RUBY_SITELIB</td>
1.226     gutterid 13739: <td>RUBY_SITELIB_BASE</td>
1.174     leot     13740: </tr>
                   13741: <tr>
1.225     gutterid 13742: <td>RUBY_SITERIDIR</td>
1.226     gutterid 13743: <td>RUBY_SLEXT</td>
1.156     leot     13744: </tr>
                   13745: <tr>
1.225     gutterid 13746: <td>RUBY_SRCDIR</td>
1.226     gutterid 13747: <td>RUBY_STATICLIB</td>
1.156     leot     13748: </tr>
                   13749: <tr>
1.225     gutterid 13750: <td>RUBY_SUFFIX</td>
1.226     gutterid 13751: <td>RUBY_SYSRIDIR</td>
1.156     leot     13752: </tr>
                   13753: <tr>
1.225     gutterid 13754: <td>RUBY_USE_PTHREAD</td>
1.226     gutterid 13755: <td>RUBY_VENDORARCHLIB</td>
1.156     leot     13756: </tr>
                   13757: <tr>
1.225     gutterid 13758: <td>RUBY_VENDORLIB</td>
1.226     gutterid 13759: <td>RUBY_VENDORLIB_BASE</td>
1.156     leot     13760: </tr>
                   13761: <tr>
1.225     gutterid 13762: <td>RUBY_VER</td>
1.226     gutterid 13763: <td>RUBY_VERSION</td>
1.156     leot     13764: </tr>
                   13765: <tr>
1.225     gutterid 13766: <td>RUBY_VERSIONS_ACCEPTED</td>
1.226     gutterid 13767: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156     leot     13768: </tr>
                   13769: <tr>
1.225     gutterid 13770: <td>RUBY_VERSION_DEFAULT</td>
1.226     gutterid 13771: <td>RUBY_VERSION_REQD</td>
1.156     leot     13772: </tr>
                   13773: <tr>
1.225     gutterid 13774: <td>RUBY_VER_DIR</td>
1.226     gutterid 13775: <td>RUN</td>
1.156     leot     13776: </tr>
                   13777: <tr>
1.225     gutterid 13778: <td>RUN_LDCONFIG</td>
1.226     gutterid 13779: <td>RUST_TYPE</td>
1.156     leot     13780: </tr>
                   13781: <tr>
1.225     gutterid 13782: <td>SCO</td>
1.226     gutterid 13783: <td>SCREWS_GROUP</td>
1.156     leot     13784: </tr>
                   13785: <tr>
1.225     gutterid 13786: <td>SCREWS_USER</td>
1.226     gutterid 13787: <td>SCRIPTS_ENV</td>
1.156     leot     13788: </tr>
                   13789: <tr>
1.225     gutterid 13790: <td>SCROLLKEEPER_DATADIR</td>
1.226     gutterid 13791: <td>SCROLLKEEPER_REBUILDDB</td>
1.156     leot     13792: </tr>
                   13793: <tr>
1.225     gutterid 13794: <td>SCROLLKEEPER_UPDATEDB</td>
1.226     gutterid 13795: <td>SDIST_PAWD</td>
1.156     leot     13796: </tr>
                   13797: <tr>
1.225     gutterid 13798: <td>SDL12_TYPE</td>
1.226     gutterid 13799: <td>SERIAL_DEVICES</td>
1.156     leot     13800: </tr>
                   13801: <tr>
1.225     gutterid 13802: <td>SETGIDGAME</td>
1.226     gutterid 13803: <td>SETGID_GAMES_PERMS</td>
1.221     nia      13804: </tr>
                   13805: <tr>
1.225     gutterid 13806: <td>SETUID_ROOT_PERMS</td>
1.226     gutterid 13807: <td>SH</td>
1.156     leot     13808: </tr>
                   13809: <tr>
1.220     nia      13810: <td>SHLIB</td>
1.227   ! wiz      13811: <td>SHORTNAME</td>
        !          13812: </tr>
        !          13813: <tr>
1.226     gutterid 13814: <td>SIGN_PACKAGES</td>
1.227   ! wiz      13815: <td>SILC_CLIENT_WITH_PERL</td>
1.156     leot     13816: </tr>
                   13817: <tr>
1.226     gutterid 13818: <td>SITE_SPECIFIC_PKGS</td>
1.227   ! wiz      13819: <td>SKIP_DEPENDS</td>
1.156     leot     13820: </tr>
                   13821: <tr>
1.226     gutterid 13822: <td>SMF_INSTANCES</td>
1.227   ! wiz      13823: <td>SMF_MANIFEST</td>
1.177     leot     13824: </tr>
                   13825: <tr>
1.226     gutterid 13826: <td>SMF_METHODS</td>
1.227   ! wiz      13827: <td>SMF_METHOD_SHELL</td>
1.156     leot     13828: </tr>
                   13829: <tr>
1.226     gutterid 13830: <td>SMF_METHOD_SRC</td>
1.227   ! wiz      13831: <td>SMF_NAME</td>
1.217     rillig   13832: </tr>
                   13833: <tr>
1.226     gutterid 13834: <td>SMF_PREFIX</td>
1.227   ! wiz      13835: <td>SMF_SRCDIR</td>
1.156     leot     13836: </tr>
                   13837: <tr>
1.226     gutterid 13838: <td>SNIPROXY_GROUP</td>
1.227   ! wiz      13839: <td>SNIPROXY_USER</td>
1.159     rillig   13840: </tr>
                   13841: <tr>
1.226     gutterid 13842: <td>SOURCE_BUFFSIZE</td>
1.227   ! wiz      13843: <td>SPECIAL_PERMS</td>
1.156     leot     13844: </tr>
                   13845: <tr>
1.226     gutterid 13846: <td>SPECIFIC_PKGS</td>
1.227   ! wiz      13847: <td>SSH_SUID</td>
1.156     leot     13848: </tr>
                   13849: <tr>
1.226     gutterid 13850: <td>SSP_SUPPORTED</td>
1.227   ! wiz      13851: <td>SSYNC_PAWD</td>
1.156     leot     13852: </tr>
                   13853: <tr>
1.226     gutterid 13854: <td>STEP_MSG</td>
1.227   ! wiz      13855: <td>STRIP</td>
1.156     leot     13856: </tr>
                   13857: <tr>
1.226     gutterid 13858: <td>STRIP_DBG</td>
1.227   ! wiz      13859: <td>STRIP_DEBUG</td>
1.156     leot     13860: </tr>
                   13861: <tr>
1.226     gutterid 13862: <td>STRIP_DEBUG_SUPPORTED</td>
1.227   ! wiz      13863: <td>STRIP_FILES_SKIP</td>
1.156     leot     13864: </tr>
                   13865: <tr>
1.226     gutterid 13866: <td>SU</td>
1.227   ! wiz      13867: <td>SUBDIR</td>
1.156     leot     13868: </tr>
                   13869: <tr>
1.226     gutterid 13870: <td>SUBST</td>
1.227   ! wiz      13871: <td>SUBST_CLASSES</td>
1.156     leot     13872: </tr>
                   13873: <tr>
1.226     gutterid 13874: <td>SUBST_FILES</td>
1.227   ! wiz      13875: <td>SUBST_FILTER_CMD</td>
1.156     leot     13876: </tr>
                   13877: <tr>
1.226     gutterid 13878: <td>SUBST_MESSAGE</td>
1.227   ! wiz      13879: <td>SUBST_NOOP_OK</td>
1.156     leot     13880: </tr>
                   13881: <tr>
1.226     gutterid 13882: <td>SUBST_SED</td>
1.227   ! wiz      13883: <td>SUBST_SHOW_DIFF</td>
1.156     leot     13884: </tr>
                   13885: <tr>
1.226     gutterid 13886: <td>SUBST_SKIP_TEXT_CHECK</td>
1.227   ! wiz      13887: <td>SUBST_STAGE</td>
1.174     leot     13888: </tr>
                   13889: <tr>
1.226     gutterid 13890: <td>SUBST_VARS</td>
1.227   ! wiz      13891: <td>SUNWSPROBASE</td>
1.156     leot     13892: </tr>
                   13893: <tr>
1.226     gutterid 13894: <td>SUSE_PREFER</td>
1.227   ! wiz      13895: <td>SU_CMD</td>
        !          13896: </tr>
        !          13897: <tr>
        !          13898: <td>SVN_EXTRACTDIR</td>
        !          13899: <td>SVN_REPO</td>
        !          13900: </tr>
        !          13901: <tr>
        !          13902: <td>SVN_REPOSITORIES</td>
        !          13903: <td>SVN_REVISION</td>
1.156     leot     13904: </tr>
                   13905: <tr>
1.226     gutterid 13906: <td>SYSCONFBASE</td>
1.227   ! wiz      13907: <td>TARGET_ARCH</td>
1.156     leot     13908: </tr>
                   13909: <tr>
1.226     gutterid 13910: <td>TBL</td>
1.227   ! wiz      13911: <td>TERMCAP_TYPE</td>
1.217     rillig   13912: </tr>
                   13913: <tr>
1.226     gutterid 13914: <td>TERMINFO_DEFAULT</td>
1.227   ! wiz      13915: <td>TERMINFO_TYPE</td>
1.212     wiz      13916: </tr>
                   13917: <tr>
1.226     gutterid 13918: <td>TEST</td>
1.227   ! wiz      13919: <td>TEST_DEPENDS</td>
1.217     rillig   13920: </tr>
                   13921: <tr>
1.226     gutterid 13922: <td>TEST_DIRS</td>
1.227   ! wiz      13923: <td>TEST_ENV</td>
1.205     wiz      13924: </tr>
                   13925: <tr>
1.226     gutterid 13926: <td>TEST_ENV_SHELL</td>
1.227   ! wiz      13927: <td>TEST_MAKE_CMD</td>
1.189     bacon    13928: </tr>
                   13929: <tr>
1.226     gutterid 13930: <td>TEST_MAKE_FLAGS</td>
1.227   ! wiz      13931: <td>TEST_TARGET</td>
1.161     leot     13932: </tr>
                   13933: <tr>
1.226     gutterid 13934: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.227   ! wiz      13935: <td>TEXLIVE_REV</td>
1.159     rillig   13936: </tr>
                   13937: <tr>
1.226     gutterid 13938: <td>TEXLIVE_UNVERSIONED</td>
1.227   ! wiz      13939: <td>TEXMFSITE</td>
1.156     leot     13940: </tr>
                   13941: <tr>
1.226     gutterid 13942: <td>TEX_FORMATS</td>
1.227   ! wiz      13943: <td>TEX_HYPHEN_DAT</td>
1.156     leot     13944: </tr>
                   13945: <tr>
1.226     gutterid 13946: <td>TEX_HYPHEN_DEF</td>
1.227   ! wiz      13947: <td>TEX_TEXMF_DIRS</td>
1.156     leot     13948: </tr>
                   13949: <tr>
1.226     gutterid 13950: <td>THTTPD_LOG_FACILITY</td>
1.227   ! wiz      13951: <td>TINYDYN_USER</td>
1.156     leot     13952: </tr>
                   13953: <tr>
1.226     gutterid 13954: <td>TLSWRAPPER_CHROOT</td>
1.227   ! wiz      13955: <td>TO</td>
1.156     leot     13956: </tr>
                   13957: <tr>
1.226     gutterid 13958: <td>TOOLS_ALIASES</td>
1.227   ! wiz      13959: <td>TOOLS_ALWAYS_WRAP</td>
1.156     leot     13960: </tr>
                   13961: <tr>
1.226     gutterid 13962: <td>TOOLS_ARGS</td>
1.227   ! wiz      13963: <td>TOOLS_BROKEN</td>
1.156     leot     13964: </tr>
                   13965: <tr>
1.226     gutterid 13966: <td>TOOLS_CMD</td>
1.227   ! wiz      13967: <td>TOOLS_CMDLINE_SED</td>
1.156     leot     13968: </tr>
                   13969: <tr>
1.226     gutterid 13970: <td>TOOLS_CREATE</td>
1.227   ! wiz      13971: <td>TOOLS_CROSS_DESTDIR</td>
1.156     leot     13972: </tr>
                   13973: <tr>
1.226     gutterid 13974: <td>TOOLS_DIR</td>
1.227   ! wiz      13975: <td>TOOLS_FAIL</td>
1.156     leot     13976: </tr>
                   13977: <tr>
1.226     gutterid 13978: <td>TOOLS_GNU_MISSING</td>
1.227   ! wiz      13979: <td>TOOLS_LDCONFIG</td>
1.156     leot     13980: </tr>
                   13981: <tr>
1.226     gutterid 13982: <td>TOOLS_NOOP</td>
1.227   ! wiz      13983: <td>TOOLS_PATH</td>
1.156     leot     13984: </tr>
                   13985: <tr>
1.226     gutterid 13986: <td>TOOLS_SCRIPT</td>
1.227   ! wiz      13987: <td>TOOLS_USE_CROSS_COMPILE</td>
1.156     leot     13988: </tr>
                   13989: <tr>
1.226     gutterid 13990: <td>TOOL_DEPENDS</td>
1.227   ! wiz      13991: <td>TTF_FONTDIR</td>
1.156     leot     13992: </tr>
                   13993: <tr>
1.225     gutterid 13994: <td>TTF_FONTS_DIR</td>
1.226     gutterid 13995: <td>TYPE</td>
1.223     nia      13996: </tr>
                   13997: <tr>
1.225     gutterid 13998: <td>UAC_REQD_EXECS</td>
1.226     gutterid 13999: <td>UCSPI_SSL_GROUP</td>
1.156     leot     14000: </tr>
                   14001: <tr>
1.225     gutterid 14002: <td>UCSPI_SSL_USER</td>
1.226     gutterid 14003: <td>UNLIMIT_RESOURCES</td>
1.214     leot     14004: </tr>
                   14005: <tr>
1.225     gutterid 14006: <td>UNPRIVILEGED</td>
1.226     gutterid 14007: <td>UNPRIVILEGED_GROUP</td>
1.212     wiz      14008: </tr>
                   14009: <tr>
1.225     gutterid 14010: <td>UNPRIVILEGED_GROUPS</td>
1.226     gutterid 14011: <td>UNPRIVILEGED_USER</td>
1.156     leot     14012: </tr>
                   14013: <tr>
1.225     gutterid 14014: <td>UNWRAP_FILES</td>
1.226     gutterid 14015: <td>UNWRAP_PATTERNS</td>
1.156     leot     14016: </tr>
                   14017: <tr>
1.225     gutterid 14018: <td>UPDATE_GEMSPEC</td>
1.226     gutterid 14019: <td>UPDATE_TARGET</td>
1.156     leot     14020: </tr>
                   14021: <tr>
1.225     gutterid 14022: <td>URI</td>
1.226     gutterid 14023: <td>USERGROUP_PHASE</td>
1.156     leot     14024: </tr>
                   14025: <tr>
1.225     gutterid 14026: <td>USERPPP_GROUP</td>
1.226     gutterid 14027: <td>USER_SPECIFIC_PKGS</td>
1.156     leot     14028: </tr>
                   14029: <tr>
1.225     gutterid 14030: <td>USE_ABI_DEPENDS</td>
1.226     gutterid 14031: <td>USE_APR</td>
1.156     leot     14032: </tr>
                   14033: <tr>
1.225     gutterid 14034: <td>USE_BSD_MAKEFILE</td>
1.226     gutterid 14035: <td>USE_BUILTIN</td>
1.156     leot     14036: </tr>
                   14037: <tr>
1.225     gutterid 14038: <td>USE_CROSS_COMPILE</td>
1.226     gutterid 14039: <td>USE_CURSES</td>
1.156     leot     14040: </tr>
                   14041: <tr>
1.225     gutterid 14042: <td>USE_CWRAPPERS</td>
1.226     gutterid 14043: <td>USE_DB185</td>
1.156     leot     14044: </tr>
                   14045: <tr>
1.225     gutterid 14046: <td>USE_FEATURES</td>
1.226     gutterid 14047: <td>USE_GAMESGROUP</td>
1.205     wiz      14048: </tr>
                   14049: <tr>
1.225     gutterid 14050: <td>USE_GCC_RUNTIME</td>
1.226     gutterid 14051: <td>USE_IMAKE</td>
1.156     leot     14052: </tr>
                   14053: <tr>
1.225     gutterid 14054: <td>USE_JAVA</td>
1.226     gutterid 14055: <td>USE_JAVA2</td>
1.156     leot     14056: </tr>
                   14057: <tr>
1.225     gutterid 14058: <td>USE_LANGUAGES</td>
1.226     gutterid 14059: <td>USE_LIBTOOL</td>
1.156     leot     14060: </tr>
                   14061: <tr>
1.225     gutterid 14062: <td>USE_NATIVE_GCC</td>
1.226     gutterid 14063: <td>USE_NETBSD_REPO</td>
1.156     leot     14064: </tr>
                   14065: <tr>
1.225     gutterid 14066: <td>USE_PKGSRC_GCC</td>
1.226     gutterid 14067: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156     leot     14068: </tr>
                   14069: <tr>
1.225     gutterid 14070: <td>USE_PKGTASKS</td>
1.226     gutterid 14071: <td>USE_PKG_ADMIN_DIGEST</td>
1.156     leot     14072: </tr>
                   14073: <tr>
1.225     gutterid 14074: <td>USE_RUBY_EXTCONF</td>
1.226     gutterid 14075: <td>USE_RUBY_INSTALL</td>
1.156     leot     14076: </tr>
                   14077: <tr>
1.225     gutterid 14078: <td>USE_RUBY_SETUP</td>
1.226     gutterid 14079: <td>USE_RUBY_SETUP_PKG</td>
1.156     leot     14080: </tr>
                   14081: <tr>
1.225     gutterid 14082: <td>USE_TOOLS</td>
1.226     gutterid 14083: <td>UUCP_GROUP</td>
1.156     leot     14084: </tr>
                   14085: <tr>
1.225     gutterid 14086: <td>UUCP_USER</td>
1.226     gutterid 14087: <td>VARBASE</td>
1.156     leot     14088: </tr>
                   14089: <tr>
1.225     gutterid 14090: <td>VARNAME</td>
1.226     gutterid 14091: <td>VIM_EXTRA_OPTS</td>
1.156     leot     14092: </tr>
                   14093: <tr>
1.225     gutterid 14094: <td>WARNING_MSG</td>
1.226     gutterid 14095: <td>WCALC_CGIDIR</td>
1.156     leot     14096: </tr>
                   14097: <tr>
1.225     gutterid 14098: <td>WCALC_CGIPATH</td>
1.226     gutterid 14099: <td>WCALC_HTMLDIR</td>
1.156     leot     14100: </tr>
                   14101: <tr>
1.225     gutterid 14102: <td>WCALC_HTMLPATH</td>
1.226     gutterid 14103: <td>WDM_MANAGERS</td>
1.156     leot     14104: </tr>
                   14105: <tr>
1.225     gutterid 14106: <td>WRAPPER_CC</td>
1.226     gutterid 14107: <td>WRAPPER_REORDER_CMDS</td>
1.156     leot     14108: </tr>
                   14109: <tr>
1.225     gutterid 14110: <td>WRKDIR</td>
1.226     gutterid 14111: <td>WRKDIR_BASENAME</td>
1.156     leot     14112: </tr>
                   14113: <tr>
1.225     gutterid 14114: <td>WRKDIR_LOCKTYPE</td>
1.226     gutterid 14115: <td>WRKLOG</td>
1.156     leot     14116: </tr>
                   14117: <tr>
1.225     gutterid 14118: <td>WRKOBJDIR</td>
1.226     gutterid 14119: <td>WRKSRC</td>
1.156     leot     14120: </tr>
                   14121: <tr>
1.225     gutterid 14122: <td>X10_PORT</td>
1.226     gutterid 14123: <td>X11</td>
1.156     leot     14124: </tr>
                   14125: <tr>
1.225     gutterid 14126: <td>X11BASE</td>
1.226     gutterid 14127: <td>X11_PKGSRCDIR</td>
1.189     bacon    14128: </tr>
                   14129: <tr>
1.225     gutterid 14130: <td>X11_TYPE</td>
1.226     gutterid 14131: <td>X509_CERTIFICATE</td>
1.156     leot     14132: </tr>
                   14133: <tr>
1.225     gutterid 14134: <td>X509_KEY</td>
1.226     gutterid 14135: <td>XAW_TYPE</td>
1.156     leot     14136: </tr>
                   14137: <tr>
1.225     gutterid 14138: <td>XLOCK_DEFAULT_MODE</td>
1.226     gutterid 14139: <td>XMKMF</td>
1.156     leot     14140: </tr>
                   14141: <tr>
1.225     gutterid 14142: <td>XMKMF_FLAGS</td>
1.226     gutterid 14143: <td>XXX</td>
1.156     leot     14144: </tr>
                   14145: <tr>
1.227   ! wiz      14146: <td>XXXX</td>
1.222     gutterid 14147: <td>YES</td>
1.227   ! wiz      14148: </tr>
        !          14149: <tr>
1.226     gutterid 14150: <td>ZSH_STATIC</td>
1.227   ! wiz      14151: <td>__stdc__</td>
1.156     leot     14152: </tr>
                   14153: <tr>
1.226     gutterid 14154: <td>_vargroups</td>
1.227   ! wiz      14155: <td>accept</td>
1.159     rillig   14156: </tr>
                   14157: <tr>
1.226     gutterid 14158: <td>acquire-localbase-lock</td>
1.227   ! wiz      14159: <td>acquire-lock</td>
1.217     rillig   14160: </tr>
                   14161: <tr>
1.226     gutterid 14162: <td>add</td>
1.227   ! wiz      14163: <td>added</td>
1.156     leot     14164: </tr>
                   14165: <tr>
1.222     gutterid 14166: <td>administrator</td>
1.227   ! wiz      14167: <td>alloca</td>
1.201     cirnatda 14168: </tr>
                   14169: <tr>
1.222     gutterid 14170: <td>alternatives</td>
1.227   ! wiz      14171: <td>aslr</td>
1.174     leot     14172: </tr>
                   14173: <tr>
1.222     gutterid 14174: <td>asprintf</td>
1.227   ! wiz      14175: <td>atlas</td>
1.156     leot     14176: </tr>
                   14177: <tr>
1.222     gutterid 14178: <td>autoconf</td>
1.227   ! wiz      14179: <td>automake</td>
1.156     leot     14180: </tr>
                   14181: <tr>
1.222     gutterid 14182: <td>autoreconf</td>
1.227   ! wiz      14183: <td>awk</td>
1.174     leot     14184: </tr>
                   14185: <tr>
1.222     gutterid 14186: <td>bash</td>
1.227   ! wiz      14187: <td>big-endian</td>
1.156     leot     14188: </tr>
                   14189: <tr>
1.222     gutterid 14190: <td>bin-install</td>
1.227   ! wiz      14191: <td>bind</td>
1.161     leot     14192: </tr>
                   14193: <tr>
1.222     gutterid 14194: <td>binpkg-list</td>
1.227   ! wiz      14195: <td>blas</td>
1.156     leot     14196: </tr>
                   14197: <tr>
1.222     gutterid 14198: <td>bootstrap-depends</td>
1.227   ! wiz      14199: <td>broken</td>
1.156     leot     14200: </tr>
                   14201: <tr>
1.222     gutterid 14202: <td>broken_on_platform</td>
1.227   ! wiz      14203: <td>bsd</td>
1.156     leot     14204: </tr>
                   14205: <tr>
1.222     gutterid 14206: <td>bsd.prog.mk</td>
1.227   ! wiz      14207: <td>build</td>
1.177     leot     14208: </tr>
                   14209: <tr>
1.222     gutterid 14210: <td>build-env</td>
1.227   ! wiz      14211: <td>buildlink-directories</td>
1.159     rillig   14212: </tr>
                   14213: <tr>
1.222     gutterid 14214: <td>buildlink-oss-soundcard-h</td>
1.227   ! wiz      14215: <td>c</td>
1.156     leot     14216: </tr>
                   14217: <tr>
1.222     gutterid 14218: <td>c++</td>
1.227   ! wiz      14219: <td>ccache</td>
1.174     leot     14220: </tr>
                   14221: <tr>
1.222     gutterid 14222: <td>cce</td>
1.227   ! wiz      14223: <td>cdefs</td>
1.156     leot     14224: </tr>
                   14225: <tr>
1.222     gutterid 14226: <td>ceil</td>
1.227   ! wiz      14227: <td>changes</td>
1.156     leot     14228: </tr>
                   14229: <tr>
1.222     gutterid 14230: <td>changes-entry</td>
1.227   ! wiz      14231: <td>changes-entry-noupdate</td>
1.156     leot     14232: </tr>
                   14233: <tr>
1.222     gutterid 14234: <td>check</td>
1.227   ! wiz      14235: <td>check-clean</td>
1.156     leot     14236: </tr>
                   14237: <tr>
1.222     gutterid 14238: <td>check-files</td>
1.227   ! wiz      14239: <td>check-files-clean</td>
1.174     leot     14240: </tr>
                   14241: <tr>
1.222     gutterid 14242: <td>check-vulnerable</td>
1.227   ! wiz      14243: <td>checksum</td>
1.156     leot     14244: </tr>
                   14245: <tr>
1.222     gutterid 14246: <td>checksum-phase</td>
1.227   ! wiz      14247: <td>clean</td>
1.156     leot     14248: </tr>
                   14249: <tr>
1.222     gutterid 14250: <td>clean-depends</td>
1.227   ! wiz      14251: <td>cleandir</td>
1.156     leot     14252: </tr>
                   14253: <tr>
1.222     gutterid 14254: <td>commit</td>
1.227   ! wiz      14255: <td>commit-changes-entry</td>
1.156     leot     14256: </tr>
                   14257: <tr>
1.222     gutterid 14258: <td>compact</td>
1.227   ! wiz      14259: <td>compiler</td>
1.156     leot     14260: </tr>
                   14261: <tr>
1.222     gutterid 14262: <td>conf</td>
1.227   ! wiz      14263: <td>config.guess</td>
1.156     leot     14264: </tr>
                   14265: <tr>
1.222     gutterid 14266: <td>config.sub</td>
1.227   ! wiz      14267: <td>configuration</td>
1.156     leot     14268: </tr>
                   14269: <tr>
1.222     gutterid 14270: <td>configure</td>
1.227   ! wiz      14271: <td>configure-env</td>
1.156     leot     14272: </tr>
                   14273: <tr>
1.222     gutterid 14274: <td>configure-help</td>
1.227   ! wiz      14275: <td>configure_args</td>
1.156     leot     14276: </tr>
                   14277: <tr>
1.222     gutterid 14278: <td>connect</td>
1.227   ! wiz      14279: <td>cos</td>
1.156     leot     14280: </tr>
                   14281: <tr>
1.222     gutterid 14282: <td>cputime</td>
1.227   ! wiz      14283: <td>create-usergroup</td>
1.156     leot     14284: </tr>
                   14285: <tr>
1.222     gutterid 14286: <td>csh</td>
1.227   ! wiz      14287: <td>ctf</td>
1.156     leot     14288: </tr>
                   14289: <tr>
1.227   ! wiz      14290: <td>cvs</td>
1.225     gutterid 14291: <td>debug</td>
1.223     nia      14292: </tr>
                   14293: <tr>
                   14294: <td>declaration</td>
1.225     gutterid 14295: <td>declare</td>
1.174     leot     14296: </tr>
                   14297: <tr>
1.223     nia      14298: <td>defined</td>
1.225     gutterid 14299: <td>depend</td>
1.214     leot     14300: </tr>
                   14301: <tr>
1.223     nia      14302: <td>dependencies</td>
1.225     gutterid 14303: <td>depends</td>
1.205     wiz      14304: </tr>
                   14305: <tr>
1.223     nia      14306: <td>depends-checksum</td>
1.225     gutterid 14307: <td>depends-fetch</td>
1.161     leot     14308: </tr>
                   14309: <tr>
1.223     nia      14310: <td>deps</td>
1.225     gutterid 14311: <td>describe</td>
1.197     leot     14312: </tr>
                   14313: <tr>
1.223     nia      14314: <td>destdir</td>
1.225     gutterid 14315: <td>disable</td>
1.156     leot     14316: </tr>
                   14317: <tr>
1.223     nia      14318: <td>distclean</td>
1.225     gutterid 14319: <td>distinfo</td>
1.156     leot     14320: </tr>
                   14321: <tr>
1.223     nia      14322: <td>dl</td>
1.225     gutterid 14323: <td>dlopen</td>
1.156     leot     14324: </tr>
                   14325: <tr>
1.223     nia      14326: <td>do-buildlink</td>
1.225     gutterid 14327: <td>do-clean</td>
1.156     leot     14328: </tr>
                   14329: <tr>
1.223     nia      14330: <td>do-configure</td>
1.225     gutterid 14331: <td>do-configure-post-hook</td>
1.156     leot     14332: </tr>
                   14333: <tr>
1.223     nia      14334: <td>do-extract</td>
1.225     gutterid 14335: <td>do-fetch</td>
1.162     rillig   14336: </tr>
                   14337: <tr>
1.223     nia      14338: <td>do-install</td>
1.225     gutterid 14339: <td>emul</td>
1.156     leot     14340: </tr>
                   14341: <tr>
1.223     nia      14342: <td>emul-distinfo</td>
1.225     gutterid 14343: <td>emul-fetch</td>
1.217     rillig   14344: </tr>
                   14345: <tr>
1.223     nia      14346: <td>emulation</td>
1.225     gutterid 14347: <td>emulator</td>
1.156     leot     14348: </tr>
                   14349: <tr>
1.223     nia      14350: <td>enable</td>
1.221     nia      14351: <td>endian</td>
1.156     leot     14352: </tr>
                   14353: <tr>
1.227   ! wiz      14354: <td>endif</td>
1.221     nia      14355: <td>enomem</td>
1.227   ! wiz      14356: </tr>
        !          14357: <tr>
1.222     gutterid 14358: <td>ensurepip</td>
1.227   ! wiz      14359: <td>err</td>
1.214     leot     14360: </tr>
                   14361: <tr>
1.222     gutterid 14362: <td>errx</td>
1.227   ! wiz      14363: <td>etc</td>
1.156     leot     14364: </tr>
                   14365: <tr>
1.222     gutterid 14366: <td>exp</td>
1.227   ! wiz      14367: <td>extract-rpm</td>
1.205     wiz      14368: </tr>
                   14369: <tr>
1.222     gutterid 14370: <td>fabs</td>
1.227   ! wiz      14371: <td>feature</td>
1.197     leot     14372: </tr>
                   14373: <tr>
1.222     gutterid 14374: <td>features</td>
1.227   ! wiz      14375: <td>fetch</td>
1.156     leot     14376: </tr>
                   14377: <tr>
1.222     gutterid 14378: <td>fetch-list</td>
1.227   ! wiz      14379: <td>follows</td>
1.156     leot     14380: </tr>
                   14381: <tr>
1.222     gutterid 14382: <td>forbids</td>
1.227   ! wiz      14383: <td>form</td>
1.174     leot     14384: </tr>
                   14385: <tr>
1.222     gutterid 14386: <td>format</td>
1.227   ! wiz      14387: <td>fortify</td>
1.156     leot     14388: </tr>
                   14389: <tr>
1.220     nia      14390: <td>fortify_source</td>
1.227   ! wiz      14391: <td>fossil</td>
1.217     rillig   14392: </tr>
                   14393: <tr>
1.220     nia      14394: <td>friend</td>
1.225     gutterid 14395: <td>fts</td>
1.223     nia      14396: </tr>
                   14397: <tr>
                   14398: <td>fts_close</td>
1.225     gutterid 14399: <td>fts_open</td>
1.156     leot     14400: </tr>
                   14401: <tr>
1.223     nia      14402: <td>fts_read</td>
1.225     gutterid 14403: <td>fts_set</td>
1.156     leot     14404: </tr>
                   14405: <tr>
1.223     nia      14406: <td>gcc</td>
1.225     gutterid 14407: <td>gethostbyaddr</td>
1.156     leot     14408: </tr>
                   14409: <tr>
1.223     nia      14410: <td>gethostbyname</td>
1.225     gutterid 14411: <td>gethostbyname2</td>
1.156     leot     14412: </tr>
                   14413: <tr>
1.223     nia      14414: <td>getopt_long</td>
1.225     gutterid 14415: <td>getprogname</td>
1.174     leot     14416: </tr>
                   14417: <tr>
1.223     nia      14418: <td>getservbyname</td>
1.225     gutterid 14419: <td>getservbyport</td>
1.156     leot     14420: </tr>
                   14421: <tr>
1.223     nia      14422: <td>getservent</td>
1.217     rillig   14423: <td>gettext</td>
1.174     leot     14424: </tr>
                   14425: <tr>
1.227   ! wiz      14426: <td>git</td>
1.209     nia      14427: <td>github</td>
1.227   ! wiz      14428: </tr>
        !          14429: <tr>
1.223     nia      14430: <td>gitlab</td>
1.227   ! wiz      14431: <td>glob</td>
1.223     nia      14432: </tr>
                   14433: <tr>
                   14434: <td>gnu</td>
1.227   ! wiz      14435: <td>gnu_configure_strict</td>
1.217     rillig   14436: </tr>
                   14437: <tr>
1.223     nia      14438: <td>go</td>
1.227   ! wiz      14439: <td>go-deps</td>
1.156     leot     14440: </tr>
                   14441: <tr>
1.223     nia      14442: <td>golang</td>
1.227   ! wiz      14443: <td>guess-license</td>
1.159     rillig   14444: </tr>
                   14445: <tr>
1.223     nia      14446: <td>hashbang</td>
1.227   ! wiz      14447: <td>heimdal</td>
1.156     leot     14448: </tr>
                   14449: <tr>
1.223     nia      14450: <td>help</td>
1.227   ! wiz      14451: <td>hg</td>
1.156     leot     14452: </tr>
                   14453: <tr>
1.222     gutterid 14454: <td>imake</td>
1.225     gutterid 14455: <td>increment</td>
1.214     leot     14456: </tr>
                   14457: <tr>
1.222     gutterid 14458: <td>indirect</td>
1.225     gutterid 14459: <td>inet_aton</td>
1.156     leot     14460: </tr>
                   14461: <tr>
1.212     wiz      14462: <td>interp</td>
1.225     gutterid 14463: <td>interpreter</td>
1.205     wiz      14464: </tr>
                   14465: <tr>
1.212     wiz      14466: <td>intl</td>
1.225     gutterid 14467: <td>ip4</td>
1.197     leot     14468: </tr>
                   14469: <tr>
1.212     wiz      14470: <td>ip6</td>
1.225     gutterid 14471: <td>ipv4</td>
1.161     leot     14472: </tr>
                   14473: <tr>
1.212     wiz      14474: <td>ipv6</td>
1.225     gutterid 14475: <td>iso</td>
1.156     leot     14476: </tr>
                   14477: <tr>
1.212     wiz      14478: <td>kerberos</td>
1.225     gutterid 14479: <td>krb</td>
1.156     leot     14480: </tr>
                   14481: <tr>
1.212     wiz      14482: <td>krb5</td>
1.225     gutterid 14483: <td>ksh</td>
1.156     leot     14484: </tr>
                   14485: <tr>
1.212     wiz      14486: <td>lapack</td>
1.225     gutterid 14487: <td>latex</td>
1.189     bacon    14488: </tr>
                   14489: <tr>
1.212     wiz      14490: <td>libintl_bindtextdomain</td>
1.225     gutterid 14491: <td>libintl_gettext</td>
1.189     bacon    14492: </tr>
                   14493: <tr>
1.212     wiz      14494: <td>libintl_textdomain</td>
1.225     gutterid 14495: <td>libnbcompat</td>
1.156     leot     14496: </tr>
                   14497: <tr>
1.212     wiz      14498: <td>libs</td>
1.225     gutterid 14499: <td>libtool</td>
1.177     leot     14500: </tr>
                   14501: <tr>
1.212     wiz      14502: <td>licence</td>
1.225     gutterid 14503: <td>license</td>
1.156     leot     14504: </tr>
                   14505: <tr>
1.212     wiz      14506: <td>lintl</td>
1.225     gutterid 14507: <td>little-endian</td>
1.174     leot     14508: </tr>
                   14509: <tr>
1.212     wiz      14510: <td>lock</td>
1.225     gutterid 14511: <td>locking</td>
1.159     rillig   14512: </tr>
                   14513: <tr>
1.218     nia      14514: <td>lua</td>
1.225     gutterid 14515: <td>lvalue</td>
1.156     leot     14516: </tr>
                   14517: <tr>
1.215     wiz      14518: <td>make</td>
1.225     gutterid 14519: <td>makesum</td>
1.156     leot     14520: </tr>
                   14521: <tr>
1.215     wiz      14522: <td>memory</td>
1.227   ! wiz      14523: <td>mercurial</td>
        !          14524: </tr>
        !          14525: <tr>
1.215     wiz      14526: <td>meta</td>
1.227   ! wiz      14527: <td>meta-package</td>
1.156     leot     14528: </tr>
                   14529: <tr>
1.215     wiz      14530: <td>meta_package</td>
1.227   ! wiz      14531: <td>mit-krb5</td>
1.156     leot     14532: </tr>
                   14533: <tr>
1.215     wiz      14534: <td>mk.conf</td>
1.227   ! wiz      14535: <td>mkl</td>
1.177     leot     14536: </tr>
                   14537: <tr>
1.215     wiz      14538: <td>mount</td>
1.227   ! wiz      14539: <td>move</td>
1.159     rillig   14540: </tr>
                   14541: <tr>
1.226     gutterid 14542: <td>moved</td>
1.227   ! wiz      14543: <td>mprotect</td>
1.226     gutterid 14544: </tr>
                   14545: <tr>
1.215     wiz      14546: <td>mremap</td>
1.227   ! wiz      14547: <td>nb</td>
1.156     leot     14548: </tr>
                   14549: <tr>
1.215     wiz      14550: <td>nbcompat</td>
1.227   ! wiz      14551: <td>netlib</td>
1.156     leot     14552: </tr>
                   14553: <tr>
1.218     nia      14554: <td>node</td>
1.227   ! wiz      14555: <td>node.js</td>
1.218     nia      14556: </tr>
                   14557: <tr>
                   14558: <td>nodejs</td>
1.227   ! wiz      14559: <td>obstack</td>
1.218     nia      14560: </tr>
                   14561: <tr>
1.217     rillig   14562: <td>obstack_ptr_grow</td>
1.227   ! wiz      14563: <td>occurs</td>
1.205     wiz      14564: </tr>
                   14565: <tr>
1.217     rillig   14566: <td>only</td>
1.227   ! wiz      14567: <td>openblas</td>
1.156     leot     14568: </tr>
                   14569: <tr>
1.217     rillig   14570: <td>options</td>
1.227   ! wiz      14571: <td>options.mk</td>
1.161     leot     14572: </tr>
                   14573: <tr>
1.217     rillig   14574: <td>order</td>
1.227   ! wiz      14575: <td>override</td>
1.156     leot     14576: </tr>
                   14577: <tr>
1.217     rillig   14578: <td>override-intltool</td>
1.227   ! wiz      14579: <td>override-message-intltool</td>
1.156     leot     14580: </tr>
                   14581: <tr>
1.217     rillig   14582: <td>package</td>
1.227   ! wiz      14583: <td>parallel</td>
1.156     leot     14584: </tr>
                   14585: <tr>
1.217     rillig   14586: <td>path</td>
1.227   ! wiz      14587: <td>pax</td>
1.156     leot     14588: </tr>
                   14589: <tr>
1.217     rillig   14590: <td>paxctl</td>
1.227   ! wiz      14591: <td>pbulk-index</td>
1.156     leot     14592: </tr>
                   14593: <tr>
1.217     rillig   14594: <td>pc</td>
1.227   ! wiz      14595: <td>perl</td>
1.156     leot     14596: </tr>
                   14597: <tr>
1.217     rillig   14598: <td>perl5</td>
1.227   ! wiz      14599: <td>perms</td>
1.156     leot     14600: </tr>
                   14601: <tr>
1.217     rillig   14602: <td>php</td>
1.227   ! wiz      14603: <td>pkg-build-options</td>
1.156     leot     14604: </tr>
                   14605: <tr>
1.217     rillig   14606: <td>pkg-config</td>
1.227   ! wiz      14607: <td>pkg_build_options</td>
1.156     leot     14608: </tr>
                   14609: <tr>
1.217     rillig   14610: <td>platform</td>
1.227   ! wiz      14611: <td>plist</td>
1.156     leot     14612: </tr>
                   14613: <tr>
1.217     rillig   14614: <td>post-extract</td>
1.227   ! wiz      14615: <td>post-fetch</td>
1.156     leot     14616: </tr>
                   14617: <tr>
1.217     rillig   14618: <td>post-wrapper</td>
1.227   ! wiz      14619: <td>pre-build-checks-hook</td>
1.156     leot     14620: </tr>
                   14621: <tr>
1.217     rillig   14622: <td>pre-configure</td>
1.227   ! wiz      14623: <td>pre-configure-checks-hook</td>
1.156     leot     14624: </tr>
                   14625: <tr>
1.217     rillig   14626: <td>pre-extract</td>
1.227   ! wiz      14627: <td>pre-fetch</td>
1.174     leot     14628: </tr>
                   14629: <tr>
1.217     rillig   14630: <td>print-go-deps</td>
1.227   ! wiz      14631: <td>print-plist</td>
1.156     leot     14632: </tr>
                   14633: <tr>
1.217     rillig   14634: <td>print-summary-data</td>
1.227   ! wiz      14635: <td>privileged-install-hook</td>
1.156     leot     14636: </tr>
                   14637: <tr>
1.217     rillig   14638: <td>pypi</td>
1.227   ! wiz      14639: <td>python</td>
1.156     leot     14640: </tr>
                   14641: <tr>
1.217     rillig   14642: <td>r</td>
1.227   ! wiz      14643: <td>readme-all</td>
1.156     leot     14644: </tr>
                   14645: <tr>
1.222     gutterid 14646: <td>recursive</td>
1.227   ! wiz      14647: <td>recv</td>
1.156     leot     14648: </tr>
                   14649: <tr>
1.220     nia      14650: <td>recvfrom</td>
1.227   ! wiz      14651: <td>regcomp</td>
1.174     leot     14652: </tr>
                   14653: <tr>
1.220     nia      14654: <td>release-localbase-lock</td>
1.227   ! wiz      14655: <td>release-lock</td>
1.174     leot     14656: </tr>
                   14657: <tr>
1.220     nia      14658: <td>relro</td>
1.227   ! wiz      14659: <td>remove</td>
1.156     leot     14660: </tr>
                   14661: <tr>
1.226     gutterid 14662: <td>removed</td>
1.227   ! wiz      14663: <td>rename</td>
1.226     gutterid 14664: </tr>
                   14665: <tr>
                   14666: <td>renamed</td>
1.227   ! wiz      14667: <td>reorder</td>
1.226     gutterid 14668: </tr>
                   14669: <tr>
                   14670: <td>replace</td>
1.227   ! wiz      14671: <td>replace_interpreter</td>
1.156     leot     14672: </tr>
                   14673: <tr>
1.226     gutterid 14674: <td>reproducible</td>
1.227   ! wiz      14675: <td>resolv</td>
1.156     leot     14676: </tr>
                   14677: <tr>
1.226     gutterid 14678: <td>root</td>
1.227   ! wiz      14679: <td>ruby</td>
1.156     leot     14680: </tr>
                   14681: <tr>
1.226     gutterid 14682: <td>send</td>
1.227   ! wiz      14683: <td>sendfile</td>
1.174     leot     14684: </tr>
                   14685: <tr>
1.226     gutterid 14686: <td>sendto</td>
1.227   ! wiz      14687: <td>setenv</td>
1.156     leot     14688: </tr>
                   14689: <tr>
1.226     gutterid 14690: <td>setgid</td>
1.227   ! wiz      14691: <td>setprogname</td>
1.156     leot     14692: </tr>
                   14693: <tr>
1.226     gutterid 14694: <td>setuid</td>
1.227   ! wiz      14695: <td>sh</td>
1.156     leot     14696: </tr>
                   14697: <tr>
1.226     gutterid 14698: <td>shebang</td>
1.227   ! wiz      14699: <td>show</td>
1.156     leot     14700: </tr>
                   14701: <tr>
1.226     gutterid 14702: <td>show-all</td>
1.227   ! wiz      14703: <td>show-build-defs</td>
1.181     rillig   14704: </tr>
                   14705: <tr>
1.226     gutterid 14706: <td>show-depends</td>
1.227   ! wiz      14707: <td>show-depends-dirs</td>
1.156     leot     14708: </tr>
                   14709: <tr>
1.226     gutterid 14710: <td>show-depends-pkgpaths</td>
1.227   ! wiz      14711: <td>show-depends-recursive</td>
1.222     gutterid 14712: </tr>
                   14713: <tr>
1.226     gutterid 14714: <td>show-deps</td>
1.227   ! wiz      14715: <td>show-distfiles</td>
1.223     nia      14716: </tr>
                   14717: <tr>
1.226     gutterid 14718: <td>show-downlevel</td>
1.227   ! wiz      14719: <td>show-subdir-var</td>
1.156     leot     14720: </tr>
                   14721: <tr>
1.226     gutterid 14722: <td>show-tools</td>
1.227   ! wiz      14723: <td>show-var</td>
1.156     leot     14724: </tr>
                   14725: <tr>
1.226     gutterid 14726: <td>show-vars</td>
1.227   ! wiz      14727: <td>snprintf</td>
1.156     leot     14728: </tr>
                   14729: <tr>
1.226     gutterid 14730: <td>socket</td>
1.227   ! wiz      14731: <td>ssp</td>
1.156     leot     14732: </tr>
                   14733: <tr>
1.226     gutterid 14734: <td>st_mode</td>
1.227   ! wiz      14735: <td>stage-install</td>
1.174     leot     14736: </tr>
                   14737: <tr>
1.226     gutterid 14738: <td>strcasestr</td>
1.227   ! wiz      14739: <td>strict</td>
1.156     leot     14740: </tr>
                   14741: <tr>
1.226     gutterid 14742: <td>strip</td>
1.227   ! wiz      14743: <td>strndup</td>
1.156     leot     14744: </tr>
                   14745: <tr>
1.226     gutterid 14746: <td>strnlen</td>
1.227   ! wiz      14747: <td>strsep</td>
1.162     rillig   14748: </tr>
                   14749: <tr>
1.226     gutterid 14750: <td>subst</td>
1.227   ! wiz      14751: <td>substitutions</td>
1.156     leot     14752: </tr>
                   14753: <tr>
1.227   ! wiz      14754: <td>subversion</td>
1.226     gutterid 14755: <td>sun</td>
1.214     leot     14756: </tr>
                   14757: <tr>
1.225     gutterid 14758: <td>sunpro</td>
1.226     gutterid 14759: <td>sunwspro</td>
1.212     wiz      14760: </tr>
                   14761: <tr>
1.227   ! wiz      14762: <td>svn</td>
1.161     leot     14763: <td>symlink</td>
1.227   ! wiz      14764: </tr>
        !          14765: <tr>
1.226     gutterid 14766: <td>test</td>
1.227   ! wiz      14767: <td>test-env</td>
1.223     nia      14768: </tr>
                   14769: <tr>
1.226     gutterid 14770: <td>tex</td>
1.227   ! wiz      14771: <td>texlive</td>
1.161     leot     14772: </tr>
                   14773: <tr>
1.226     gutterid 14774: <td>tmp</td>
1.227   ! wiz      14775: <td>todo</td>
1.156     leot     14776: </tr>
                   14777: <tr>
1.223     nia      14778: <td>tool</td>
1.227   ! wiz      14779: <td>tools</td>
1.156     leot     14780: </tr>
                   14781: <tr>
1.223     nia      14782: <td>tools-libtool-m4-override</td>
1.227   ! wiz      14783: <td>transitive</td>
1.156     leot     14784: </tr>
                   14785: <tr>
1.222     gutterid 14786: <td>type</td>
1.227   ! wiz      14787: <td>ulimit</td>
1.156     leot     14788: </tr>
                   14789: <tr>
1.222     gutterid 14790: <td>undefined</td>
1.227   ! wiz      14791: <td>undo-replace</td>
1.156     leot     14792: </tr>
                   14793: <tr>
1.222     gutterid 14794: <td>unlimit</td>
1.227   ! wiz      14795: <td>unprivileged</td>
1.156     leot     14796: </tr>
                   14797: <tr>
1.222     gutterid 14798: <td>unprivileged-install-hook</td>
1.227   ! wiz      14799: <td>unstripped</td>
1.156     leot     14800: </tr>
                   14801: <tr>
1.222     gutterid 14802: <td>update</td>
1.227   ! wiz      14803: <td>updated</td>
1.156     leot     14804: </tr>
                   14805: <tr>
1.174     leot     14806: <td>upload</td>
1.227   ! wiz      14807: <td>upload-distfiles</td>
1.156     leot     14808: </tr>
                   14809: <tr>
1.157     leot     14810: <td>use_tools</td>
1.227   ! wiz      14811: <td>user</td>
1.156     leot     14812: </tr>
                   14813: <tr>
1.157     leot     14814: <td>utimes</td>
1.227   ! wiz      14815: <td>vasprintf</td>
1.156     leot     14816: </tr>
                   14817: <tr>
1.157     leot     14818: <td>verbose</td>
1.227   ! wiz      14819: <td>vsnprintf</td>
1.156     leot     14820: </tr>
                   14821: <tr>
1.157     leot     14822: <td>warn</td>
1.227   ! wiz      14823: <td>warning</td>
1.156     leot     14824: </tr>
                   14825: <tr>
1.157     leot     14826: <td>warnings</td>
1.227   ! wiz      14827: <td>warnx</td>
1.156     leot     14828: </tr>
                   14829: <tr>
1.174     leot     14830: <td>wattr_off</td>
1.227   ! wiz      14831: <td>wattr_on</td>
1.156     leot     14832: </tr>
                   14833: <tr>
1.174     leot     14834: <td>work</td>
1.227   ! wiz      14835: <td>wrapper</td>
1.156     leot     14836: </tr>
                   14837: <tr>
1.174     leot     14838: <td>wrkdir</td>
1.227   ! wiz      14839: <td> </td>
1.156     leot     14840: </tr>
                   14841: </table>
1.154     rillig   14842: </div>
                   14843: <div class="appendix">
                   14844: <div class="titlepage"><div><div><h1 class="title">
1.207     leot     14845: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  14846: <div class="toc">
                   14847: <p><b>Table of Contents</b></p>
1.100     leot     14848: <dl class="toc">
1.207     leot     14849: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   14850: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1       dsieger  14851: </dl>
                   14852: </div>
                   14853: <p>This section contains information on editing the pkgsrc
                   14854:        guide itself.</p>
1.41      asau     14855: <div class="sect1">
1.1       dsieger  14856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207     leot     14857: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1       dsieger  14858: <p>The pkgsrc guide's source code is stored in
                   14859:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   14860:        are created from it:</p>
1.41      asau     14861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      14862: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   14863: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174     leot     14864: <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>
                   14865: <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.1       dsieger  14866:        The PDF version of the pkgsrc guide.</p></li>
1.174     leot     14867: <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.1       dsieger  14868:        PostScript version of the pkgsrc guide.</p></li>
                   14869: </ul></div>
                   14870: </div>
1.41      asau     14871: <div class="sect1">
1.1       dsieger  14872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207     leot     14873: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1       dsieger  14874: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      14875: <div class="procedure"><ol class="procedure" type="1">
1.190     bacon    14876: <li class="step"><p>Make sure you have checked out the htdocs repository
                   14877:        into a sibling directory of your pkgsrc directory.  You will need
                   14878:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.41      asau     14879: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  14880:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   14881:        documentation) installed. These are automatically installed when
1.207     leot     14882:        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.41      asau     14883: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  14884:        right directory. All further steps will take place
                   14885:        here.</p></li>
1.41      asau     14886: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  14887:        <code class="filename">files/</code>.</p></li>
1.41      asau     14888: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  14889:        guide for valid XML and to build the final output files. If you
                   14890:        get any errors at this stage, you can just edit the files, as
                   14891:        there are only symbolic links in the working directory, pointing
                   14892:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     14893: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  14894:        commit)</strong></span></p></li>
1.41      asau     14895: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  14896:        regenerate the output files with the proper RCS
                   14897:        Ids.</p></li>
1.41      asau     14898: <li class="step">
1.10      hubertf  14899: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  14900:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   14901:        <code class="filename">htdocs</code>.</p>
1.41      asau     14902: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  14903: <h3 class="title">Note</h3>
                   14904: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  14905:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   14906:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  14907:        directory.</p>
                   14908: </div>
                   14909: </li>
                   14910: </ol></div>
                   14911: </div>
                   14912: </div>
                   14913: </div></body>
                   14914: </html>

CVSweb <webmaster@jp.NetBSD.org>