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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.328     jnemeth    33: <div><p class="copyright">Copyright © 1994-2022 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.41 2022/01/01 06:45:38 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia        88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                     92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig     94: </dl></dd>
1.267     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     96: <dd><dl>
1.267     rillig     97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig    100: </dl></dd>
                    101: </dl></dd>
1.267     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    103: <dd><dl>
1.267     rillig    104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       108: <dd><dl>
1.267     rillig    109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       112: </dl></dd>
1.267     rillig    113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    115: </dl></dd>
1.267     rillig    116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    117: <dd><dl>
1.267     rillig    118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    119: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    120: </dl></dd>
1.267     rillig    121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    122: builds)</a></span></dt>
1.75      rillig    123: <dd><dl>
1.267     rillig    124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    129: <dd><dl>
1.294     rillig    130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    131: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig    132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    140: </dl></dd>
                    141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    143: </dl></dd>
                    144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    145: <dd><dl>
                    146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    150: <dd><dl>
                    151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    158: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    160: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       161: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.336     nia       163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     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.75      rillig    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.267     rillig    173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    175: <dd><dl>
1.299     rillig    176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    179: <dd><dl>
1.299     rillig    180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    185: </dl></dd>
1.299     rillig    186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    188: <dd><dl>
                    189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    192: </dl></dd>
                    193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    195: </dl></dd>
1.299     rillig    196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    197: <dd><dl>
1.299     rillig    198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    203: <dd><dl>
1.299     rillig    204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    206: </dl></dd>
1.299     rillig    207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    219: </dl></dd>
                    220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    221: <dd><dl>
                    222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    223: <dd><dl>
1.334     nia       224: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                    225: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                    226: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig    227: </dl></dd>
1.299     rillig    228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    229: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig    230: </dl></dd>
1.299     rillig    231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    232: <dd><dl>
1.299     rillig    233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    237: <dd><dl>
1.299     rillig    238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    240: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    242: </dl></dd>
                    243: </dl></dd>
1.299     rillig    244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    245: <dd><dl>
1.299     rillig    246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    247: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    250: </dl></dd>
1.299     rillig    251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    252: <dd><dl>
1.299     rillig    253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    256: </dl></dd>
                    257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    258: <dd><dl>
                    259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    260: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    261: <dd><dl>
1.299     rillig    262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       264:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    265:       and
                    266:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    267:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    268: </dl></dd>
1.299     rillig    269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    270: <dd><dl>
                    271: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    273: </dl></dd>
                    274: </dl></dd>
                    275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig    276: <dd><dl>
1.299     rillig    277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig    286: </dl></dd>
1.299     rillig    287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    290: <dd><dl>
                    291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig    293: </dl></dd>
1.299     rillig    294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig    295: <dd><dl>
1.299     rillig    296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                    298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                    300: </dl></dd>
                    301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    312: <dd><dl>
                    313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338   ! nia       336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267     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.320     wiz       342: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338   ! 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.267     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.287     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.267     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.318     nia       363: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     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.318     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.87      wiz       373:     emulation</a></span></dt>
1.318     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.77      rillig    376: </dl></dd>
1.267     rillig    377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    378: </dl></dd>
1.299     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.267     rillig    386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    387: <dd><dl>
1.267     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.75      rillig    398: </dl></dd>
                    399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    400: <dd><dl>
1.299     rillig    401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    402: <dd><dl>
1.299     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.81      rillig    406: <dd><dl>
1.299     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.81      rillig    409: </dl></dd>
1.299     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.75      rillig    412: <dd><dl>
1.299     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.75      rillig    415: </dl></dd>
1.299     rillig    416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig    417: <dd><dl>
1.299     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.75      rillig    420: </dl></dd>
                    421: </dl></dd>
1.299     rillig    422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig    423: <dd><dl>
1.299     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.75      rillig    426: <dd><dl>
1.299     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.75      rillig    429: </dl></dd>
                    430: </dl></dd>
1.299     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.75      rillig    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.287     rillig    441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    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.322     leot      445: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75      rillig    446: <dd><dl>
1.322     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.75      rillig    471: </dl></dd>
1.322     leot      472: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76      rillig    473: <dd><dl>
1.322     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.261     leot      479: <code class="filename">stable</code>,
1.128     wiz       480: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    481: source packages</a></span></dt>
                    482: </dl></dd>
1.322     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.75      rillig    485: <dd><dl>
1.322     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.75      rillig    488: </dl></dd>
                    489: </dl>
                    490: </div>
1.82      rillig    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.299     rillig    496: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      497: </dt>
1.299     rillig    498: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      499: </dt>
1.82      rillig    500: </dl>
                    501: </div>
1.148     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.75      rillig    505: <div class="toc">
                    506: <p><b>Table of Contents</b></p>
1.210     leot      507: <dl class="toc">
1.75      rillig    508: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    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>
1.75      rillig    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>
1.88      wiz       515: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    516: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    517: </dl>
                    518: </div>
1.148     asau      519: <div class="sect1">
1.75      rillig    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>
1.82      rillig    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>
1.75      rillig    529: <p>pkgsrc currently contains several thousand packages,
                    530:       including:</p>
1.148     asau      531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     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.75      rillig    533:          web server</p></li>
1.322     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.75      rillig    535:          web browser</p></li>
1.322     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.75      rillig    537:          Desktop Environment</p></li>
1.322     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.75      rillig    539:          Desktop Environment</p></li>
                    540: </ul></div>
1.219     rillig    541: <p>&#8230; just to name a few.</p>
1.75      rillig    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.148     asau      545: <div class="sect2">
1.82      rillig    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.148     asau      551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       552: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    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.128     wiz       558: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    559:   including binaries, libraries, man pages and other
                    560:   documentation.</p></li>
1.214     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.128     wiz       565: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    566:   consists of highly portable code. This allows the greatest speed of
1.132     spz       567:   development when porting to a new platform. This portability also
1.82      rillig    568:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    569:   platforms</em></span>.</p></li>
1.128     wiz       570: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    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.128     wiz       574: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    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>
1.91      rillig    580: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      581: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     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.126     jakllsch  583: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    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.322     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.91      rillig    587: of shell scripts), and post-installation checks (installed files,
                    588: references to shared libraries, script interpreters).</p></li>
1.128     wiz       589: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  590: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    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>
1.82      rillig    594: </div>
1.148     asau      595: <div class="sect2">
1.82      rillig    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>
1.75      rillig    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>
1.82      rillig    605: <div class="table">
                    606: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       607: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    608: <colgroup>
                    609: <col>
                    610: <col>
1.202     sevan     611: <col>
1.82      rillig    612: </colgroup>
                    613: <thead><tr>
                    614: <th>Platform</th>
                    615: <th>Date Support Added</th>
1.202     sevan     616: <th>Notes</th>
1.82      rillig    617: </tr></thead>
                    618: <tbody>
                    619: <tr>
1.289     leot      620: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    621: <td align="center">Aug 1997</td>
1.202     sevan     622: <td class="auto-generated"> </td>
1.82      rillig    623: </tr>
                    624: <tr>
1.110     hubertf   625: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    626: <td align="center">Mar 1999</td>
1.264     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.82      rillig    628: </tr>
                    629: <tr>
1.289     leot      630: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    631: <td align="center">Jun 1999</td>
1.264     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.82      rillig    633: </tr>
                    634: <tr>
                    635: <td>
1.230     sevan     636:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    637:         </td>
                    638: <td align="center">Oct 2001</td>
1.305     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.82      rillig    640: </tr>
                    641: <tr>
1.289     leot      642: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    643: <td align="center">Nov 2002</td>
1.264     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.82      rillig    645: </tr>
                    646: <tr>
1.289     leot      647: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    648: <td align="center">Nov 2002</td>
1.264     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.82      rillig    650: </tr>
                    651: <tr>
1.289     leot      652: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    653: <td align="center">Dec 2002</td>
1.202     sevan     654: <td>
1.264     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.202     sevan     657:        </td>
1.82      rillig    658: </tr>
                    659: <tr>
                    660: <td>BSD/OS</td>
                    661: <td align="center">Dec 2003</td>
1.202     sevan     662: <td class="auto-generated"> </td>
1.82      rillig    663: </tr>
                    664: <tr>
1.289     leot      665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    666: <td align="center">Dec 2003</td>
1.264     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.82      rillig    668: </tr>
                    669: <tr>
                    670: <td>
1.289     leot      671:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    672:           (Microsoft Windows Services for Unix)
                    673:         </td>
                    674: <td align="center">Mar 2004</td>
1.264     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.82      rillig    676: </tr>
                    677: <tr>
1.289     leot      678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    679: <td align="center">Oct 2004</td>
1.202     sevan     680: <td class="auto-generated"> </td>
1.82      rillig    681: </tr>
                    682: <tr>
1.110     hubertf   683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    684: <td align="center">Nov 2004</td>
1.264     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.82      rillig    686: </tr>
1.98      wiz       687: <tr>
1.289     leot      688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       689: <td align="center">Apr 2007</td>
1.264     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.98      wiz       691: </tr>
1.128     wiz       692: <tr>
1.289     leot      693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       694: <td align="center">Sep 2010</td>
1.264     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.128     wiz       696: </tr>
1.151     obache    697: <tr>
1.289     leot      698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  699: <td align="center">Jan 2011</td>
1.202     sevan     700: <td class="auto-generated"> </td>
1.151     obache    701: </tr>
                    702: <tr>
1.289     leot      703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    704: <td align="center">Nov 2011</td>
1.264     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.151     obache    706: </tr>
                    707: <tr>
1.289     leot      708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    709: <td align="center">Mar 2013</td>
1.264     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.151     obache    711: </tr>
1.166     jnemeth   712: <tr>
1.289     leot      713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   714: <td align="center">Jul 2013</td>
1.264     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.166     jnemeth   716: </tr>
1.214     sevan     717: <tr>
1.289     leot      718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     719: <td align="center">Jun 2014</td>
1.264     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.214     sevan     721: </tr>
1.82      rillig    722: </tbody>
1.91      rillig    723: </table></div>
1.82      rillig    724: </div>
1.91      rillig    725: <br class="table-break">
1.82      rillig    726: </div>
1.75      rillig    727: </div>
1.148     asau      728: <div class="sect1">
1.75      rillig    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.110     hubertf   732:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    733:        describes how one can use one of the packages in the Package
                    734:        Collection, either by installing a precompiled binary package,
1.93      rillig    735:        or by building one's own copy using the NetBSD package system.
1.110     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.75      rillig    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.110     hubertf   739:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    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.110     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.75      rillig    744: </div>
1.148     asau      745: <div class="sect1">
1.75      rillig    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.128     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.75      rillig    750:       terminology used within this document.</p>
1.148     asau      751: <div class="variablelist"><dl class="variablelist">
1.75      rillig    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.236     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.75      rillig    760: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       761: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       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>
1.75      rillig    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
1.76      rillig    774:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    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.128     wiz       778:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    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
1.76      rillig    783:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    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
1.76      rillig    787:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       788:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       789: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    790:            especially in the context of precompiled packages.</p>
                    791: </dd>
                    792: <dt><span class="term">Program</span></dt>
1.88      wiz       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>
1.75      rillig    796: </dl></div>
1.148     asau      797: <div class="sect2">
1.75      rillig    798: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      800: <div class="variablelist"><dl class="variablelist">
1.75      rillig    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.128     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.75      rillig    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.110     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.75      rillig    812:        documentation.</p>
                    813: </dd>
                    814: <dt><span class="term">package maintainers</span></dt>
                    815: <dd><p>A
1.110     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.75      rillig    817: <dt><span class="term">infrastructure developers</span></dt>
                    818: <dd><p>These people are involved in all those files
1.76      rillig    819:        that live in the <code class="filename">mk/</code> directory and below.
1.110     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.75      rillig    821:        too.</p></dd>
                    822: </dl></div>
                    823: </div>
                    824: </div>
1.148     asau      825: <div class="sect1">
1.75      rillig    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.128     wiz       830:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     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.75      rillig    834: </div>
                    835: </div>
1.148     asau      836: <div class="part">
1.75      rillig    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.210     leot      841: <dl class="toc">
1.267     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.75      rillig    844: <dd><dl>
1.267     rillig    845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    846: <dd><dl>
1.267     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.75      rillig    849: </dl></dd>
1.267     rillig    850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    851: <dd><dl>
1.267     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.75      rillig    854: </dl></dd>
                    855: </dl></dd>
1.267     rillig    856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    857: <dd><dl>
1.267     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.75      rillig    860: </dl></dd>
1.267     rillig    861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    862: <dd><dl>
1.267     rillig    863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    864: <dd><dl>
1.267     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.317     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.75      rillig    873: </dl></dd>
1.267     rillig    874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    875: <dd><dl>
1.267     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.75      rillig    879: </dl></dd>
                    880: </dl></dd>
1.267     rillig    881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    882: <dd><dl>
1.267     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.88      wiz       887: <dd><dl>
1.267     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.88      wiz       891: </dl></dd>
1.267     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.75      rillig    894: </dl></dd>
1.267     rillig    895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    896: <dd><dl>
1.267     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.106     rillig    899: </dl></dd>
1.267     rillig    900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    901: builds)</a></span></dt>
1.75      rillig    902: <dd><dl>
1.267     rillig    903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     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.293     rillig    907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    908: <dd><dl>
1.294     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.296     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.293     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.267     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.128     wiz       940: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     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.336     nia       942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     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.75      rillig    948: </dl></dd>
                    949: </dl>
                    950: </div>
1.148     asau      951: <div class="chapter">
1.75      rillig    952: <div class="titlepage"><div><div><h2 class="title">
1.267     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.322     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.267     rillig    969: </li>
                    970: <li class="listitem"><p>
1.278     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.267     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.75      rillig    997: <div class="toc">
                    998: <p><b>Table of Contents</b></p>
1.210     leot      999: <dl class="toc">
1.267     rillig   1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig   1001: <dd><dl>
1.267     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.75      rillig   1004: </dl></dd>
1.267     rillig   1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig   1006: <dd><dl>
1.267     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.75      rillig   1009: </dl></dd>
                   1010: </dl>
                   1011: </div>
1.91      rillig   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.148     asau     1020: <div class="sect1">
1.75      rillig   1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   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.329     leot     1029:        <code class="literal">2021Q4</code>.</p>
1.75      rillig   1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     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.157     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.148     asau     1035: <div class="sect2">
1.75      rillig   1036: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1038: <p>The primary download location for all pkgsrc files is
1.264     sevan    1039:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     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.322     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.157     asau     1044: <p>The tar archive for the current branch is in the directory
1.264     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.230     sevan    1046:        It is autogenerated weekly.</p>
1.157     asau     1047: <p>To save download time we provide bzip2- and
                   1048:        xz-compressed archives which are published at
1.264     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.157     asau     1050:        and
1.264     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.157     asau     1052:        respectively.
                   1053:        </p>
                   1054: <p>You can fetch the same files using FTP.</p>
1.329     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.249     leot     1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1058: <pre class="screen">
1.329     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.188     snj      1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1061:        or your web browser.</p>
1.112     weinem   1062: <p>Then, extract it with:</p>
1.188     snj      1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     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.75      rillig   1069: </div>
1.148     asau     1070: <div class="sect2">
1.75      rillig   1071: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.329     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.128     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.146     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       grant    1081: </pre>
1.289     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.128     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.146     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.128     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.101     rillig   1099: <pre class="programlisting">
                   1100: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1101: cvs -q
1.101     rillig   1102: checkout -P
1.103     wiz      1103: update -dP
                   1104: diff -upN
1.101     rillig   1105: rdiff -u
1.128     wiz      1106: release -d
1.101     rillig   1107: </pre>
1.75      rillig   1108: </div>
                   1109: </div>
1.148     asau     1110: <div class="sect1">
1.75      rillig   1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   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.148     asau     1117: <div class="sect2">
1.75      rillig   1118: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1119: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1121: <h3 class="title">Warning</h3>
1.77      rillig   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>
1.75      rillig   1129: </div>
1.82      rillig   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.188     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.82      rillig   1134:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     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.75      rillig   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.148     asau     1141: <div class="sect2">
1.75      rillig   1142: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     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.148     asau     1150: <div class="sect3">
1.75      rillig   1151: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   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.128     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.75      rillig   1158:        back to the stable branch, add the
1.329     leot     1159:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2021Q4</span>&#8221;</span> option.</p>
1.75      rillig   1160: </div>
1.148     asau     1161: <div class="sect3">
1.75      rillig   1162: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   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.128     wiz      1170:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1171: </div>
                   1172: </div>
                   1173: </div>
                   1174: </div>
1.148     asau     1175: <div class="chapter">
1.75      rillig   1176: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1178: <div class="toc">
                   1179: <p><b>Table of Contents</b></p>
1.210     leot     1180: <dl class="toc">
1.267     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.75      rillig   1183: </dl>
                   1184: </div>
1.148     asau     1185: <div class="sect1">
1.75      rillig   1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     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.82      rillig   1189: </div>
1.148     asau     1190: <div class="sect1">
1.82      rillig   1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1193: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1194:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1195:     to privileged one all programs are installed under one particular user
1.149     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.82      rillig   1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1200: <pre class="screen">
1.167     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.75      rillig   1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1204:     </pre>
1.149     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.230     sevan    1209:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     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.230     sevan    1215:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     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.148     asau     1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1222: <h3 class="title">Note</h3>
1.110     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.128     wiz      1226:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1227: </div>
1.149     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.75      rillig   1236: </div>
                   1237: </div>
1.148     asau     1238: <div class="chapter">
1.75      rillig   1239: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1241: <div class="toc">
                   1242: <p><b>Table of Contents</b></p>
1.210     leot     1243: <dl class="toc">
1.267     rillig   1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1245: <dd><dl>
1.267     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.317     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.267     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.75      rillig   1260: </dl></dd>
                   1261: </dl>
                   1262: </div>
                   1263: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1264: is to only install the package tools and to use binary packages
1.128     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.88      wiz      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.148     asau     1269: <div class="sect1">
1.75      rillig   1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317     nia      1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1273:   site and mirrors, there are collections of binary packages,
1.109     rillig   1274:   ready to be installed. These binary packages have been built using the
                   1275:   default settings for the directories, that is:</p>
1.148     asau     1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     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.109     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.267     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.148     asau     1284: <div class="sect2">
1.75      rillig   1285: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     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.317     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.105     weinem   1290: <p>This directory contains binary packages for multiple
                   1291:     platforms. First, select your operating system. (Ignore the
                   1292:     directories with version numbers attached to it, they just exist for
                   1293:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1294:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1295: <p>In this directory, you often find a file called
                   1296:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1297:     management tools. If the file is missing, it is likely that your
                   1298:     operating system already provides those tools. Download the file and
                   1299:     extract it in the <code class="filename">/</code> directory. It will create
                   1300:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1301:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1302: </div>
1.148     asau     1303: <div class="sect2">
1.75      rillig   1304: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1305: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1306: <p>In the directory from the last section, there is a
1.196     wiz      1307:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1308:     binary packages that are available for the platform, excluding those
1.317     nia      1309:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1310: <p>To install packages directly from an FTP or HTTP server, run
                   1311:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1312:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1313: <pre class="screen">
1.317     nia      1314: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1316: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109     rillig   1317: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317     nia      1318: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1319: </pre>
                   1320: <p>Instead of URLs, you can also use local paths, for example if
                   1321:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1322:     repository. If you want to install packages from multiple sources,
                   1323:     you can separate them by a semicolon in
                   1324:     <code class="varname">PKG_PATH</code>.</p>
                   1325: <p>After these preparations, installing a package is very
                   1326:     easy:</p>
                   1327: <pre class="screen">
1.317     nia      1328: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1329: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1330: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1331: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1332: </pre>
                   1333: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1334:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1335: <p>Any prerequisite packages needed to run the
1.88      wiz      1336:     package in question will be installed, too, assuming they are
1.317     nia      1337:     present in the repository.</p>
1.75      rillig   1338: <p>After you've installed packages, be sure to have
1.88      wiz      1339:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1340:     <code class="varname">PATH</code> so you can actually start the just
                   1341:     installed program.</p>
1.75      rillig   1342: </div>
1.148     asau     1343: <div class="sect2">
1.75      rillig   1344: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1345: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
                   1346: <p>To update binary packages, it is recommended that you use
                   1347:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1348:     package repository to your locally installed packages and safely
                   1349:     replace any older packages.</p>
                   1350: <p>Note that pkgsrc is released as quarterly branches.
                   1351:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1352:     need to adjust the repository in
                   1353:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1354: </div>
                   1355: <div class="sect2">
                   1356: <div class="titlepage"><div><div><h3 class="title">
                   1357: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1358: <p>To deinstall a package, it does not matter whether it was
1.317     nia      1359:     installed from source code or from a binary package. Neither the
                   1360:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1361:     command need to know.</p>
                   1362: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1363:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317     nia      1364:     name can be given with or without version number.</p>
1.82      rillig   1365: </div>
1.148     asau     1366: <div class="sect2">
1.82      rillig   1367: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1368: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1369: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317     nia      1370:     installed packages or binary package files.
                   1371:     As with other management tools, it works with packages installed
                   1372:     from source or binaries.</p>
1.82      rillig   1373: </div>
1.148     asau     1374: <div class="sect2">
1.82      rillig   1375: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1376: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1377: <p>
1.279     leot     1378:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317     nia      1379:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1380:       included in pkgsrc.  The list is available from the NetBSD
1.317     nia      1381:       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>.
                   1382:     </p>
                   1383: <p>
                   1384:       Please note that not every "vulnerability" with a CVE assignment is
                   1385:       exploitable in every configuration.
                   1386:       Some bugs are marked as active simply because an fix was not
                   1387:       marked as such.
                   1388:       Operating system specific hardening and mitigation features may also
                   1389:       reduce the impact of bugs.
1.88      wiz      1390:     </p>
1.82      rillig   1391: <p>
1.125     wiz      1392:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1393:       this list can be downloaded
                   1394:       automatically, and a security audit of all packages installed on a system
                   1395:       can take place.
                   1396:     </p>
1.82      rillig   1397: <p>
1.125     wiz      1398:       There are two components to auditing.  The first
                   1399:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1400:       is for downloading
1.88      wiz      1401:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1402:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1403:       installed packages are vulnerable.  If a package is vulnerable, you
                   1404:       will see output similar to the following:
                   1405:     </p>
1.82      rillig   1406: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1407:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1408: <p>
1.125     wiz      1409:       You may wish to have the
1.317     nia      1410:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1411:       file downloaded daily so that
                   1412:       it remains current.  This may be done by adding an appropriate entry
1.322     leot     1413:       to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1414:       </p>
                   1415: <pre class="screen">
1.233     sevan    1416: # Download vulnerabilities file
1.230     sevan    1417: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1418: # Audit the installed packages and email results to root
                   1419: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1420:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1421:       </pre>
                   1422: <p>
1.230     sevan    1423:       will update the vulnerability list every day at 3AM, followed by an audit
                   1424:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1425: 
1.230     sevan    1426:       On NetBSD this may be accomplished instead by adding the following
                   1427:       line to <code class="filename">/etc/daily.conf</code>:
                   1428:       </p>
                   1429: <pre class="screen">
                   1430: fetch_pkg_vulnerabilities=YES
                   1431:       </pre>
                   1432: <p>
                   1433:       to fetch the vulnerability list from the daily security script. The system
                   1434:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1435:       desired (not required), by adding the following line to
1.230     sevan    1436: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1437:       </p>
                   1438: <pre class="screen">
1.230     sevan    1439: check_pkg_vulnerabilities=YES
1.125     wiz      1440:       </pre>
                   1441: <p>
1.322     leot     1442:       see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1443:     </p>
1.82      rillig   1444: </div>
1.148     asau     1445: <div class="sect2">
1.82      rillig   1446: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1447: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82      rillig   1448: <p>
1.322     leot     1449:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1450:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.317     nia      1451:       argument to check if any packages are stale, e.g.
1.88      wiz      1452:     </p>
                   1453: <pre class="screen">
                   1454: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1455: ...
1.88      wiz      1456: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1457:     </pre>
1.82      rillig   1458: </div>
1.148     asau     1459: <div class="sect2">
1.82      rillig   1460: <div class="titlepage"><div><div><h3 class="title">
1.317     nia      1461: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1462: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1463:     administrative functions on the package system.</p>
1.82      rillig   1464: </div>
1.75      rillig   1465: </div>
1.148     asau     1466: <div class="sect1">
1.75      rillig   1467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1468: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1469: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1470:   directory now contains a set of packages, organized into
                   1471:   categories. You can browse the online index of packages, or run
1.110     hubertf  1472:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1473:   directory to build local <code class="filename">README.html</code> files for
1.322     leot     1474:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1475: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1476:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1477:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1478:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1479:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1480:   system (inside a chroot is an exception). </p>
                   1481: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1482:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1483:   instructions how to create your own packages.</p>
1.148     asau     1484: <div class="sect2">
1.75      rillig   1485: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1486: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1487: <p>To build packages from source, you need a working C
1.88      wiz      1488:     compiler. On NetBSD, you need to install the
1.128     wiz      1489:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1490:     sets. If you want to build X11-related packages, the
1.128     wiz      1491:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1492:     sets are required, too.</p>
1.75      rillig   1493: </div>
1.148     asau     1494: <div class="sect2">
1.75      rillig   1495: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1496: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1497: <p>The first step for building a package is downloading the
1.88      wiz      1498:     distfiles (i.e. the unmodified source). If they have not yet been
                   1499:     downloaded, pkgsrc will fetch them automatically.</p>
                   1500: <p>If you have all files that you need in the
                   1501:     <code class="filename">distfiles</code> directory,
                   1502:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1503:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1504:     </p>
1.82      rillig   1505: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1506: <p>
1.110     hubertf  1507:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1508: <p>By default a list of distribution sites will be randomly
                   1509:     intermixed to prevent huge load on servers which holding popular
                   1510:     packages (for example, SourceForge.net mirrors). Thus, every
                   1511:     time when you need to fetch yet another distfile all the mirrors
                   1512:     will be tried in new (random) order. You can turn this feature
                   1513:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1514:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1515: <p>You can overwrite some of the major distribution sites to
                   1516:     fit to sites that are close to your own.  By setting one or two
                   1517:     variables you can modify the order in which the master sites are
                   1518:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1519:     delimited list of domain suffixes.
                   1520:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1521:     contains a whitespace delimited list of regular expressions.  It
                   1522:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1523:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1524:     some examples.  This may save some of your bandwidth and
                   1525:     time.</p>
1.75      rillig   1526: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1527:     if you want to keep the settings, by editing the
1.110     hubertf  1528:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1529:     and adding the definitions there.</p>
1.82      rillig   1530: <p>
1.88      wiz      1531:       If a package depends on many other packages (such as
1.322     leot     1532:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1533:       alternate between periods of
                   1534:       downloading source, and compiling. To ensure you have all the source
                   1535:       downloaded initially you can run the command:
                   1536:       </p>
1.82      rillig   1537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1538: <p>
1.88      wiz      1539:       which will output and run a set of shell commands to fetch the
                   1540:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1541:       also choose to download the files manually.
                   1542:     </p>
1.75      rillig   1543: </div>
1.148     asau     1544: <div class="sect2">
1.75      rillig   1545: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1546: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1547: <p>
1.88      wiz      1548:       Once the software has downloaded, any patches will be applied, then it
                   1549:       will be compiled for you. This may take some time depending on your
                   1550:       computer, and how many other packages the software depends on and their
                   1551:       compile time.
                   1552:     </p>
1.148     asau     1553: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1554: <h3 class="title">Note</h3>
                   1555: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1556:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1557:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1558: </div>
1.87      wiz      1559: <p>For example, type</p>
1.88      wiz      1560: <pre class="screen">
                   1561: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1562: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1563:     </pre>
1.75      rillig   1564: <p>at the shell prompt to build the various components of the
1.88      wiz      1565:     package.</p>
1.82      rillig   1566: <p>The next stage is to actually install the newly compiled
1.88      wiz      1567:     program onto your system. Do this by entering:
1.82      rillig   1568: 
1.88      wiz      1569:     </p>
1.82      rillig   1570: <pre class="screen">
1.88      wiz      1571: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1572:     </pre>
1.82      rillig   1573: <p>
                   1574: 
1.88      wiz      1575:     while you are still in the directory for whatever package you
                   1576:     are installing.</p>
1.82      rillig   1577: <p>Installing the package on your system may require you to
1.88      wiz      1578:     be root.  However, pkgsrc has a
                   1579:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1580:     to only become root for the actual installation step.</p>
1.82      rillig   1581: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1582:     You can now enter:
1.82      rillig   1583: 
1.88      wiz      1584:     </p>
1.82      rillig   1585: <pre class="screen">
1.88      wiz      1586: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1587:     </pre>
1.82      rillig   1588: <p>
                   1589: 
1.88      wiz      1590:     to remove the compiled files in the work directory, as you shouldn't need
                   1591:     them any more. If other packages were also added to your system
                   1592:     (dependencies) to allow your program to compile, you can tidy these up
                   1593:     also with the command:</p>
1.82      rillig   1594: <pre class="screen">
1.88      wiz      1595: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1596:     </pre>
1.75      rillig   1597: <p>Taking the figlet utility as an example, we can install it on our
1.322     leot     1598:     system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88      wiz      1599: <p>The program is installed under the default root of the
                   1600:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1601:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1602:     variable in your environment, and it will use that value as the
                   1603:     root of your packages tree. So, to use
                   1604:     <code class="filename">/usr/local</code>, set
                   1605:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1606:     Please note that you should use a directory which is dedicated to
                   1607:     packages and not shared with other programs (i.e., do not try and
                   1608:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1609:     to add any of your own files or directories (such as
                   1610:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1611:     <code class="filename">pkgsrc/</code>) below the
                   1612:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1613:     conflicts between programs and other files installed by the
                   1614:     package system and whatever else may have been installed
                   1615:     there.</p>
1.110     hubertf  1616: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1617:     alter some configuration options at build time.  Have a look at
                   1618:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1619:     of what will be set there by default.  Environment variables such
                   1620:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1621:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1622:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1623: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1624:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1625:     or being installed. This may be for debugging purposes, or out of
                   1626:     simple curiosity. A number of utility values have been added to
                   1627:     help with this.</p>
1.128     wiz      1628: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1629: <li class="listitem">
1.322     leot     1630: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1631:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1632:        information will be displayed. For example,</p>
1.75      rillig   1633: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1634: <p>will show all the commands that are invoked, up to and
1.128     wiz      1635:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1636: </li>
1.128     wiz      1637: <li class="listitem">
1.322     leot     1638: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1639:        definition, then the <code class="varname">VARNAME</code> definition
                   1640:        should be used, in conjunction with the show-var
1.322     leot     1641:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1642:        variable <code class="varname">LOCALBASE</code>:</p>
                   1643: <pre class="screen">
                   1644: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1645: /usr/pkg
                   1646: <code class="prompt">%</code>
1.88      wiz      1647:        </pre>
1.75      rillig   1648: </li>
                   1649: </ol></div>
                   1650: <p>If you want to install a binary package that you've either
1.88      wiz      1651:     created yourself (see next section), that you put into
                   1652:     pkgsrc/packages manually or that is located on a remote FTP
                   1653:     server, you can use the "bin-install" target. This target will
1.322     leot     1654:     install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1655:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1656:     sites searched is kept in the variable
                   1657:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.322     leot     1658:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1659:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1660:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1661:     details.</p>
                   1662: <p>A final word of warning: If you set up a system that has a
                   1663:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1664:     set that before any packages are installed, as you cannot use
                   1665:     several directories for the same purpose. Doing so will result in
                   1666:     pkgsrc not being able to properly detect your installed packages,
                   1667:     and fail miserably. Note also that precompiled binary packages are
                   1668:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1669:     <code class="filename">/usr/pkg</code>, and that you should
                   1670:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1671:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1672: </div>
                   1673: </div>
                   1674: </div>
1.148     asau     1675: <div class="chapter">
1.75      rillig   1676: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1677: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1678: <div class="toc">
                   1679: <p><b>Table of Contents</b></p>
1.210     leot     1680: <dl class="toc">
1.267     rillig   1681: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1682: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1683: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1684: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1685: <dd><dl>
                   1686: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1687: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1688: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1689: </dl></dd>
1.267     rillig   1690: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1691: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1692: </dl>
                   1693: </div>
1.104     rillig   1694: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1695: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1696: that file depends on the installation. On NetBSD, when you use
1.322     leot     1697: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1698: <code class="filename">/etc/</code>. In all other cases the default location is
                   1699: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1700: bootstrap program to install the binary packages.</p>
                   1701: <p>The format of the configuration file is that of the usual
                   1702: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1703: is done by setting variables in this file. Note that you can define all
                   1704: kinds of variables, and no special error checking (for example for
1.223     rillig   1705: spelling mistakes) takes place.</p>
1.148     asau     1706: <div class="sect1">
1.75      rillig   1707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1708: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1709: <p>The following variables apply to all
1.89      rillig   1710:     pkgsrc packages. A complete list of the variables that can be
                   1711:     configured by the user is available in
                   1712:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1713:     comments that describe each variable's intent.</p>
1.148     asau     1714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1715: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1716:            packages will be installed. The default is
1.76      rillig   1717:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1718:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1719: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1720:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1721:            installed. The default is
1.76      rillig   1722:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1723: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1724:            X11 is installed on the system. The default is
1.194     bsiegert 1725:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1726: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1727:            downloaded copies of the original source distributions used
                   1728:            for building pkgsrc packages. The default is
1.76      rillig   1729:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1730: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1731:            database about installed packages is stored.  The default is
1.230     sevan    1732:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1733: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1734:            If set, override the packages'
                   1735:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1736: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1737:            Backup location(s) for distribution files and patch files
                   1738:            if not found locally or in
1.76      rillig   1739:            <code class="filename">${MASTER_SITES}</code> or
                   1740:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1741:            The defaults is
                   1742:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1743: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1744:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1745:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1746:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1747:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1748: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1749:            List of acceptable licenses. License names are case-sensitive.
                   1750:            Whenever you try to build a package whose license is not in this
                   1751:            list, you will get an error message. If the license condition is
                   1752:            simple enough, the error message will include specific
                   1753:            instructions on how to change this variable.</p></li>
1.75      rillig   1754: </ul></div>
                   1755: </div>
1.148     asau     1756: <div class="sect1">
1.75      rillig   1757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1758: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1759: <p>
1.75      rillig   1760:       </p>
1.148     asau     1761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1762: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1763:            directory for the binary packages. The default is
1.76      rillig   1764:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1765: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1766:            The top level directory where, if defined, the separate
                   1767:            working directories will get created, and symbolically
1.76      rillig   1768:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1769:            This is useful for building packages on several
1.76      rillig   1770:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1771:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1772:            is local to every architecture. (It should be noted that
                   1773:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1774:            &mdash; it is an internal definition which refers to the
1.75      rillig   1775:            root of the pkgsrc tree. It is possible to have many
                   1776:            pkgsrc tree instances.)</p></li>
1.128     wiz      1777: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1778:            Directory for local patches that aren't part of pkgsrc.
1.299     rillig   1779:            See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1780:            information.</p></li>
1.128     wiz      1781: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1782:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1783:            BSD-style Makefile. If this is not set,
                   1784:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1785:            <code class="filename">/dev/null</code> to avoid picking up
                   1786:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1787: </ul></div>
                   1788: </div>
1.148     asau     1789: <div class="sect1">
1.75      rillig   1790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1791: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256     maya     1793:                 By default, binary packages of built packages are
1.263     leot     1794:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1795:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1796: <p>Packages have to support installation into a
1.103     wiz      1797:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1798:     to be built, before the actual filesystem is touched. DESTDIR
                   1799:     support exists in two variations:</p>
1.148     asau     1800: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1801: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1802:       installation and packaging is still run as root.</p></li>
                   1803: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1804:       build, installation and packaging as normal user. Root
                   1805:       privileges are only needed to add packages.</p></li>
                   1806: </ul></div>
1.103     wiz      1807: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1808:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1809: <p>Considering the <code class="filename">foo/bar</code> package,
                   1810:     DESTDIR full support can be tested using the following commands
                   1811: 
                   1812: </p>
                   1813: <pre class="programlisting">
                   1814: <code class="prompt">$</code> id
                   1815: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1816: <code class="prompt">$</code> mkdir $HOME/packages
                   1817: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1818: </pre>
                   1819: <p>
                   1820: 
                   1821:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1822:     should be needed
                   1823: 
                   1824: </p>
                   1825: <pre class="programlisting">
1.174     asau     1826: <code class="prompt">$</code> make stage-install
1.118     imil     1827: </pre>
                   1828: <p>
                   1829: 
                   1830:     Create a package without root privileges
                   1831: 
                   1832: </p>
                   1833: <pre class="programlisting">
1.174     asau     1834: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1835: </pre>
                   1836: <p>
                   1837: 
                   1838:     For the following command, you must be able to gain root
1.322     leot     1839:     privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1840: 
                   1841: </p>
                   1842: <pre class="programlisting">
1.174     asau     1843: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1844: </pre>
                   1845: <p>
                   1846: 
                   1847:     Then, as a simple user
                   1848: 
                   1849: </p>
                   1850: <pre class="programlisting">
                   1851: <code class="prompt">$</code> make clean
                   1852: </pre>
                   1853: <p>
                   1854: 
                   1855:     </p>
1.103     wiz      1856: </div>
1.148     asau     1857: <div class="sect1">
1.103     wiz      1858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1859: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1860: <div class="sect2">
1.78      rillig   1861: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1862: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1863: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1864:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1865: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1866: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1867: <dd>
                   1868: <p>This is a list of values specifying the chain of
                   1869:          compilers to invoke when building packages.  Valid values
                   1870:          are:</p>
1.148     asau     1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1872: <li class="listitem"><p><code class="varname">ccc</code>:
                   1873:            Compaq C Compilers (Tru64)</p></li>
                   1874: <li class="listitem"><p><code class="varname">ccache</code>:
                   1875:            compiler cache (chainable)</p></li>
                   1876: <li class="listitem"><p><code class="varname">clang</code>:
                   1877:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1878: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1879:            distributed C/C++ (chainable)</p></li>
1.174     asau     1880: <li class="listitem"><p><code class="varname">f2c</code>:
                   1881:            Fortran 77 to C compiler (chainable)</p></li>
                   1882: <li class="listitem"><p><code class="varname">icc</code>:
                   1883:            Intel C++ Compiler (Linux)</p></li>
                   1884: <li class="listitem"><p><code class="varname">ido</code>:
                   1885:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1886: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1887:            GNU C/C++ Compiler</p></li>
1.174     asau     1888: <li class="listitem"><p><code class="varname">hp</code>:
                   1889:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1890: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1891:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1892: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1893:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1894: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1895:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1896: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1897:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1898: </ul></div>
                   1899: <p>The default is
1.128     wiz      1900:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1901:          <code class="varname">ccache</code> and/or
                   1902:          <code class="varname">distcc</code> with an appropriate
                   1903:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1904:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1905:          variable should always be terminated with a value for
                   1906:          a real compiler.  Note that only one real compiler
1.128     wiz      1907:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1908:          is not allowed).</p>
1.89      rillig   1909: </dd>
                   1910: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1911: <dd><p>This specifies the minimum version of GCC to use
                   1912:          when building packages.  If the system GCC doesn't
                   1913:          satisfy this requirement, then pkgsrc will build and
                   1914:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1915: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1916: <dd><p>Specifies which version of python to use when several
                   1917:          options are available.</p></dd>
                   1918: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1919: <dd><p>Specifies the Fortran compiler to use.
                   1920:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     1921: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1922: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1923:          <code class="varname">gfortran</code> is used, this option specifies which
                   1924:          version to use.</p></dd>
1.89      rillig   1925: </dl></div>
                   1926: </div>
1.148     asau     1927: <div class="sect2">
1.89      rillig   1928: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1929: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   1930: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1931:        please make sure to use the <code class="literal">+=</code> operator
                   1932:        instead of the <code class="literal">=</code> operator:</p>
                   1933: <pre class="programlisting">
1.100     rillig   1934: CFLAGS+=        -your -flags
1.78      rillig   1935: </pre>
                   1936: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1937:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1938:        need to add their own flags.  You may want to take a look
1.322     leot     1939:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1940:        package if you're interested in optimization specifically
                   1941:        for the current CPU. </p>
1.78      rillig   1942: </div>
1.148     asau     1943: <div class="sect2">
1.88      wiz      1944: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1945: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      1946: <p>If you want to pass flags to the linker, both in the configure
                   1947: step and the build step, you can do this in two ways.  Either set
                   1948: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1949: between the two is that <code class="varname">LIBS</code> will be appended to
                   1950: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1951: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1952: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1953: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1954: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1955: settings, use the <code class="literal">+=</code> operator:</p>
                   1956: <pre class="programlisting">
1.100     rillig   1957: LDFLAGS+=        -your -linkerflags
1.88      wiz      1958: </pre>
                   1959: </div>
1.78      rillig   1960: </div>
1.148     asau     1961: <div class="sect1">
1.78      rillig   1962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1963: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1964: <p>
1.75      rillig   1965:       </p>
1.148     asau     1966: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1967: <li class="listitem">
1.75      rillig   1968: <p><code class="varname">PKG_DEVELOPER</code>:
                   1969:            Run some sanity checks that package developers want:
                   1970:            </p>
1.148     asau     1971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1972: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1973:              fuzz</p></li>
1.128     wiz      1974: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1975:              binaries will find their shared libs.</p></li>
1.75      rillig   1976: </ul></div>
                   1977: <p>
1.87      wiz      1978:        </p>
1.75      rillig   1979: </li>
1.128     wiz      1980: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1981:        of debugging output which is displayed whilst making and
                   1982:        installing the package.  The default value for this is 0,
                   1983:        which will not display the commands as they are executed
                   1984:        (normal, default, quiet operation); the value 1 will display
                   1985:        all shell commands before their invocation, and the value 2
                   1986:        will display both the shell commands before their invocation,
1.223     rillig   1987:        as well as their actual execution progress with <span class="command"><strong>set
                   1988:        -x</strong></span>.</p></li>
1.75      rillig   1989: </ul></div>
                   1990: <p>
                   1991:     </p>
                   1992: </div>
1.148     asau     1993: <div class="sect1">
1.75      rillig   1994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1995: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1996: <p>Some packages have build time options, usually to select
                   1997:     between different dependencies, enable optional support for big
                   1998:     dependencies or enable experimental features.</p>
1.75      rillig   1999: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2000:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2001:     show-options</strong></span>, for example:</p>
1.75      rillig   2002: <pre class="programlisting">
                   2003:     The following options are supported by this package:
                   2004:         ssl      Enable SSL support.
                   2005:     Exactly one of the following gecko options is required:
                   2006:         firefox  Use firefox as gecko rendering engine.
                   2007:         mozilla  Use mozilla as gecko rendering engine.
                   2008:     At most one of the following database options may be selected:
                   2009:         mysql    Enable support for MySQL database.
                   2010:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2011: 
1.75      rillig   2012:     These options are enabled by default: firefox
                   2013:     These options are currently enabled: mozilla ssl
1.1       grant    2014: </pre>
1.75      rillig   2015: <p>The following variables can be defined in
1.110     hubertf  2016:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2017:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2018:     which can be used to select or disable options for all packages
                   2019:     that support them, and
                   2020:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2021:     which can be used to select or disable options specifically for
                   2022:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2023:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2024:     are disabled. A few examples:</p>
1.75      rillig   2025: <pre class="screen">
1.110     hubertf  2026: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2027: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2028: PKG_OPTIONS.kdebase=    debug -sasl
                   2029: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2030: <p>It is important to note that options that were specifically
1.120     snj      2031:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2032:     you do not wish to include the option.  If you are unsure you can view
                   2033:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2034: <p>The following settings are consulted in the order given, and
                   2035:     the last setting that selects or disables an option is
                   2036:     used:</p>
1.128     wiz      2037: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2038: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2039:       maintainer</p></li>
1.128     wiz      2040: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2041:       variables (see below)</p></li>
1.128     wiz      2042: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2043: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2044: </ol></div>
                   2045: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2046:     selected is used, all others are automatically disabled.  If an
                   2047:     option of the group is explicitly disabled, the previously
                   2048:     selected option, if any, is used.  It is an error if no option
                   2049:     from a required group of options is selected, and building the
                   2050:     package will fail.</p>
                   2051: <p>Before the options framework was introduced, build options
                   2052:     were selected by setting a variable (often named
                   2053:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2054:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2055:     transition to the options framework for the user, these legacy
                   2056:     variables are converted to the appropriate options setting
                   2057:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2058:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2059:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2060:     directly.  Support for the legacy variables will be removed
                   2061:     eventually.</p>
1.75      rillig   2062: </div>
                   2063: </div>
1.148     asau     2064: <div class="chapter">
1.75      rillig   2065: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2066: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2067: <div class="toc">
                   2068: <p><b>Table of Contents</b></p>
1.210     leot     2069: <dl class="toc">
1.267     rillig   2070: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2071: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75      rillig   2072: </dl>
                   2073: </div>
1.148     asau     2074: <div class="sect1">
1.75      rillig   2075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2076: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2077: <p>Once you have built and installed a package, you can create
                   2078:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.322     leot     2079:     another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2080:     the same package on a group of hosts and wasting CPU time. It also
                   2081:     provides a simple means for others to install your package, should
                   2082:     you distribute it.</p>
                   2083: <p>To create a binary package, change into the appropriate
1.110     hubertf  2084:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2085:     package</strong></span>:</p>
                   2086: <pre class="screen">
1.223     rillig   2087: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2088: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2089: </pre>
1.87      wiz      2090: <p>This will build and install your package (if not already done),
                   2091:     and then build a binary package from what was installed. You can
1.110     hubertf  2092:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2093:     it. Binary packages are created by default in
                   2094:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.322     leot     2095:     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
                   2096:     continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.267     rillig   2097: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2098:     such a binary package.</p>
1.75      rillig   2099: </div>
1.148     asau     2100: <div class="sect1">
1.75      rillig   2101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2102: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299     rillig   2103: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2104: </div>
                   2105: </div>
1.148     asau     2106: <div class="chapter">
1.106     rillig   2107: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2108: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2109: builds)</h2></div></div></div>
                   2110: <div class="toc">
                   2111: <p><b>Table of Contents</b></p>
1.210     leot     2112: <dl class="toc">
1.267     rillig   2113: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2114: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2115: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2116: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig   2117: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2118: <dd><dl>
1.294     rillig   2119: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2120: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig   2121: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2122: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2123: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2124: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2125: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2126: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2127: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2128: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2129: </dl></dd>
                   2130: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2131: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2132: </dl>
                   2133: </div>
1.290     gutterid 2134: <p>For a number of reasons, you may want to build binary packages
                   2135: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2136: For instance, when you have multiple machines that should run the same software,
                   2137: it is wasted time if they all build their packages themselves from source.
                   2138: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2139: deploying onto production systems.
1.180     wiz      2140: There is a way of getting a set of binary packages:
1.290     gutterid 2141: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2142: This chapter describes how to set it up.</p>
1.148     asau     2143: <div class="sect1">
1.106     rillig   2144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2145: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2146: <p>First of all, you have to decide whether you build all packages
                   2147: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2148: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2149: A number of particularly heavy packages exist that are not actually
                   2150: interesting to a wide audience. (The approximate resource consumption for a
                   2151: 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>.)
                   2152: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2153: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2154: </p>
                   2155: <p>During bulk builds various packages are installed and deinstalled
                   2156: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2157: so make sure that you don't need any package during the builds.
1.223     rillig   2158: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2159: or something even more restrictive, depending on what the operating system provides,
                   2160: or dedicate the whole physical machine.
                   2161: As a useful side effect this makes sure that bulk builds cannot
                   2162: break anything in your system. There have been numerous cases where
1.106     rillig   2163: certain packages tried to install files outside the
                   2164: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2165: <code class="filename">/etc</code>.
                   2166: </p>
1.106     rillig   2167: </div>
1.148     asau     2168: <div class="sect1">
1.106     rillig   2169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295     rillig   2170: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2171: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2173: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2174: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2175: </ul></div>
1.148     asau     2176: <div class="sect2">
1.116     rillig   2177: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2178: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2179: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2180: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2181: Configure network access to fetch distribution files.
1.223     rillig   2182: Create a user with name "pbulk".</p>
1.178     asau     2183: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2184: <pre class="screen">
1.264     sevan    2185: <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>
                   2186: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181     wiz      2187: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178     asau     2188: </pre>
                   2189: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2190: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2191: <pre class="screen">
1.230     sevan    2192: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178     asau     2193: <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>
                   2194: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2195: </pre>
                   2196: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2197: <h3 class="title">Note</h3>
                   2198: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2199: <code class="filename">mk.conf</code> that contains settings you want to
                   2200: apply to packages you build. For instance,</p>
                   2201: <pre class="programlisting">
1.223     rillig   2202: PKG_DEVELOPER=          yes     # perform more checks
                   2203: X11_TYPE=               modular # use pkgsrc X11
                   2204: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2205:                                 # when building all packages)
1.178     asau     2206: </pre>
                   2207: </div>
                   2208: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2209: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2210: <pre class="programlisting">
                   2211: www/firefox
                   2212: mail/thunderbird
                   2213: misc/libreoffice4
                   2214: </pre>
1.179     asau     2215: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2216: and make final amendments, if wanted.</p>
1.178     asau     2217: <p>Start it:</p>
                   2218: <pre class="screen">
                   2219: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2220: </pre>
                   2221: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2222: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2223: </p>
                   2224: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2225: <h3 class="title">Note</h3>
                   2226: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2227: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2228: The script is kept small enough for better understanding.</p>
                   2229: </div>
                   2230: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2231: <h3 class="title">Note</h3>
                   2232: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320     wiz      2233: unprivileged bulk build and helps configuring distributed bulk builds.
                   2234: Distributed bulk builds support either building in worker chroots
                   2235: (each node is a path to a different chroot)
                   2236: that replicate the target system, including the pbulk prefix,
                   2237: or remote machines (each node is
                   2238: an IP address that must be accessible over SSH without a password).</p>
1.178     asau     2239: </div>
1.106     rillig   2240: </div>
                   2241: </div>
1.148     asau     2242: <div class="sect1">
1.106     rillig   2243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2244: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2245: <p>A complete bulk build requires lots of disk space. Some of the
                   2246: disk space can be read-only, some other must be writable. Some can be on
                   2247: remote filesystems (such as NFS) and some should be local. Some can be
                   2248: temporary filesystems, others must survive a sudden reboot.</p>
                   2249: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320     wiz      2250: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2251: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180     wiz      2252: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2253: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2254: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2255: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2256: </ul></div>
                   2257: </div>
                   2258: <div class="sect1">
                   2259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293     rillig   2260: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2261: <p>To ensure that pkgsrc packages work in different configurations, it
                   2262: makes sense to run non-default bulk builds from time to time. This
                   2263: section lists some ideas for bulk builds that intentionally let packages
                   2264: fail if they don't follow the pkgsrc style.</p>
                   2265: <div class="sect2">
                   2266: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2267: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2268: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2269: <pre class="programlisting">
                   2270: GNU_CONFIGURE_STRICT=   yes
                   2271: </pre>
                   2272: <p>When a package fails this additional check, the most common cause
                   2273: is that the configure option was valid for an older version of the
                   2274: package but does not apply anymore. In that case, just remove it.</p>
                   2275: </div>
                   2276: <div class="sect2">
                   2277: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2278: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2279: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2280: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2281: compiler wrappers make it easy to force compiler options when the package
                   2282: is built. This can be used to find typical bugs across all packages that
                   2283: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2284: more reliable with the next updates.</p>
                   2285: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.293     rillig   2286: <pre class="programlisting">
                   2287: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2288: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2289: </pre>
1.294     rillig   2290: <p>When a package fails to build using these stricter compiler
                   2291: options, document the circumstances in which the compiler produced the
                   2292: error message. This includes:</p>
1.293     rillig   2293: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2294: <li class="listitem"><p>The platform
                   2295: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2296: <li class="listitem"><p>The source file</p></li>
                   2297: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2298: part of the diagnostic.</p></li>
1.294     rillig   2299: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2300: </ul></div>
                   2301: <p>If a package produces these error messages, but the package is
1.294     rillig   2302: 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
                   2303: in the next builds:</p>
1.293     rillig   2304: <pre class="programlisting">
1.294     rillig   2305: .if ${PKGPATH} == category/package
1.293     rillig   2306: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2307: # error message
                   2308: # code
1.294     rillig   2309: # Reason why the code does not need to be fixed.
1.293     rillig   2310: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2311: .endif
1.293     rillig   2312: </pre>
                   2313: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2314: needs to be fixed, prepare a local patch (see
                   2315: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2316: authors of the package, providing them with the information you collected
                   2317: above.</p>
                   2318: <p>Patches that are not essential for the package to work should only
                   2319: be reported upstream but not committed to pkgsrc, to make future updates
                   2320: easier.</p>
1.293     rillig   2321: </div>
                   2322: <div class="sect2">
                   2323: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2324: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2325: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2326: these apply to all phases of the package build process. Especially in the
                   2327: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2328: decisions. The GNU configure scripts feed many small test programs to the
                   2329: C compiler to see whether certain headers are available, functions are
                   2330: defined in a library and programs can be run. In many cases these
                   2331: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2332: -Wextra -Werror</code>.</p>
                   2333: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2334: options being added between the <code class="literal">configure</code> and
                   2335: <code class="literal">build</code> phases. It's a little more complicated than the
                   2336: other examples in this section but still easy enough.</p>
                   2337: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2338: desired compiler options. The compiler wrapper's original task is to hide
                   2339: unwanted directories of include files and to normalize compiler options.
                   2340: It does this by wrapping the compiler command and rewriting the command
                   2341: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2342: package directory and examine the
                   2343: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2344: individual configurations for the C compiler and the related tools. The
                   2345: plan is to find a hook between the configure and build phases, and to
                   2346: modify these configuration files at that point.</p>
                   2347: <p>To find this hook, have a look at
                   2348: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2349: <code class="literal">pre-build-checks-hook</code>. The word
                   2350: <code class="literal">checks</code> doesn't quite fit, but the
                   2351: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2352: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2353: <pre class="programlisting">
                   2354: # Just a few example options.
                   2355: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2356: 
                   2357: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2358: pre-build-checks-hook: add-build-only-cflags
                   2359: 
                   2360: add-build-only-cflags: .PHONY
                   2361:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2362:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2363:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2364:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2365:         done;                                   \
                   2366:         &gt; ${.TARGET}
                   2367: .endif
                   2368: </pre>
                   2369: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2370: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2371: not with spaces.)</p>
                   2372: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2373: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2374: should be undefined, possibly because it is only defined for a subset of
                   2375: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2376: at least one compiler option, to prevent a syntax error in the shell
                   2377: parser.</p>
                   2378: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2379: that the additional compiler options are only appended once, even if
                   2380: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2381: creates a marker file.</p>
                   2382: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2383: configure</strong></span> in a package directory. Up to now, everything works
                   2384: as usual. Examine the directory
                   2385: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2386: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2387: the file <code class="filename">cc</code>. Examine the tail of the
                   2388: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2389: options are used.</p>
                   2390: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2391: options to the file <code class="filename">cc</code> and will create the marker
                   2392: file in the same directory. After that, the build starts as usual, but
                   2393: with the added compiler options. Examine the tail of the file
                   2394: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2395: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2396: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2397: with these options.</p>
                   2398: <p>Building packages using this setup variant and fixing the resulting
                   2399: 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>
                   2400: </div>
                   2401: <div class="sect2">
                   2402: <div class="titlepage"><div><div><h3 class="title">
                   2403: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293     rillig   2404: <p>Some directories like <code class="varname">PREFIX</code>,
                   2405: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2406: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2407: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2408: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2409: <pre class="programlisting">
                   2410: PREFIX=         /a-random-uuid
                   2411: PKG_SYSCONFDIR= /a-random-uuid
                   2412: VARBASE=        /a-random-uuid
                   2413: PKGMANDIR=     a-random-uuid
                   2414: PKG_INFODIR=   a-random-uuid
                   2415: </pre>
                   2416: </div>
                   2417: <div class="sect2">
                   2418: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2419: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2420: <p>When building a package, warnings are typically ignored since they
                   2421: just flow by and do not cause the build to fail immediately. To find
                   2422: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2423: <pre class="programlisting">
                   2424: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2425: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2426: </pre>
                   2427: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2428: them can be redefined with a simple definition like above.</p>
1.294     rillig   2429: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2430: the package Makefile, research whether the package actually needs Perl.
                   2431: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2432: Makefile, and if it doesn't, add
                   2433: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2434: </div>
                   2435: <div class="sect2">
                   2436: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2437: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2438: <p>Using pkglint as part of the regular build process is mostly a
                   2439: waste of time. If you want to fix some of the warnings, just run pkglint
                   2440: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2441: 10), which is much faster than a complete bulk build.</p>
                   2442: </div>
                   2443: <div class="sect2">
                   2444: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2445: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2446: <p>To ensure that the binary packages don't contain references to the
                   2447: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2448: that variable includes the item <code class="literal">extra</code>, it is
                   2449: possible to define additional patterns that must not appear in any
                   2450: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2451: <pre class="programlisting">
                   2452: CHECK_WRKREF=                   extra
                   2453: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2454: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2455: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2456: </pre>
                   2457: <p>The above patterns will probably generate many false positives,
                   2458: therefore the results need to be taken with a grain of salt.</p>
                   2459: </div>
                   2460: <div class="sect2">
                   2461: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2462: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2463: <p>To run the test suites that come with each package, add this line
                   2464: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2465: <pre class="programlisting">
                   2466: PKGSRC_RUN_TEST=        yes
                   2467: </pre>
                   2468: <p>Be prepared that even the most basic packages fail this test. When
                   2469: doing a bulk build with this, it will often abort in the early phase
                   2470: where the packages are scanned for their dependencies since there are
                   2471: cyclic dependencies. There is still a lot to do in this area.</p>
                   2472: </div>
                   2473: <div class="sect2">
                   2474: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2475: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2476: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2477: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2478: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2479: <pre class="programlisting">
                   2480: RUN=    @set -eu;
                   2481: </pre>
1.296     rillig   2482: <p>After that, ensure that none of the bulk build log files (even
                   2483: those for successfully built packages) contains the string
                   2484: <code class="literal">parameter not set</code> or whatever error message the
                   2485: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2486: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2487: definition.</p>
                   2488: </div>
                   2489: <div class="sect2">
                   2490: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2491: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2492: <p>The build logs of a package are often quite long. This allows error
                   2493: messages or other interesting details to hide between the noise. To make
                   2494: the actual error message stand out more, add these lines to
                   2495: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2496: <pre class="programlisting">
                   2497: GNU_CONFIGURE_QUIET=    yes
                   2498: MAKE_FLAGS+=            -s
                   2499: </pre>
                   2500: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2501: Make. On exotic platforms with their own make, it may be a little
                   2502: different.</p>
                   2503: </div>
                   2504: </div>
                   2505: <div class="sect1">
                   2506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2507: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2508: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2509:     create a CD-ROM set of the resulting binary packages to assist
                   2510:     in installing packages on other machines.  The
1.322     leot     2511:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2512:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2513:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2514:     way that keeps all the dependencies for a given package on the same
                   2515:     CD as that package.</p>
1.148     asau     2516: <div class="sect2">
1.75      rillig   2517: <div class="titlepage"><div><div><h3 class="title">
1.293     rillig   2518: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2519: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2520:       man page. The following short example assumes that the binary
                   2521:       packages are left in
                   2522:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2523:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2524:       hold the ISO 9660 images.</p>
                   2525: <pre class="screen">
                   2526: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2527: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2528: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2529:       </pre>
                   2530: <p>If you wish to include a common set of files
                   2531:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2532:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2533:       directory which contains these files, e.g.:</p>
1.87      wiz      2534: <pre class="screen">
                   2535: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2536: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2537: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2538: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2539: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2540: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2541: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2542:       </pre>
1.75      rillig   2543: <p>Now create the images:</p>
                   2544: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   2545: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2546:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2547:       in their root directories.</p>
1.75      rillig   2548: </div>
                   2549: </div>
                   2550: </div>
1.148     asau     2551: <div class="chapter">
1.75      rillig   2552: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2553: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2554: <div class="toc">
                   2555: <p><b>Table of Contents</b></p>
1.210     leot     2556: <dl class="toc">
1.267     rillig   2557: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2558: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   2559: </dl>
                   2560: </div>
                   2561: <p>The files that are installed by pkgsrc are organized in a way that
                   2562: is similar to what you find in the <code class="filename">/usr</code> directory
                   2563: of the base system. But some details are different. This is because
                   2564: pkgsrc initially came from FreeBSD and had adopted its file system
                   2565: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2566: which operating system you are using pkgsrc with, you can expect the
                   2567: same layout for pkgsrc.</p>
1.91      rillig   2568: <p>There are mainly four root directories for pkgsrc, which are all
                   2569: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2570: When pkgsrc has been installed as root, the default locations
                   2571: are:</p>
                   2572: <pre class="programlisting">
1.100     rillig   2573: LOCALBASE=              /usr/pkg
                   2574: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2575: VARBASE=                /var
1.231     sevan    2576: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2577: </pre>
                   2578: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2579: user), the default locations are:</p>
                   2580: <pre class="programlisting">
1.100     rillig   2581: LOCALBASE=              ${HOME}/pkg
                   2582: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2583: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2584: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2585: </pre>
                   2586: <p>What these four directories are for, and what they look like is
                   2587: explained below.</p>
1.148     asau     2588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2589: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2590: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2591: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2592: the well-known subdirectories like <code class="filename">bin</code>,
                   2593: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2594: <code class="filename">share</code> and
                   2595: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2596: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2597: <code class="filename">/var</code> in the base system. Some programs (especially
                   2598: games, network daemons) need write access to it during normal
                   2599: operation.</p></li>
1.128     wiz      2600: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2601: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2602: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   2603: itself.</p></li>
                   2604: </ul></div>
1.148     asau     2605: <div class="sect1">
1.90      rillig   2606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2607: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2608: </h2></div></div></div>
1.90      rillig   2609: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2610: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2611: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2612: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2613: <dd><p>Contains executable programs that are intended to be
                   2614: directly used by the end user.</p></dd>
                   2615: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2616: <dd><p>Contains files for the emulation layers of various other
                   2617: operating systems, especially for
                   2618: NetBSD.</p></dd>
                   2619: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2620: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2621: <dd><p>Contains
                   2622: the configuration files.</p></dd>
                   2623: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2624: <dd><p>Contains headers for the C and C++ programming
                   2625: languages.</p></dd>
                   2626: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2627: <dd><p>Contains GNU info files of various
                   2628: packages.</p></dd>
                   2629: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2630: <dd><p>Contains shared and static
                   2631: libraries.</p></dd>
                   2632: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2633: <dd><p>Contains data files that don't change after
                   2634: installation. Other data files belong into
                   2635: <code class="filename">${VARBASE}</code>.</p></dd>
                   2636: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2637: <dd><p>Contains programs that are not intended to be used by
                   2638: end users, such as helper programs or network
                   2639: daemons.</p></dd>
                   2640: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2641: <dd><p>Contains programs that are intended to be executed as
                   2642: CGI scripts by a web server.</p></dd>
                   2643: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2644: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2645: <dd><p>Contains brief
                   2646: documentation in form of manual pages.</p></dd>
                   2647: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2648: <dd><p>Contains programs that are intended to be used only by
                   2649: the super-user.</p></dd>
                   2650: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2651: <dd><p>Contains platform-independent data files that don't
                   2652: change after installation.</p></dd>
                   2653: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2654: <dd><p>Contains documentation files provided by the
                   2655: packages.</p></dd>
                   2656: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2657: <dd><p>Contains example files provided by the packages. Among
                   2658: others, the original configuration files are saved here and copied to
                   2659: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2660: installation.</p></dd>
                   2661: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2662: <dd><p>Contains the original files for rc.d
                   2663: scripts.</p></dd>
                   2664: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2665: <code class="filename">${VARBASE}</code>)</span></dt>
                   2666: <dd><p>Contains files
                   2667: that may be modified after
                   2668: installation.</p></dd>
                   2669: </dl></div>
                   2670: </div>
1.148     asau     2671: <div class="sect1">
1.90      rillig   2672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2673: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2674: </h2></div></div></div>
1.148     asau     2675: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2676: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2677: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2678: <dd><p>Contains
                   2679: information about the currently installed
                   2680: packages.</p></dd>
                   2681: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2682: <dd><p>Contains highscore
                   2683: files.</p></dd>
                   2684: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2685: <dd><p>Contains log files.</p></dd>
                   2686: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2687: <dd><p>Contains informational files about daemons that are
                   2688: currently running.</p></dd>
                   2689: </dl></div>
                   2690: </div>
                   2691: </div>
1.148     asau     2692: <div class="chapter">
1.90      rillig   2693: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2694: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2695: <div class="toc">
                   2696: <p><b>Table of Contents</b></p>
1.210     leot     2697: <dl class="toc">
1.267     rillig   2698: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2699: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2700: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2701: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2702: <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>
                   2703: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2704: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2705: <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>
                   2706: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2707: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2708: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2709: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.336     nia      2710: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig   2711: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2712: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2713: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2714: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2715: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2716: </dl>
                   2717: </div>
                   2718: <p>This section contains hints, tips &amp; tricks on special things in
                   2719: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2720: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2721: <div class="sect1">
1.75      rillig   2722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2723: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2724: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2726: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   2727:          This is a general purpose list for most issues regarding
                   2728:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2729:          for pkgsrc configuration, unexpected build failures, using
                   2730:          particular packages, upgrading pkgsrc installations,
                   2731:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2732:          proposals for changes that impact the pkgsrc user community,
                   2733:          e.g. major infrastructure changes, new features, package
                   2734:          removals, etc., may also be posted.</p></li>
1.289     leot     2735: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2736:          A list where the results of pkgsrc bulk builds are sent and
                   2737:          discussed.</p></li>
1.289     leot     2738: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2739:          This list is for those who are interested in getting a
                   2740:          commit message for every change committed to pkgsrc. It is
                   2741:          also available in digest form, meaning one daily message
                   2742:          containing all commit messages for changes to the package
                   2743:          source tree in that 24 hour period.</p></li>
                   2744: </ul></div>
                   2745: <p>To subscribe, do:</p>
                   2746: <pre class="programlisting">
1.100     rillig   2747: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2748: </pre>
                   2749: <p>Archives for all these mailing lists are available from
1.289     leot     2750: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2751: </div>
1.148     asau     2752: <div class="sect1">
1.75      rillig   2753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2754: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2755: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2756: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2757: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2758: they might be useful, and not to duplicate the documentation that comes
                   2759: with each package.</p>
                   2760: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322     leot     2761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2762:       Symlinks for use by buildlink.</p></li></ul></div>
                   2763: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2764: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2765: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2766:       Calculates various kinds of checksums (including SHA3).</p></li>
1.322     leot     2767: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2768:       Compatibility library for pkgsrc tools.</p></li>
1.322     leot     2769: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2770:       non-BSD systems due to lack of native mtree.</p></li>
1.322     leot     2771: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2772:       Up-to-date replacement for
1.76      rillig   2773:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2774:       systems where pkg_install is not present.</p></li>
                   2775: </ul></div>
                   2776: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2777: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2778: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2779:       Create a binary package from an
1.110     hubertf  2780:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2781:       save the old package.</p></li>
1.322     leot     2782: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2783:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2784:       from multiple locations. It currently supports the following
                   2785:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322     leot     2786: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2787:       the best compiler flags to optimise code for your current
1.128     wiz      2788:       CPU and compiler. </p></li>
1.75      rillig   2789: </ul></div>
                   2790: <p>Utilities for keeping track of installed packages, being up to date,
                   2791: etc:</p>
1.148     asau     2792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2793: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2794:     update tool similar to apt(1). Download, install, and upgrade
                   2795:     binary packages easily.</p></li>
1.322     leot     2796: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2797:       packages whose installed versions do not match the latest pkgsrc
                   2798:       entries.</p></li>
1.322     leot     2799: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2800:       dependency graphs of packages, to aid in choosing a strategy for
                   2801:       updating.</p></li>
1.322     leot     2802: <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
                   2803:       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>
                   2804: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2805:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322     leot     2806: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2807:       does various checks on the complete pkgsrc system.</p></li>
1.322     leot     2808: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2809:       packages you have installed.</p></li>
                   2810: </ul></div>
                   2811: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2812: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2813: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2814:       making and maintaining patches for a package (includes pkgdiff,
                   2815:       pkgvi, mkpatches, etc.).</p></li>
1.322     leot     2816: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2817:       converting to pkgsrc.</p></li>
                   2818: </ul></div>
                   2819: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2820: utilities)</p>
1.148     asau     2821: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2822: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2823:       packages in a chrooted area.</p></li>
1.322     leot     2824: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2825:       kernel version for chrooted cross builds.</p></li>
                   2826: </ul></div>
                   2827: </div>
1.148     asau     2828: <div class="sect1">
1.75      rillig   2829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2830: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2831: <p>To install packages from source as a non-root user, download
1.267     rillig   2832: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219     rillig   2833: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2834: --unprivileged</strong></span>.</p>
                   2835: <p>This will install the binary part of pkgsrc to
                   2836: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2837: into <code class="filename">~/pkg/etc</code>.</p>
                   2838: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2839: </div>
1.148     asau     2840: <div class="sect1">
1.75      rillig   2841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2842: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2843: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2844: enable this feature by adding the option
                   2845: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2846: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2847: distfile is found, pkgsrc will try to resume it.</p>
                   2848: <p>You can also
1.168     wiz      2849: use a different program than the platform default program by changing the
1.117     jnemeth  2850: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2851: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2852: by using the value manual.  A value of custom disables the system defaults
                   2853: and dependency tracking for the fetch program.  In that case you have to
                   2854: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2855: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2856: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2857: <p>For example, if you want to use
1.117     jnemeth  2858: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2859: like:</p>
                   2860: <pre class="programlisting">
1.223     rillig   2861: FETCH_USING=    wget
1.1       grant    2862: </pre>
1.75      rillig   2863: </div>
1.148     asau     2864: <div class="sect1">
1.75      rillig   2865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2866: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      2867: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2868: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2869: you will have to add the following line into
1.110     hubertf  2870: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2871: <pre class="programlisting">
1.103     wiz      2872: X11_TYPE=modular
1.1       grant    2873: </pre>
1.75      rillig   2874: </div>
1.148     asau     2875: <div class="sect1">
1.75      rillig   2876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2877: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2878: <p>If you are sitting behind a firewall which does not allow direct
                   2879: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2880: relevant proxy hosts.  This is done using an environment variable in the
                   2881: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2882: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2883: port 80 as the proxy port number.  So the proxy environment variables
                   2884: are:</p>
                   2885: <pre class="programlisting">
1.100     rillig   2886: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2887: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2888: </pre>
1.75      rillig   2889: </div>
1.148     asau     2890: <div class="sect1">
1.75      rillig   2891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2892: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2893: <p>Some fetch tools are not prepared to support HTTPS by default
                   2894: (for example, the one in NetBSD 6.0), or the one installed by the
                   2895: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2896: dependency graph).</p>
                   2897: <p>Usually you won't notice, because distribution files are
                   2898: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2899: be often enough if you are following pkgsrc-current. In that case, set
                   2900: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2901: <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
                   2902: with HTTPS support by default. Of course, these tools need to be
                   2903: installed before you can use them this way.</p>
                   2904: </div>
                   2905: <div class="sect1">
                   2906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2907: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   2908: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2909: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2910: the first available command from the following list:</p>
1.148     asau     2911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2912: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2913: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2914: </ul></div>
                   2915: <p>On a default NetBSD installation, this will be
1.76      rillig   2916: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2917: connections first, and falls back to active connections if the server
                   2918: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2919: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2920: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2921: <p>Having that option present will prevent
1.76      rillig   2922: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2923: transfers.</p>
                   2924: </div>
1.148     asau     2925: <div class="sect1">
1.75      rillig   2926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2927: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2928: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2929: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2930: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   2931: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2932: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2933: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2934: resulting list to your machine at work/school and use it there.  If you
1.322     leot     2935: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2936: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2937: URL:</p>
                   2938: <p>At home:</p>
                   2939: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2940: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2941: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2942: <p>At work:</p>
                   2943: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2944: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2945: home.</p>
                   2946: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2947: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2948: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2949: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2950: directly by running:</p>
1.75      rillig   2951: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2952: <p>If you even decide to ignore
                   2953: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2954: by running:</p>
                   2955: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2956: </div>
1.148     asau     2957: <div class="sect1">
1.75      rillig   2958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2959: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2960: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.322     leot     2961: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   2962: package, you get the error from make that it doesn't know how to make
1.76      rillig   2963: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2964: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2965: the NetBSD base distribution on your machine.  It is recommended to do
                   2966: that to format man pages.</p>
1.322     leot     2967: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   2968: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2969: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2970: </div>
1.148     asau     2971: <div class="sect1">
1.75      rillig   2972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2973: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      2974: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2975: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2976: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2977: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2978: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2979: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2980: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2981: -r</strong></span>).</p>
                   2982: </div>
1.148     asau     2983: <div class="sect1">
1.75      rillig   2984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336     nia      2985: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75      rillig   2986: <p>When installing packages as non-root user and using the just-in-time
1.322     leot     2987: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   2988: password for each required package installed.  To avoid this, the sudo
                   2989: package can be used, which does password caching over a limited time.  To
1.336     nia      2990: use it, install <span class="command"><strong>sudo</strong></span> or
                   2991: <span class="command"><strong>priv</strong></span> (either as binary package, from
                   2992: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.322     leot     2993: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  2994: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2995: <span class="emphasis"><em>after</em></span> the definition of the
                   2996: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2997: <pre class="programlisting">
1.100     rillig   2998: .if exists(${LOCALBASE}/bin/sudo)
                   2999: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3000: .endif
1.1       grant    3001: </pre>
1.75      rillig   3002: </div>
1.148     asau     3003: <div class="sect1">
1.75      rillig   3004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3005: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3006: <p>As the system administrator, you can choose where configuration files
                   3007: are installed.  The default settings make all these files go into
1.76      rillig   3008: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3009: be suboptimal depending on your expectations (e.g., a read-only,
                   3010: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3011: configuration of the provided packages).</p>
                   3012: <p>In order to change the defaults, you can modify the
                   3013: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3014: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3015: directory; some common examples include <code class="filename">/etc</code> or
                   3016: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3017: <p>Furthermore, you can change this value on a per-package basis by
                   3018: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3019: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3020: package you would like to modify, that is, the contents of
                   3021: <code class="varname">PKGBASE</code>.</p>
                   3022: <p>Note that after changing these settings, you must rebuild and
                   3023: reinstall any affected packages.</p>
                   3024: </div>
1.148     asau     3025: <div class="sect1">
1.75      rillig   3026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3027: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3028: <p>Please be aware that there can often be bugs in third-party software,
                   3029: and some of these bugs can leave a machine vulnerable to exploitation by
                   3030: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3031: maintains a database of known-exploits to packages which have at one time
                   3032: been included in pkgsrc.  The database can be downloaded automatically, and
                   3033: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3034: do this, refer to the following two tools (installed as part of the
1.322     leot     3035: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3036: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3037: <li class="listitem">
1.122     reed     3038: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3039:     download a list of the security vulnerabilities information.  This list
1.132     spz      3040:     is kept up to date by the pkgsrc security team, and is distributed
                   3041:     from the NetBSD ftp server:</p>
1.292     leot     3042: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75      rillig   3043: </li>
1.128     wiz      3044: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3045:     current machine, checking each known vulnerability.  If a
1.75      rillig   3046:     vulnerable package is installed, it will be shown by output to stdout,
                   3047:     including a description of the type of vulnerability, and a URL
                   3048:     containing more information.</p></li>
                   3049: </ol></div>
1.233     sevan    3050: <p>Use of these tools is strongly recommended!
1.317     nia      3051: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    3052: reporting.</p>
                   3053: <p>If this database is installed, pkgsrc builds will use it to
                   3054: perform a security check before building any package.</p>
1.75      rillig   3055: </div>
1.148     asau     3056: <div class="sect1">
1.75      rillig   3057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3058: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3059: <p>When you add your own preferences to the
                   3060:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3061:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3062:        environment variables to the <code class="filename">./configure</code>
1.322     leot     3063:        scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3064:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3065:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3066:        package.</p>
                   3067: <p>Currently there is no solution to this problem. If you
                   3068:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3069:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3070:        directory and then inspect any <code class="filename">Makefile</code> and
                   3071:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3072:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3073:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3074:        programmers write so bad code that it only works for the
                   3075:        specific combination of <code class="varname">CFLAGS</code> they have
                   3076:        chosen.</p>
1.287     rillig   3077: <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>
                   3078: <pre class="programlisting">
                   3079: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3080: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3081: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3082: </pre>
                   3083: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3084: to see whether the above flags are passed to the actual build
                   3085: commands in general.</p>
                   3086: <p>To find out whether the flags are passed to individual compiler
                   3087: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3088: most cases, the flags from the original command lines (the lines starting
                   3089: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3090: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3091: missing from the actual compiler command, it must have been removed by
1.299     rillig   3092: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3093: </div>
1.148     asau     3094: <div class="sect1">
1.80      rillig   3095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3096: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3097: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3098: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3099:        case that occurs often is that people only update pkgsrc in
                   3100:        parts, because of performance reasons. Since pkgsrc is one large
                   3101:        system, not a collection of many small systems, there are
                   3102:        sometimes changes that only work when the whole pkgsrc tree is
                   3103:        updated.</p></li>
1.148     asau     3104: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3105:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3106:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3107:        files.</p></li>
1.148     asau     3108: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3109:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3110:        verify this.</p></li>
1.218     rillig   3111: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   3112:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148     asau     3113: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3114:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3115: </ol></div>
                   3116: </div>
1.148     asau     3117: <div class="sect1">
1.88      wiz      3118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3119: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   3120: <p>You have modified a file from pkgsrc, and someone else has
                   3121: modified that same file afterwards in the CVS repository. Both changes
                   3122: are in the same region of the file, so when you updated pkgsrc, the
                   3123: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3124: file. Because of these markers, the file is no longer a valid
                   3125: <code class="filename">Makefile</code>.</p>
                   3126: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3127: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3128: -dP</strong></span> in that directory to download the current version.</p>
                   3129: </div>
1.75      rillig   3130: </div>
                   3131: </div>
1.148     asau     3132: <div class="part">
1.75      rillig   3133: <div class="titlepage"><div><div><h1 class="title">
                   3134: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3135: <div class="partintro">
1.77      rillig   3136: <div></div>
                   3137: <p>This part of the book deals with creating and
1.128     wiz      3138:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3139:        guide on creating a new package. The remaining chapters are more
                   3140:        like a reference manual for pkgsrc.</p>
1.75      rillig   3141: <div class="toc">
                   3142: <p><b>Table of Contents</b></p>
1.210     leot     3143: <dl class="toc">
1.267     rillig   3144: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3145: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3146: <dd><dl>
1.299     rillig   3147: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3148: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3149: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3150: <dd><dl>
1.299     rillig   3151: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3152: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3153: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3154: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3155: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3156: </dl></dd>
1.299     rillig   3157: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3159: <dd><dl>
                   3160: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3161: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3162: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3163: </dl></dd>
                   3164: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3165: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3166: </dl></dd>
1.299     rillig   3167: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3168: <dd><dl>
1.299     rillig   3169: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3170: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3171: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3172: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3173: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3174: <dd><dl>
1.299     rillig   3175: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3176: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3177: </dl></dd>
1.299     rillig   3178: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3179: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3180: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3181: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3182: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3183: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3184: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3185: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3186: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3187: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3188: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3189: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3190: </dl></dd>
                   3191: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3192: <dd><dl>
                   3193: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3194: <dd><dl>
1.334     nia      3195: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   3196: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   3197: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig   3198: </dl></dd>
1.299     rillig   3199: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3200: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig   3201: </dl></dd>
1.299     rillig   3202: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3203: <dd><dl>
1.299     rillig   3204: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3205: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3206: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3207: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3208: <dd><dl>
1.299     rillig   3209: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3210: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3211: <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>
                   3212: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   3213: </dl></dd>
                   3214: </dl></dd>
1.299     rillig   3215: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3216: <dd><dl>
1.299     rillig   3217: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3218: <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>
                   3219: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3220: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3221: </dl></dd>
1.299     rillig   3222: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3223: <dd><dl>
1.299     rillig   3224: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3225: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3226: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3227: </dl></dd>
                   3228: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3229: <dd><dl>
                   3230: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3231: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3232: <dd><dl>
1.299     rillig   3233: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3234: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3235:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3236:       and
                   3237:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3238:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3239: </dl></dd>
1.299     rillig   3240: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3241: <dd><dl>
                   3242: <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>
                   3243: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3244: </dl></dd>
                   3245: </dl></dd>
                   3246: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3247: <dd><dl>
1.299     rillig   3248: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3249: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3250: <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>
                   3251: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3252: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3253: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3254: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3255: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3256: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3257: </dl></dd>
1.299     rillig   3258: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3259: <dd><dl>
                   3260: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3261: <dd><dl>
                   3262: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3263: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3264: </dl></dd>
1.299     rillig   3265: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3266: <dd><dl>
1.299     rillig   3267: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3268: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   3269: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   3270: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   3271: </dl></dd>
                   3272: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3273: <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>
                   3274: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3275: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3276: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3277: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3278: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig   3279: </dl></dd>
                   3280: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3281: <dd><dl>
                   3282: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3283: <dd><dl>
                   3284: <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>
                   3285: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3286: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3287: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3288: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3289: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3290: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3291: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3292: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3293: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3294: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3295: </dl></dd>
                   3296: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3297: <dd><dl>
                   3298: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3299: <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>
                   3300: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3301: </dl></dd>
                   3302: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3303: <dd><dl>
                   3304: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3305: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3306: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338   ! nia      3307: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267     rillig   3308: </dl></dd>
                   3309: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3310: <dd><dl>
                   3311: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3312: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      3313: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338   ! nia      3314: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
        !          3315: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
        !          3316: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
        !          3317: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   3318: </dl></dd>
                   3319: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3320: <dd><dl>
                   3321: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3322: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3323: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3324: <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>
                   3325: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3326: </dl></dd>
                   3327: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3328: <dd><dl>
                   3329: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3330: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3331: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3332: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3333: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      3334: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     rillig   3335: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3336: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318     nia      3337: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   3338: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   3339: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   3340: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   3341: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   3342: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   3343: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87      wiz      3344:     emulation</a></span></dt>
1.318     nia      3345: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   3346: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77      rillig   3347: </dl></dd>
1.267     rillig   3348: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3349: </dl></dd>
1.299     rillig   3350: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3351: <dd><dl>
                   3352: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3353: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3354: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3355: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3356: </dl></dd>
1.267     rillig   3357: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3358: <dd><dl>
1.267     rillig   3359: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3360: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3361: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3362: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3363: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3364: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3365: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3366: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3367: </dl></dd>
                   3368: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig   3369: </dl>
                   3370: </div>
1.77      rillig   3371: </div>
1.148     asau     3372: <div class="chapter">
1.77      rillig   3373: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3374: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3375: <p>
                   3376:        To get help when developing pkgsrc, the definitive source is this
                   3377:        document, the pkgsrc guide. If you don't find anything here,
                   3378:        there are alternatives:
                   3379: </p>
                   3380: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3381: <li class="listitem">
                   3382: <p>
                   3383:        The built-in pkgsrc help, which is available after bootstrapping
                   3384:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3385:        help for any topic, such as a variable name like
                   3386:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3387:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3388:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322     leot     3389: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267     rillig   3390: </li>
                   3391: <li class="listitem"><p>
1.278     rillig   3392:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3393:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3394: </p></li>
                   3395: <li class="listitem"><p>
                   3396:        To see the values of the most common variables, run
                   3397:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3398:        topic. To see the variables for a single topic, run
                   3399:        <span class="command"><strong>bmake
                   3400:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3401:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3402: </p></li>
                   3403: <li class="listitem"><p>
1.267     rillig   3404:        The tech-pkg mailing list, to which
                   3405:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3406:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3407:        questions</a>.</p></li>
                   3408: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3409:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3410:        or by using a specialized chat program such as
                   3411:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3412:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3413: </ul></div>
                   3414: </div>
                   3415: <div class="chapter">
                   3416: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3417: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3418: <div class="toc">
                   3419: <p><b>Table of Contents</b></p>
1.210     leot     3420: <dl class="toc">
1.299     rillig   3421: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3422: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3423: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3424: <dd><dl>
                   3425: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3426: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3427: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3428: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3429: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3430: </dl></dd>
                   3431: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3432: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3433: <dd><dl>
                   3434: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3435: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3436: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3437: </dl></dd>
1.299     rillig   3438: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3439: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3440: </dl>
                   3441: </div>
1.299     rillig   3442: <p>Whenever you're preparing a package, there are a number of
                   3443: files involved which are described in the following
                   3444: sections.</p>
                   3445: <div class="sect1">
                   3446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3447: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3448: </h2></div></div></div>
                   3449: <p>Building, installation and creation of a binary package are all
                   3450:   controlled by the package's <code class="filename">Makefile</code>.
                   3451:   The <code class="filename">Makefile</code> describes various things about
                   3452:   a package, for example from where to get it, how to configure,
                   3453:   build, and install it.</p>
                   3454: <p>A package <code class="filename">Makefile</code> contains several
                   3455:   sections that describe the package.</p>
                   3456: <p>In the first section there are the following variables, which
                   3457:   should appear exactly in the order given here.  The order and
                   3458:   grouping of the variables is mostly historical and has no further
                   3459:   meaning.</p>
                   3460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3461: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3462:     distribution file to be downloaded from the package's
                   3463:     website.</p></li>
                   3464: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3465:     package, as used by pkgsrc. You need to provide it if
                   3466:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3467:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3468:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3469:     directory name together with the version number. It must match the
                   3470:     regular expression
                   3471:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3472:     starts with a letter or digit, and contains only letters, digits,
1.319     nia      3473:     dashes, underscores, dots and plus signs.
                   3474:     New packages should have entirely lower-case names, with the exception
                   3475:     of some that must follow pre-existing conventions
                   3476:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3477:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3478:     the package name.</p></li>
1.299     rillig   3479: <li class="listitem">
                   3480: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3481:     which the package fits in. You can choose any of the top-level
                   3482:     directories of pkgsrc for it.</p>
                   3483: <p>Currently the following values are available for
                   3484:     <code class="varname">CATEGORIES</code>. If more than
                   3485:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3486: <pre class="programlisting">
1.299     rillig   3487: archivers     cross         geography     meta-pkgs     security
                   3488: audio         databases     graphics      misc          shells
                   3489: benchmarks    devel         ham           multimedia    sysutils
                   3490: biology       editors       inputmethod   net           textproc
                   3491: cad           emulators     lang          news          time
                   3492: chat          finance       mail          parallel      wm
                   3493: comms         fonts         math          pkgtools      www
                   3494: converters    games         mbone         print         x11
1.77      rillig   3495: </pre>
                   3496: </li>
1.299     rillig   3497: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3498:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3499:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3500:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3501:     <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>
                   3502: </ul></div>
                   3503: <p>The second section contains information about separately
                   3504:   downloaded patches, if any.
                   3505:   </p>
                   3506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3507: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3508:     Name(s) of additional files that contain distribution patches.
                   3509:     There is no default. pkgsrc will look for them at
                   3510:     <code class="varname">PATCH_SITES</code>.
                   3511:     They will automatically be uncompressed before patching if
                   3512:     the names end with <code class="filename">.gz</code> or
                   3513:     <code class="filename">.Z</code>.</p></li>
                   3514: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3515:     Primary location(s) for distribution patch files (see
                   3516:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3517: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.322     leot     3518:     an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   3519:     help find the correct files to patch. It defaults to
                   3520:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3521: </ul></div>
                   3522: <p>The third section contains the following variables.
                   3523:   </p>
                   3524: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3525: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3526:     address of the person who feels responsible for this package,
                   3527:     and who is most likely to look at problems or questions regarding
1.322     leot     3528:     this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299     rillig   3529:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3530:     before making changes to the package, but are not required to
                   3531:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3532:     to yourself. If you really can't maintain the package for future
                   3533:     updates, set it to
                   3534:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3535: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3536:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3537:     developers to update or change the package without contacting
                   3538:     you first. A package Makefile should contain one of
                   3539:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3540:     not both.  </p></li>
                   3541: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3542:     find more information about the package.</p></li>
                   3543: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3544:     description of the package (should not include the package
                   3545:     name).</p></li>
                   3546: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3547:     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>
                   3548: </ul></div>
                   3549: <p>Other variables that affect the build:
                   3550:   </p>
                   3551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3552: <p><code class="varname">WRKSRC</code>: The directory where the
                   3553:       interesting distribution files of the package are found. The
                   3554:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3555:       works for most packages.</p>
                   3556: <p>If a package doesn't create a subdirectory for itself
                   3557:       (most GNU software does, for instance), but extracts itself in
                   3558:       the current directory, you should set
                   3559:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3560: <p>If a package doesn't create a subdirectory with the
                   3561:       name of <code class="varname">DISTNAME</code> but some different name,
                   3562:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3563:       <code class="filename">${WRKDIR}</code>, for example
                   3564:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322     leot     3565:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.299     rillig   3566: <p>The name of the working directory created by pkgsrc is
                   3567:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3568:       variable. By default, its value is
                   3569:       <code class="filename">work</code>. If you want to use the same
                   3570:       pkgsrc tree for building different kinds of binary packages,
                   3571:       you can change the variable according to your needs. Two
                   3572:       other variables handle common cases of setting
                   3573:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3574:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3575:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3576:       the host's name is attached to the directory name. If
                   3577:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3578:       is attached, which might look like
                   3579:       <code class="filename">work.i386</code> or
                   3580:       <code class="filename">work.sparc</code>.</p>
                   3581: </li></ul></div>
                   3582: <p>Please pay attention to the following gotchas:</p>
                   3583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3584: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3585:       installed in compressed form by the package.  For packages using
                   3586:       BSD-style makefiles which honor MANZ, there is
                   3587:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3588: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3589:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3590:       below).</p></li>
                   3591: <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>
                   3592: </ul></div>
                   3593: </div>
1.148     asau     3594: <div class="sect1">
1.91      rillig   3595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   3596: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3597: </h2></div></div></div>
                   3598: <p>The <code class="filename">distinfo</code> file contains the message
                   3599:   digest, or checksum, of each distfile needed for the package. This
                   3600:   ensures that the distfiles retrieved from the Internet have not been
                   3601:   corrupted during transfer or altered by a malign force to introduce
                   3602:   a security hole. To provide maximum security, all distfiles are
                   3603:   protected using three different message digest algorithms (SHA1,
                   3604:   RMD160, SHA512), as well as the file size.</p>
                   3605: <p>The <code class="filename">distinfo</code> file also contains the
                   3606:   checksums for all the patches found in the
                   3607:   <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
                   3608:   are only applied intentionally and that they don't accidentally change,
                   3609:   e.g. when merging different changes together. They also make sure that
                   3610:   new patches are actually added to CVS and old ones are removed.
                   3611:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3612:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3613: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3614:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3615: <p>Some packages have different sets of distfiles depending on
1.322     leot     3616:   the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.299     rillig   3617:   <code class="filename">distinfo</code> file and care should be taken when
                   3618:   upgrading such a package to ensure distfile information is not
                   3619:   lost.</p>
                   3620: </div>
                   3621: <div class="sect1">
                   3622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3623: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3624: </h2></div></div></div>
                   3625: <p>Some packages don't work out-of-the box on the various
                   3626:   platforms that are supported by pkgsrc. These packages need
                   3627:   to be patched to make them work. The patch files can be
                   3628:   found in the <code class="filename">patches/</code> directory.</p>
                   3629: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3630:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3631:   extracting them, in alphabetic order.</p>
1.148     asau     3632: <div class="sect2">
1.91      rillig   3633: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3634: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3635: <p>The <code class="filename">patch-*</code> files should be in
                   3636:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3637:   problems. (To force patches to apply with fuzz you can set
                   3638:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3639:   should contain only changes for a single file, and no file should be
                   3640:   patched by more than one patch file. This helps to keep future
                   3641:   modifications simple.</p>
                   3642: <p>Each patch file is structured as follows: In the first line,
                   3643:   there is the RCS Id of the patch itself. The second line should be
                   3644:   empty for aesthetic reasons. After that, there should be a comment for
                   3645:   each change that the patch does. There are a number of standard
                   3646:   cases:</p>
                   3647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3648: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3649:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3650: <li class="listitem"><p>Patches that change source code should mention the
                   3651:   platform and other environment (for example, the compiler) that the
                   3652:   patch is needed for.</p></li>
                   3653: </ul></div>
                   3654: <p>The patch should be commented so that any
                   3655:   developer who knows the code of the application can make some use of
                   3656:   the patch. Special care should be taken for the upstream developers,
                   3657:   since we generally want that they accept our patches, so we have less
                   3658:   work in the future.</p>
1.91      rillig   3659: </div>
1.148     asau     3660: <div class="sect2">
1.91      rillig   3661: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3662: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3663: <p>One important thing to mention is to pay attention that no RCS
                   3664:   IDs get stored in the patch files, as these will cause problems when
                   3665:   later checked into the NetBSD CVS tree. Use the
1.322     leot     3666:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.299     rillig   3667:   problems.</p>
                   3668: <p>For even more automation, we recommend using
                   3669:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337     gutterid 3670:   whole set of patches. You just have to back up files before you
                   3671:   edit them to <code class="filename">filename.orig</code>, e.g., with
1.299     rillig   3672:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3673:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3674:   you upgrade a package this way, you can easily compare the new
                   3675:   set of patches with the previously existing one with
                   3676:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3677:   are replaced by new files, so carefully check if you want to take all
                   3678:   the changes.</p>
                   3679: <p>When you have finished a package, remember to generate
                   3680:   the checksums for the patch files by using the <span class="command"><strong>make
                   3681:   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>
                   3682: <p>When adding a patch that corrects a problem in the
                   3683:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3684:   man pages should go), send the patch as a bug report to the
                   3685:   maintainer.  This benefits non-pkgsrc users of the package,
                   3686:   and usually makes it possible to remove the patch in future
                   3687:   version.</p>
                   3688: <p>The file names of the patch files are usually of the form
                   3689:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3690:   Many packages still use the previous convention
                   3691:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3692:   but new patches should be of the form containing the filename.
1.322     leot     3693:   <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.299     rillig   3694:   automatically.</p>
1.337     gutterid 3695: <p>When updating pre-existing patch files, if a file uses the old
                   3696:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
                   3697:   convention, it's best not to change it to the new form, as that will
                   3698:   just cause churn that makes it harder to track changes to patching
                   3699:   over time. Similarly, if a patch now applies at different line offsets,
                   3700:   but still applies cleanly as-is, there's no need to update it, as that
                   3701:   also unnecessarily complicates the patch history.</p>
1.118     imil     3702: </div>
1.275     brook    3703: <div class="sect2">
                   3704: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3705: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3706: <p>If you want to share patches between multiple packages
                   3707:   in pkgsrc, e.g. because they use the same distfiles, set
                   3708:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3709:   can be found, e.g.:</p>
                   3710: <pre class="programlisting">
                   3711: PATCHDIR=       ../../editors/xemacs/patches
                   3712: </pre>
                   3713: <p>Patch files that are distributed by the author or other
                   3714:     maintainers can be listed in
                   3715:     <code class="varname">PATCHFILES</code>.</p>
                   3716: <p>If it is desired to store any patches that should not be
                   3717:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3718:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3719:     directory tree there is expected to have the same
                   3720:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3721:     patches are expected to be stored inside these dirs (also
                   3722:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3723:     example, if you want to keep a private patch for
                   3724:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3725:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3726:     files in the named directory are expected to be patch files,
                   3727:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3728:     applied</em></span>.</p>
1.275     brook    3729: </div>
                   3730: <div class="sect2">
                   3731: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3732: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3733: <p>When fixing a portability issue in the code do not use
                   3734:       preprocessor magic to check for the current operating system nor
                   3735:       platform.  Doing so hurts portability to other platforms because
                   3736:       the OS-specific details are not abstracted appropriately.</p>
                   3737: <p>The general rule to follow is: instead of checking for the
                   3738:       operating system the application is being built on, check for the
                   3739:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3740:       instead of assuming that kqueue is available under NetBSD and
                   3741:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3742:       kqueue support, add a check that detects kqueue itself &mdash;
                   3743:       yes, this generally involves patching the
                   3744:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3745:       that prevents some OSes from adopting interfaces from other OSes
                   3746:       (e.g. Linux implementing kqueue), something that the above checks
                   3747:       cannot take into account.</p>
                   3748: <p>Of course, checking for features generally involves more
                   3749:       work on the developer's side, but the resulting changes are
                   3750:       cleaner and there are chances they will work on many other
                   3751:       platforms.  Not to mention that there are higher chances of being
                   3752:       later integrated into the mainstream sources.  Remember:
                   3753:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3754: <p>Some typical examples:</p>
                   3755: <div class="table">
                   3756: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3757: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3758: <colgroup>
                   3759: <col>
                   3760: <col>
                   3761: <col>
                   3762: </colgroup>
                   3763: <thead><tr>
                   3764: <th>Where</th>
                   3765: <th>Incorrect</th>
                   3766: <th>Correct</th>
                   3767: </tr></thead>
                   3768: <tbody>
                   3769: <tr>
                   3770: <td>configure script</td>
                   3771: <td>
1.275     brook    3772: <pre class="programlisting">
1.299     rillig   3773: case ${target_os} in
                   3774: netbsd*) have_kvm=yes ;;
                   3775: *)       have_kvm=no  ;;
                   3776: esac
1.275     brook    3777: </pre>
1.299     rillig   3778:              </td>
                   3779: <td>
1.275     brook    3780: <pre class="programlisting">
1.299     rillig   3781: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3782: </pre>
1.299     rillig   3783:              </td>
                   3784: </tr>
                   3785: <tr>
                   3786: <td>C source file</td>
                   3787: <td>
1.91      rillig   3788: <pre class="programlisting">
1.299     rillig   3789: #if defined(__NetBSD__)
                   3790: #  include &lt;sys/event.h&gt;
                   3791: #endif
1.91      rillig   3792: </pre>
1.299     rillig   3793:              </td>
                   3794: <td>
1.91      rillig   3795: <pre class="programlisting">
1.299     rillig   3796: #if defined(HAVE_SYS_EVENT_H)
                   3797: #  include &lt;sys/event.h&gt;
                   3798: #endif
1.91      rillig   3799: </pre>
1.299     rillig   3800:              </td>
                   3801: </tr>
                   3802: <tr>
                   3803: <td>C source file</td>
                   3804: <td>
1.91      rillig   3805: <pre class="programlisting">
1.299     rillig   3806: int
                   3807: monitor_file(...)
                   3808: {
                   3809: #if defined(__NetBSD__)
                   3810:         int fd = kqueue();
                   3811:         ...
                   3812: #else
                   3813:         ...
                   3814: #endif
                   3815: }
1.91      rillig   3816: </pre>
1.299     rillig   3817:              </td>
                   3818: <td>
1.91      rillig   3819: <pre class="programlisting">
1.299     rillig   3820: int
                   3821: monitor_file(...)
                   3822: {
                   3823: #if defined(HAVE_KQUEUE)
                   3824:         int fd = kqueue();
                   3825:         ...
                   3826: #else
                   3827:         ...
                   3828: #endif
                   3829: }
1.91      rillig   3830: </pre>
1.299     rillig   3831:              </td>
                   3832: </tr>
                   3833: </tbody>
                   3834: </table></div>
                   3835: </div>
                   3836: <br class="table-break">
                   3837: </div>
                   3838: <div class="sect2">
                   3839: <div class="titlepage"><div><div><h3 class="title">
                   3840: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3841: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3842:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3843:       improvements you do to a package to the mainstream developers.
                   3844:       This is the only way to get their attention on portability issues
                   3845:       and to ensure that future versions can be built out-of-the box on
                   3846:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3847:       the fixes straight from the packaged code.</p>
                   3848: <p>This generally involves cleaning up the patches
                   3849:       (because sometimes the patches that are
                   3850:       added to pkgsrc are quick hacks), filing bug reports in the
                   3851:       appropriate trackers for the projects and working with the
                   3852:       mainstream authors to accept your changes.  It is
                   3853:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3854:       the packages in pkgsrc are kept simple and thus further changes
                   3855:       can be done without much hassle.</p>
                   3856: <p>When you have done this, please add a URL to the upstream
                   3857:       bug report to the patch comment.</p>
                   3858: <p>Support the idea of free software!</p>
                   3859: </div>
1.91      rillig   3860: </div>
1.299     rillig   3861: <div class="sect1">
                   3862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3863: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3864: <div class="variablelist"><dl class="variablelist">
                   3865: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3866: <dd><p>A multi-line description of the piece of software.  This should include
                   3867:          any credits where they are due.  Please bear in mind that others do not
                   3868:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3869:          will read everything that you write here.</p></dd>
                   3870: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3871: <dd><p>This file governs the files that are installed on your
                   3872:          system: all the binaries, manual pages, etc. There are other
                   3873:          directives which may be entered in this file, to control the
                   3874:          creation and deletion of directories, and the location of
                   3875:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3876:          information.</p></dd>
                   3877: </dl></div>
                   3878: </div>
                   3879: <div class="sect1">
                   3880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3881: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3882: <div class="sect2">
                   3883: <div class="titlepage"><div><div><h3 class="title">
                   3884: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3885: <div class="variablelist"><dl class="variablelist">
                   3886: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3887: <dd>
1.322     leot     3888: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   3889:            First time after package extraction and before files are
                   3890:            moved in place, the second time after the files to install
                   3891:            are moved in place. This can be used to do any custom
                   3892:            procedures not possible with @exec commands in
1.322     leot     3893:            <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
                   3894:            <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.299     rillig   3895:            Please note that you can modify variables in it easily by using
                   3896:            <code class="varname">FILES_SUBST</code> in the package's
                   3897:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3898: <pre class="programlisting">
1.299     rillig   3899: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3900: </pre>
1.299     rillig   3901: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3902:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3903:            performed for <code class="varname">PREFIX</code>,
                   3904:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3905:            <code class="varname">VARBASE</code>, and a few others, type
                   3906:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3907:            complete list.</p>
                   3908: </dd>
                   3909: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3910: <dd><p>This script is executed before and after any files are removed.  It is
                   3911:            this script's responsibility to clean up any additional messy details
                   3912:            around the package's installation, since all pkg_delete knows is how to
                   3913:            delete the files created in the original distribution.
1.322     leot     3914:            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>
                   3915:            and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   3916:            The same methods to replace variables can be used as for
                   3917:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3918: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3919: <dd>
                   3920: <p>This file is displayed after installation of the package.
1.312     gdt      3921:            While this was used often in the past, it has two
                   3922:            problems: the display will be missed if many packages are
                   3923:            intalled at once, and the person installing the package
                   3924:            and the one using or configuring it may be different.  It
                   3925:            should therefore be used only in exceptional circumstances
                   3926:            where lasting negative consequences would result from
                   3927:            someone not reading it.</p>
                   3928: <p>MESSAGE should not be used for:</p>
                   3929: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3930: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   3931: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   3932: <li class="listitem"><p>anything that should be explained in the
                   3933:              installation/configuration documentation that should
                   3934:              come with the package</p></li>
                   3935: </ul></div>
                   3936: <p>If the documentation provided by upstream needs
1.313     leot     3937:            enhancing, create e.g. files/README.pkgsrc and install it
                   3938:            in the package's documentation directory.
1.312     gdt      3939:            </p>
                   3940: <p>Note that MESSAGE is shown for all operating
                   3941:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     3942:            it should be narrowed to only those operating systems and
1.312     gdt      3943:            init systems to which it applies.</p>
                   3944: <p>Note that you can modify variables in it easily by using
1.299     rillig   3945:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3946:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3947: <pre class="programlisting">
1.299     rillig   3948: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3949: </pre>
1.299     rillig   3950: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3951:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3952:            performed for <code class="varname">PKGNAME</code>,
                   3953:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3954:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3955:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3956:            <code class="varname">ROOT_GROUP</code>, and
                   3957:            <code class="varname">ROOT_USER</code>.</p>
                   3958: <p>You can display a different or additional files by
                   3959:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3960:            default is <code class="filename">MESSAGE</code>, if the file
                   3961:            exists.</p>
                   3962: </dd>
                   3963: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3964: <dd>
                   3965: <p>This file is used by the alternatives framework.
                   3966:            It creates, configures, and destroys generic wrappers used to
                   3967:            run programs with similar interfaces.
                   3968:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3969:             for more information.</p>
                   3970: <p>Each line of the file contains two filenames, first
                   3971:            the wrapper and then the alternative provided by the package.
                   3972:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3973: </dd>
                   3974: </dl></div>
                   3975: </div>
                   3976: <div class="sect2">
                   3977: <div class="titlepage"><div><div><h3 class="title">
                   3978: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3979: <div class="variablelist"><dl class="variablelist">
                   3980: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3981: <dd><p>This file contains arbitrary things that could
                   3982:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3983:        to be used by more than one package. This file should only be
                   3984:        used when the packages that will use the file are known in
                   3985:        advance. For other purposes it is often better to write a
                   3986:        <code class="filename">*.mk</code> file and give it a good name that
                   3987:        describes what it does.</p></dd>
                   3988: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3989: <dd><p>This file contains the dependency information
                   3990:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3991: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3992: <dd><p>This file contains workarounds for compiler bugs
                   3993:        and similar things. It is included automatically by the pkgsrc
                   3994:        infrastructure, so you don't need an extra
                   3995:        <code class="literal">.include</code> line for
                   3996:        it.</p></dd>
                   3997: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3998: <dd><p>This file contains the code for the
                   3999:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   4000:        selected by the user. If a package has only one or two options,
                   4001:        it is equally acceptable to put the code directly into the
                   4002:        <code class="filename">Makefile</code>.</p></dd>
                   4003: </dl></div>
                   4004: </div>
                   4005: <div class="sect2">
                   4006: <div class="titlepage"><div><div><h3 class="title">
                   4007: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   4008: <div class="variablelist"><dl class="variablelist">
                   4009: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4010: <dd><p>These files do not take place in the creation of
                   4011:        a package and thus are purely informative to the package
                   4012:        developer.</p></dd>
                   4013: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4014: <dd><p>This file contains things that need to be done
                   4015:        to make the package even
                   4016:        better.</p></dd>
                   4017: </dl></div>
                   4018: </div>
                   4019: </div>
                   4020: <div class="sect1">
                   4021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4022: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   4023: </h2></div></div></div>
                   4024: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4025:     unpacked into the directory denoted by
                   4026:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4027:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4028:     directory is also used to keep various timestamp files.
                   4029:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4030:     The default is <code class="filename">${.CURDIR}/work</code>
                   4031:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4032:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   4033: </div>
1.299     rillig   4034: <div class="sect1">
                   4035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4036: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   4037: </h2></div></div></div>
                   4038: <p>If you have any files that you wish to be placed in the package
                   4039:     prior to configuration or building, you can place these files here
                   4040:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4041:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   4042: <p>If you want to share files in this way with other
                   4043:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4044:     to the other package's <code class="filename">files</code> directory,
                   4045:     e.g.:</p>
1.91      rillig   4046: <pre class="programlisting">
1.299     rillig   4047: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4048: </pre>
                   4049: </div>
                   4050: </div>
1.148     asau     4051: <div class="chapter">
1.75      rillig   4052: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   4053: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4054: <div class="toc">
                   4055: <p><b>Table of Contents</b></p>
1.210     leot     4056: <dl class="toc">
1.299     rillig   4057: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4058: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4059: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4060: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4061: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4062: <dd><dl>
                   4063: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4064: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4065: </dl></dd>
                   4066: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4067: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4068: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4069: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4070: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4071: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4072: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4073: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4074: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4075: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4076: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4077: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4078: </dl>
                   4079: </div>
1.148     asau     4080: <div class="sect1">
1.75      rillig   4081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4082: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4083: <p>This chapter gives a detailed description on how a package is
                   4084:     built. Building a package is separated into different
                   4085:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4086:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4087:     described in the following sections. Each phase is split into
                   4088:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4089:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4090:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4091:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4092:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4093: <p>Never override the regular targets (like
                   4094:     <code class="varname">fetch</code>), if you have to, override the
                   4095:     <code class="varname">do-*</code> ones instead.</p>
                   4096: <p>The basic steps for building a program are always the same.  First
                   4097:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4098:     the local system and then extracted. After any pkgsrc-specific patches
                   4099:     to compile properly are applied, the software can be configured, then
                   4100:     built (usually by compiling), and finally the generated binaries, etc.
                   4101:     can be put into place on the system.</p>
                   4102: <p>To get more details about what is happening at each step,
                   4103:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4104:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4105:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4106: </div>
                   4107: <div class="sect1">
                   4108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4109: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4110: <p>Before outlining the process performed by the NetBSD package system in
                   4111:     the next section, here's a brief discussion on where programs are
                   4112:     installed, and which variables influence this.</p>
                   4113: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4114:     where all files of the final program shall be installed. It is
                   4115:     usually set to <code class="varname">LOCALBASE</code>
                   4116:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4117:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4118:     <code class="varname">PREFIX</code> needs to be put
                   4119:     into the various places in the program's source where paths to
                   4120:     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>
                   4121: <p>When choosing which of these variables to use,
                   4122:     follow the following rules:</p>
1.148     asau     4123: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4124: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4125:        where the current pkg will be installed.  When referring to a
                   4126:        pkg's own installation path, use
                   4127:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
1.338   ! nia      4128: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299     rillig   4129:        are installed.  If you need to construct a -I or -L argument
                   4130:        to the compiler to find includes and libraries installed by
1.338   ! nia      4131:        another pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.299     rillig   4132:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4133:        installed all packages in <code class="filename">/usr/local</code>. As
                   4134:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4135:        administrator, this variable is a misnomer.</p></li>
                   4136: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4137:        distribution (from xsrc, etc.) is installed. When looking for
                   4138:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4139:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4140: <li class="listitem"><p>X11-based packages using imake must set
                   4141:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4142:        <code class="varname">LOCALBASE</code>.</p></li>
                   4143: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.322     leot     4144:        install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4145:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4146:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4147: </ul></div>
                   4148: </div>
                   4149: <div class="sect1">
                   4150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4151: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4152: <p>When building a package, various directories are used to store
                   4153:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4154:     directories are explained here.</p>
                   4155: <p>Some of the directory variables contain relative pathnames. There
                   4156:     are two common base directories for these relative directories:
                   4157:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4158:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4159:     inside the package itself.</p>
                   4160: <div class="variablelist"><dl class="variablelist">
                   4161: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4162: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4163:       root directory. Generally, you don't need
                   4164:       it.</p></dd>
                   4165: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4166: <dd><p>This is an absolute pathname that points to the
                   4167:       current package.</p></dd>
                   4168: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4169: <dd><p>This is a pathname relative to
                   4170:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4171:       package.</p></dd>
                   4172: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4173: <dd><p>This is an absolute pathname pointing to the directory
                   4174:       where all work takes place. The distfiles are extracted to this
                   4175:       directory. It also contains temporary directories and log files used by
                   4176:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4177:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4178: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4179: <dd><p>This is an absolute pathname pointing to the directory
                   4180:       where the distfiles are extracted. It is usually a direct subdirectory
                   4181:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4182:       that isn't hidden. This variable may be changed by a package
                   4183:       <code class="filename">Makefile</code>.</p></dd>
                   4184: </dl></div>
                   4185: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4186:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4187:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4188:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4189:     If users would like to have their pkgsrc trees behave in a
                   4190:     read-only manner, then the value of
                   4191:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4192:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4193: </div>
1.148     asau     4194: <div class="sect1">
1.75      rillig   4195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4196: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4197: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4198:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4199:     phase. This will automatically run all phases that are required for this
                   4200:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4201:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4202:     the package will be built, but not installed.</p>
1.75      rillig   4203: </div>
1.148     asau     4204: <div class="sect1">
1.75      rillig   4205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4206: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4207: <p>The first step in building a package is to fetch the
                   4208:     distribution files (distfiles) from the sites that are providing
                   4209:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4210:     phase.</p>
1.148     asau     4211: <div class="sect2">
1.93      rillig   4212: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4213: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4214: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4215:       defines all URLs from where the distfile, whose name is
                   4216:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4217:       fetched. The more complicated cases are described
                   4218:       below.</p>
                   4219: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4220:       the list of distfiles that have to be fetched. Its value
                   4221:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4222:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4223:       so that most packages don't need to define it at all.
                   4224:       <code class="varname">EXTRACT_SUFX</code> is
                   4225:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4226:       freely. Note that if your package requires additional
                   4227:       distfiles to the default one, you cannot just append the
                   4228:       additional filenames using the <code class="literal">+=</code>
                   4229:       operator, but you have write for example:</p>
                   4230: <pre class="programlisting">
                   4231: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4232: </pre>
                   4233: <p>Each distfile is fetched from a list of sites, usually
                   4234:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4235:       <code class="varname">DISTFILES</code> or multiple
                   4236:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4237:       set
                   4238:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4239:       to the list of URLs where the file
                   4240:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4241:       (including the suffix) can be found.</p>
                   4242: <pre class="programlisting">
                   4243: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4244: DISTFILES+=     foo-file.tar.gz
                   4245: SITES.foo-file.tar.gz= \
                   4246: https://www.somewhere.com/somehow/ \
                   4247: https://www.somewhereelse.com/mirror/somehow/
                   4248: </pre>
                   4249: <p>When actually fetching the distfiles, each item from
                   4250:       <code class="varname">MASTER_SITES</code> or
                   4251:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4252:       appended to it, without an intermediate slash. Therefore,
                   4253:       all site values have to end with a slash or other separator
                   4254:       character. This allows for example to set
                   4255:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4256:       that gets the name of the distfile as a parameter. In this
                   4257:       case, the definition would look like:</p>
                   4258: <pre class="programlisting">
                   4259: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4260: </pre>
                   4261: <p> The exception to this rule are URLs starting with a dash.
                   4262:       In that case the URL is taken as is, fetched and the result
                   4263:       stored under the name of the distfile. You can use this style
                   4264:       for the case when the download URL style does not match the
                   4265:       above common case. For example, if permanent download URL is a
                   4266:       redirector to the real download URL, or the download file name
                   4267:       is offered by an HTTP Content-Disposition header. In the
                   4268:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4269:       created instead of the default
                   4270:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4271: <pre class="programlisting">
                   4272: DISTNAME=       foo-1.0.0
                   4273: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4274: </pre>
                   4275: <p>There are some predefined values for
                   4276:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4277:       packages.  The names of the variables should speak for
                   4278:       themselves.</p>
                   4279: <table border="0" summary="Simple list" class="simplelist">
                   4280: <tr>
                   4281: <td>MASTER_SITE_APACHE</td>
                   4282: <td>MASTER_SITE_BACKUP</td>
                   4283: </tr>
                   4284: <tr>
                   4285: <td>MASTER_SITE_CRATESIO</td>
                   4286: <td>MASTER_SITE_CYGWIN</td>
                   4287: </tr>
                   4288: <tr>
                   4289: <td>MASTER_SITE_DEBIAN</td>
                   4290: <td>MASTER_SITE_FREEBSD</td>
                   4291: </tr>
                   4292: <tr>
                   4293: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4294: <td>MASTER_SITE_GENTOO</td>
                   4295: </tr>
                   4296: <tr>
                   4297: <td>MASTER_SITE_GITHUB</td>
                   4298: <td>MASTER_SITE_GNOME</td>
                   4299: </tr>
                   4300: <tr>
                   4301: <td>MASTER_SITE_GNU</td>
                   4302: <td>MASTER_SITE_GNUSTEP</td>
                   4303: </tr>
                   4304: <tr>
                   4305: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4306: <td>MASTER_SITE_IFARCHIVE</td>
                   4307: </tr>
                   4308: <tr>
                   4309: <td>MASTER_SITE_KDE</td>
                   4310: <td>MASTER_SITE_MOZILLA</td>
                   4311: </tr>
                   4312: <tr>
                   4313: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4314: <td>MASTER_SITE_MYSQL</td>
                   4315: </tr>
                   4316: <tr>
                   4317: <td>MASTER_SITE_NETLIB</td>
                   4318: <td>MASTER_SITE_OPENBSD</td>
                   4319: </tr>
                   4320: <tr>
                   4321: <td>MASTER_SITE_OPENOFFICE</td>
                   4322: <td>MASTER_SITE_OSDN</td>
                   4323: </tr>
                   4324: <tr>
                   4325: <td>MASTER_SITE_PERL_CPAN</td>
                   4326: <td>MASTER_SITE_PGSQL</td>
                   4327: </tr>
                   4328: <tr>
                   4329: <td>MASTER_SITE_PYPI</td>
                   4330: <td>MASTER_SITE_RUBYGEMS</td>
                   4331: </tr>
                   4332: <tr>
                   4333: <td>MASTER_SITE_R_CRAN</td>
                   4334: <td>MASTER_SITE_SOURCEFORGE</td>
                   4335: </tr>
1.85      jmmv     4336: <tr>
1.299     rillig   4337: <td>MASTER_SITE_SUNSITE</td>
                   4338: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4339: </tr>
                   4340: <tr>
1.299     rillig   4341: <td>MASTER_SITE_TEX_CTAN</td>
                   4342: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4343: </tr>
                   4344: <tr>
1.299     rillig   4345: <td>MASTER_SITE_XEMACS</td>
                   4346: <td>MASTER_SITE_XORG</td>
                   4347: </tr>
                   4348: </table>
                   4349: <p>Some explanations for the less self-explaining ones:
                   4350:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4351:       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
                   4352:       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>
                   4353: <p>If you choose one of these predefined sites, you may
                   4354:       want to specify a subdirectory of that site. Since these
                   4355:       macros may expand to more than one actual site, you
                   4356:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4357:       specify a subdirectory:</p>
1.100     rillig   4358: <pre class="programlisting">
1.299     rillig   4359: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4360: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4361: </pre>
1.299     rillig   4362: <p>Note the trailing slash after the subdirectory
                   4363:       name.</p>
                   4364: </div>
                   4365: <div class="sect2">
                   4366: <div class="titlepage"><div><div><h3 class="title">
                   4367: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4368: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4369:       all the distfiles exist in a local directory
                   4370:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4371:       user). If the files do not exist, they are fetched using
                   4372:       commands of the form</p>
1.100     rillig   4373: <pre class="programlisting">
1.299     rillig   4374: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4375: </pre>
                   4376: <p>where <code class="literal">${site}</code> varies through
                   4377:       several possibilities in turn: first,
                   4378:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4379:       sites specified in either <code class="varname">SITES.file</code> if
                   4380:       defined, else <code class="varname">MASTER_SITES</code> or
                   4381:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4382:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4383:       all except the first and the last can be optionally sorted
                   4384:       by the user, via setting either
                   4385:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4386:       <code class="varname">MASTER_SORT_AWK</code> or
                   4387:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4388: <p> The specific command and arguments used depend on the
                   4389:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4390:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4391: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4392:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4393:       distfiles, if they are freely distributable.  Packages setting
                   4394:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4395:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4396:       mirrored.</p>
1.85      jmmv     4397: </div>
                   4398: </div>
1.299     rillig   4399: <div class="sect1">
                   4400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4401: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4402: <p>After the distfile(s) are fetched, their checksum is
                   4403:     generated and compared with the checksums stored in the
                   4404:     distinfo file. If the checksums don't match, the build is
                   4405:     aborted. This is to ensure the same distfile is used for
                   4406:     building, and that the distfile wasn't changed, e.g. by some
                   4407:     malign force, deliberately changed distfiles on the master
                   4408:     distribution site or network lossage.</p>
1.75      rillig   4409: </div>
1.148     asau     4410: <div class="sect1">
1.75      rillig   4411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4412: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4413: <p>When the distfiles are present on the local system, they
                   4414:     need to be extracted, as they usually come in the form of some
                   4415:     compressed archive format.</p>
                   4416: <p>By default, all <code class="varname">DISTFILES</code> are
                   4417:     extracted. If you only need some of them, you can set the
                   4418:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4419:     files.</p>
                   4420: <p>Extracting the files is usually done by a little
                   4421:     program, <code class="filename">mk/extract/extract</code>, which
                   4422:     already knows how to extract various archive formats, so most
                   4423:     likely you will not need to change anything here. But if you
                   4424:     need, the following variables may help you:</p>
1.148     asau     4425: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4426: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4427: <dd><p>Use these variables to override the default
                   4428:       options for an extract command, which are defined in
                   4429:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4430: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4431: <dd><p>This variable can be set to
                   4432:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4433:       (which is the default value), <code class="literal">pax</code>, or an
                   4434:       absolute pathname pointing to the command with which tar
                   4435:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4436:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4437: </dl></div>
1.299     rillig   4438: <p>If the <code class="filename">extract</code> program doesn't
                   4439:     serve your needs, you can also override the
                   4440:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4441:     command used for extracting the files. This command is
                   4442:     executed in the <code class="filename">${WRKSRC}</code>
                   4443:     directory. During execution of this command, the shell
                   4444:     variable <code class="varname">extract_file</code> holds the absolute
                   4445:     pathname of the file that is going to be extracted.</p>
                   4446: <p>And if that still does not suffice, you can override the
                   4447:     <code class="varname">do-extract</code> target in the package
                   4448:     Makefile.</p>
1.75      rillig   4449: </div>
1.148     asau     4450: <div class="sect1">
1.75      rillig   4451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4452: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4453: <p>After extraction, all the patches named by the
                   4454:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4455:     subdirectory of the package as well as in
                   4456:     $LOCALPATCHES/$PKGPATH (e.g.
                   4457:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4458:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4459:     <code class="filename">.gz</code> are uncompressed before they are
                   4460:     applied, files ending in <code class="filename">.orig</code> or
                   4461:     <code class="filename">.rej</code> are ignored. Any special options to
1.322     leot     4462:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299     rillig   4463:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.322     leot     4464: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4465:     fail if the expected text from the patch context is not found in the
                   4466:     patched file. If that happens, fix the patch file by comparing it
                   4467:     with the actual text in the file to be patched.</p>
1.78      rillig   4468: </div>
1.148     asau     4469: <div class="sect1">
1.75      rillig   4470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4471: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4472: <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>.
                   4473:     </p>
1.75      rillig   4474: </div>
1.148     asau     4475: <div class="sect1">
1.75      rillig   4476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4477: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4478: <p>This phase creates wrapper programs for the compilers and
                   4479:     linkers. The following variables can be used to tweak the
                   4480:     wrappers.</p>
                   4481: <div class="variablelist"><dl class="variablelist">
                   4482: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4483: <dd><p>The command used to print progress
                   4484:       messages. Does nothing by default. Set to
                   4485:       <code class="literal">${ECHO}</code> to see the progress
                   4486:       messages.</p></dd>
                   4487: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4488: <dd><p>This variable can be set to
                   4489:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4490:       depending on whether you want additional information in the
                   4491:       wrapper log file.</p></dd>
                   4492: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4493: <dd><p>This variable can be set to
                   4494:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4495:       on whether the wrapper should use its cache, which will
                   4496:       improve the speed. The default value is
                   4497:       <code class="literal">yes</code>, but is forced to
                   4498:       <code class="literal">no</code> if the platform does not support
                   4499:       it.</p></dd>
                   4500: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4501: <dd><p>A list of reordering commands. A reordering
                   4502:       command has the form
                   4503:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4504:       It ensures that that
                   4505:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4506:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4507:       </p></dd>
                   4508: </dl></div>
                   4509: </div>
                   4510: <div class="sect1">
                   4511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4512: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4513: <p>Most pieces of software need information on the header
                   4514:     files, system calls, and library routines which are available
                   4515:     on the platform they run on. The process of determining this
                   4516:     information is known as configuration, and is usually
                   4517:     automated. In most cases, a script is supplied with the
                   4518:     distfiles, and its invocation results in generation of header
                   4519:     files, Makefiles, etc.</p>
                   4520: <p>If the package contains a configure script, this can be
                   4521:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4522:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4523:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301     rillig   4524:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4525: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4526:     equivalent of the following command is run. See
                   4527:     <code class="filename">mk/configure/configure.mk</code>, target
                   4528:     <code class="literal">do-configure-script</code> for the exact
                   4529:     definition.</p>
                   4530: <pre class="programlisting">
                   4531: .for dir in ${CONFIGURE_DIRS}
                   4532:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4533:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4534:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4535: .endfor
1.100     rillig   4536: </pre>
1.299     rillig   4537: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4538:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4539:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4540:     configure script is run with the environment
                   4541:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4542:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4543:     <code class="varname">CONFIGURE_ENV</code>,
                   4544:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4545:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4546:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4547:     package.</p>
                   4548: <p>If the program uses the Perl way of configuration (mainly Perl
                   4549:     modules, but not only), i.e. a file called
                   4550:     <code class="filename">Makefile.PL</code>, it should include
                   4551:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4552:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4553:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4554: <p>If the program uses an <code class="filename">Imakefile</code>
                   4555:     for configuration, the appropriate steps can be invoked by
                   4556:     setting <code class="varname">USE_IMAKE</code> to
                   4557:     <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>.
                   4558:     You can add variables to xmkmf's environment by adding them to the
                   4559:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4560: <p>If the program uses <code class="filename">cmake</code>
                   4561:     for configuration, the appropriate steps can be invoked by
                   4562:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4563:     You can add variables to cmake's environment by adding them to the
                   4564:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4565:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4566:     The top directory argument is given by the
                   4567:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4568:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4569: <p>If there is no configure step at all, set
                   4570:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4571: </div>
1.148     asau     4572: <div class="sect1">
1.75      rillig   4573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4574: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4575: <p>For building a package, a rough equivalent of the following
                   4576:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4577:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4578: <pre class="programlisting">
1.301     rillig   4579: .for dir in ${BUILD_DIRS}
                   4580:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4581:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4582:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4583:                 -f ${MAKE_FILE} \
                   4584:                 ${BUILD_TARGET}
                   4585: .endfor
1.97      rillig   4586: </pre>
1.299     rillig   4587: <p><code class="varname">BUILD_DIRS</code> (default:
                   4588:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4589:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4590:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4591:     <code class="varname">MAKE_ENV</code> and arguments
                   4592:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4593:     <code class="varname">MAKE_ENV</code>,
                   4594:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4595:     <code class="varname">MAKE_FILE</code> and
                   4596:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4597:     package.</p>
                   4598: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4599:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4600:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4601:     default value of <code class="varname">MAKE_FILE</code> is
                   4602:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4603:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4604: <p>If there is no build step at all, set
                   4605:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4606: </div>
1.148     asau     4607: <div class="sect1">
1.97      rillig   4608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4609: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4610: <p>[TODO]</p>
1.75      rillig   4611: </div>
1.148     asau     4612: <div class="sect1">
1.75      rillig   4613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4614: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4615: <p>Once the build stage has completed, the final step is to
                   4616:     install the software in public directories, so users can
                   4617:     access the programs and files.</p>
1.301     rillig   4618: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4619:     of the following code is executed; see
                   4620:     <code class="filename">mk/install/install.mk</code>, target
                   4621:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4622:     before and after this code, several consistency checks are run
                   4623:     against the files-to-be-installed, see
                   4624:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4625: <pre class="programlisting">
                   4626: .for dir in ${INSTALL_DIRS}
                   4627:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4628:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4629:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4630:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4631: .endfor
1.220     wiz      4632: </pre>
1.299     rillig   4633: <p>The variable's meanings are analogous to the ones in the
                   4634:     <span class="emphasis"><em>build</em></span> phase.
                   4635:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4636:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4637:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4638:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4639:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4640:     defined.</p>
                   4641: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4642:     variables are useful. They are all variations of the
1.322     leot     4643:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4644:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4645:     install command. The specialized variants, together with their
                   4646:     intended use, are:</p>
                   4647: <div class="variablelist"><dl class="variablelist">
                   4648: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4649: <dd><p>directories that contain
                   4650:       binaries</p></dd>
                   4651: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4652: <dd><p>directories that contain
                   4653:       scripts</p></dd>
                   4654: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4655: <dd><p>directories that contain shared and static
                   4656:       libraries</p></dd>
                   4657: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4658: <dd><p>directories that contain data
                   4659:       files</p></dd>
                   4660: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4661: <dd><p>directories that contain man
                   4662:       pages</p></dd>
                   4663: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4664: <dd><p>directories that contain data files for games
                   4665:       </p></dd>
                   4666: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4667: <dd><p>binaries that can be stripped from debugging
                   4668:       symbols</p></dd>
                   4669: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4670: <dd><p>binaries that cannot be
                   4671:       stripped</p></dd>
                   4672: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4673: <dd><p>game
                   4674:       binaries</p></dd>
                   4675: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4676: <dd><p>shared and static
                   4677:       libraries</p></dd>
                   4678: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4679: <dd><p>data files</p></dd>
                   4680: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4681: <dd><p>data files for
                   4682:       games</p></dd>
                   4683: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4684: <dd><p>man pages</p></dd>
                   4685: </dl></div>
                   4686: <p>Some other variables are:</p>
                   4687: <div class="variablelist"><dl class="variablelist">
                   4688: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.322     leot     4689: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4690:       when installing binaries. Any debugging sections and symbols present in
                   4691:       binaries will be preserved.
                   4692:       </p></dd>
                   4693: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4694: <dd><p>A list of directories relative to
                   4695:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4696:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4697:       The package is supposed to create all needed directories itself
                   4698:       before installing files to it and list all other directories here.
                   4699:       </p></dd>
                   4700: </dl></div>
                   4701: <p>In the rare cases that a package shouldn't install anything,
                   4702:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4703:     mostly relevant for packages in the <code class="filename">regress</code>
                   4704:     category.</p>
1.75      rillig   4705: </div>
1.148     asau     4706: <div class="sect1">
1.75      rillig   4707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4708: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4709: <p>Once the install stage has completed, a binary package of
                   4710:     the installed files can be built.  These binary packages can be
                   4711:     used for quick installation without previous compilation, e.g. by
                   4712:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4713:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4714: <p>By default, the binary packages are created in
                   4715:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4716:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4717:     one for each category in the <code class="varname">CATEGORIES</code>
                   4718:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4719:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4720: </div>
1.148     asau     4721: <div class="sect1">
1.75      rillig   4722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4723: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4724: <p>Once you're finished with a package, you can clean the work
                   4725:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4726:     to clean the work directories of all dependencies too, use
                   4727:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4728: </div>
1.148     asau     4729: <div class="sect1">
1.75      rillig   4730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4731: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4732: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4733: <dt><span class="term">pre/post-*</span></dt>
                   4734: <dd>
                   4735: <p>For any of the main targets described in the previous
                   4736:          section (configure, build, install, etc.), two auxiliary
                   4737:          targets exist with
                   4738:          <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
                   4739:          prefix for the main target's name.  These targets are
                   4740:          invoked before and after the main target is called,
                   4741:          allowing extra configuration or installation steps be
                   4742:          performed from a package's Makefile, for example, which
                   4743:          a program's configure script or install target
                   4744:          omitted.</p>
                   4745: <p>About 5% of the pkgsrc packages define their custom
                   4746:          post-extract target, another 5% define pre-configure, and 10%
                   4747:          define post-install. The other pre/post-* targets are defined
                   4748:          even less often.</p>
                   4749: </dd>
                   4750: <dt><span class="term">do-*</span></dt>
1.75      rillig   4751: <dd>
1.299     rillig   4752: <p>Should one of the main targets do the wrong thing,
                   4753:          and should there be no variable to fix this, you can
                   4754:          redefine it with the do-* target.  (Note that redefining
                   4755:          the target itself instead of the do-* target is a bad
                   4756:          idea, as the pre-* and post-* targets won't be called
                   4757:          anymore, etc.)</p>
                   4758: <p>About 15% of the pkgsrc packages override the default
                   4759:          do-install, the other do-* targets are overridden even less
                   4760:          often.</p>
1.75      rillig   4761: </dd>
1.299     rillig   4762: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4763: <dd>
1.299     rillig   4764: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4765:          you noticed some file was not installed properly, you
                   4766:          can repeat the installation with this target, which will
                   4767:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4768: <p>This is the default value of
                   4769:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4770:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4771:          package</strong></span>, where the defaults are
                   4772:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4773:          respectively.</p>
1.75      rillig   4774: </dd>
1.299     rillig   4775: <dt><span class="term">deinstall</span></dt>
                   4776: <dd>
1.322     leot     4777: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4778:          current directory, effectively de-installing the
                   4779:          package. The following variables can be used to tune the
                   4780:          behaviour:</p>
                   4781: <div class="variablelist"><dl class="variablelist">
                   4782: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.322     leot     4783: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4784: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4785: <dd><p>Remove all packages that require (depend on)
                   4786:                the given package.  This can be used to remove any
                   4787:                packages that may have been pulled in by a given
                   4788:                package, e.g. if <span class="command"><strong>make deinstall
                   4789:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4790:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4791:                likely to remove whole KDE. Works by adding
1.322     leot     4792:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   4793:                command line.</p></dd>
                   4794: </dl></div>
                   4795: </dd>
                   4796: <dt><span class="term">bin-install</span></dt>
                   4797: <dd><p>Install a binary package from local disk and via FTP
                   4798:          from a list of sites (see the
                   4799:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4800:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4801:          available anywhere.  The arguments given to
                   4802:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4803:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4804:          operation, etc.</p></dd>
                   4805: <dt><span class="term">install-clean</span></dt>
                   4806: <dd><p>This target removes the state files for the "install" and later
                   4807:          phases so that the "install" target may be re-invoked. This can be
                   4808:          used after editing the PLIST to install the package without
                   4809:          rebuilding it.</p></dd>
                   4810: <dt><span class="term">build-clean</span></dt>
                   4811: <dd><p>This target removes the state files for the "build" and later
                   4812:          phases so that the "build" target may be re-invoked.</p></dd>
                   4813: <dt><span class="term">update</span></dt>
                   4814: <dd>
                   4815: <p>This target causes the current package to be
                   4816:          updated to the latest version.  The package and all
                   4817:          depending packages first get de-installed, then current
                   4818:          versions of the corresponding packages get compiled and
                   4819:          installed.  This is similar to manually noting which
                   4820:          packages are currently installed, then performing a
                   4821:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4822:          <span class="command"><strong>make install</strong></span> (or whatever
                   4823:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4824:          packages.</p>
                   4825: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4826:          resume package updating in case a previous <span class="command"><strong>make
                   4827:          update</strong></span> was interrupted for some reason.
                   4828:          However, in this case, make sure you don't call
                   4829:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4830:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4831:          Otherwise, you lose the ability to automatically update
                   4832:          the current package along with the dependent packages
                   4833:          you have installed.</p>
                   4834: <p>Resuming an interrupted <span class="command"><strong>make
                   4835:          update</strong></span> will only work as long as the package
                   4836:          tree remains unchanged.  If the source code for one of
                   4837:          the packages to be updated has been changed, resuming
                   4838:          <span class="command"><strong>make update</strong></span> will most certainly
                   4839:          fail!</p>
                   4840: <p>The following variables can be used either on the
                   4841:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4842:          alter the behaviour of <span class="command"><strong>make
                   4843:          update</strong></span>:</p>
                   4844: <div class="variablelist"><dl class="variablelist">
                   4845: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4846: <dd><p>Install target to recursively use for the
                   4847:                updated package and the dependent packages.
                   4848:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4849:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4850:                <span class="command"><strong>make update</strong></span>.  Other good
                   4851:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4852:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4853:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4854:                endless loop!</p></dd>
                   4855: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4856: <dd><p>Don't clean up after updating.  Useful if
                   4857:                you want to leave the work sources of the updated
                   4858:                packages around for inspection or other purposes.
                   4859:                Be sure you eventually clean up the source tree
                   4860:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4861:                or you may run into troubles with old source code
                   4862:                still lying around on your next
                   4863:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4864:                update</strong></span>.</p></dd>
                   4865: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4866: <dd><p>Deinstall each package before installing
                   4867:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4868:                may be necessary if the
                   4869:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4870:                called after interrupting a running <span class="command"><strong>make
                   4871:                update</strong></span>.</p></dd>
                   4872: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4873: <dd><p>Allows you to disable recursion and hardcode
                   4874:                the target for packages.  The default is
                   4875:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4876:                facilitating a recursive update of prerequisite
                   4877:                packages.  Only set
                   4878:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4879:                disable recursive updates. Use
                   4880:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4881:                set a specific target for each package to be
                   4882:                installed during <span class="command"><strong>make update</strong></span>
                   4883:                (see above).</p></dd>
                   4884: </dl></div>
                   4885: </dd>
                   4886: <dt><span class="term">clean-update</span></dt>
                   4887: <dd>
                   4888: <p>Clean the source tree for all packages that would
                   4889:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4890:          from the current directory.  This target should not be
                   4891:          used if the current package (or any of its depending
                   4892:          packages) have already been de-installed (e.g., after
                   4893:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4894:          some packages you intended to update. As a rule of
                   4895:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4896:          the first time you run <span class="command"><strong>make update</strong></span>
                   4897:          and only if you have a dirty package tree (e.g., if you
                   4898:          used <code class="varname">NOCLEAN</code>).</p>
                   4899: <p>If you are unsure about whether your tree is
                   4900:          clean, you can either perform a <span class="command"><strong>make
                   4901:          clean</strong></span> at the top of the tree, or use the
                   4902:          following sequence of commands from the directory of the
                   4903:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4904:          running <span class="command"><strong>make update</strong></span> for the first
                   4905:          time, otherwise you lose all the packages you wanted to
                   4906:          update!):</p>
                   4907: <pre class="screen">
                   4908: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4909: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4910: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4911:          </pre>
                   4912: <p>The following variables can be used either on the
                   4913:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4914:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4915: <div class="variablelist"><dl class="variablelist">
                   4916: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4917: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4918:                reconstruct the list of directories to update for
                   4919:                this package.  Only use this if <span class="command"><strong>make
                   4920:                update</strong></span> successfully installed all
                   4921:                packages you wanted to update.  Normally, this is
                   4922:                done automatically on <span class="command"><strong>make
                   4923:                update</strong></span>, but may have been suppressed by
                   4924:                the <code class="varname">NOCLEAN</code> variable (see
                   4925:                above).</p></dd>
                   4926: </dl></div>
                   4927: </dd>
                   4928: <dt><span class="term">replace</span></dt>
                   4929: <dd>
                   4930: <p>Update the installation of the current package.  This
                   4931:          differs from update in that it does not replace dependent
1.322     leot     4932:          packages.  You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.299     rillig   4933:          target to work.</p>
                   4934: <p><span class="emphasis"><em>Be careful when using this
                   4935:          target!</em></span> There are no guarantees that dependent
                   4936:          packages will still work, in particular they will most
                   4937:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4938:          library package whose shared library major version changed
                   4939:          between your installed version and the new one.  For this
                   4940:          reason, this target is not officially supported and only
                   4941:          recommended for advanced users.</p>
                   4942: </dd>
                   4943: <dt><span class="term">info</span></dt>
1.322     leot     4944: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   4945:          package. You can use this to check which version of a
                   4946:          package is installed.</p></dd>
                   4947: <dt><span class="term">index</span></dt>
                   4948: <dd>
                   4949: <p>This is a top-level command, i.e. it should be used in
                   4950:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4951:          database of all packages in the local pkgsrc tree, including
                   4952:          dependencies, comment, maintainer, and some other useful
                   4953:          information.  Individual entries are created by running
                   4954:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4955:          directories.  This index file is saved as
                   4956:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4957:          verbose format by running <span class="command"><strong>make
                   4958:          print-index</strong></span>.  You can search in it with
                   4959:          <span class="command"><strong>make search
                   4960:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4961:          extract a list of all packages that depend on a particular
                   4962:          one by running <span class="command"><strong>make show-deps
                   4963:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4964: <p>Running this command takes a very long time, some
                   4965:          hours even on fast machines!</p>
                   4966: </dd>
                   4967: <dt><span class="term">readme</span></dt>
                   4968: <dd>
                   4969: <p>This target generates a
1.314     nia      4970:          <code class="filename">index.html</code> file, which can be
1.322     leot     4971:          viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.299     rillig   4972:          contain references to any packages which are in the
                   4973:          <code class="varname">PACKAGES</code> directory on the local
                   4974:          host. The generated files can be made to refer to URLs
                   4975:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4976:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      4977:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   4978:          files which pointed to binary packages on the local
                   4979:          machine, in the directory
                   4980:          <code class="filename">/usr/packages</code>, set
                   4981:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4982:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4983:          <code class="varname">${PACKAGES}</code> directory and its
                   4984:          subdirectories will be searched for all the binary
                   4985:          packages.</p>
                   4986: <p>The target can be run at the toplevel or in category
                   4987:          directories, in which case it descends recursively.</p>
                   4988: </dd>
                   4989: <dt><span class="term">readme-all</span></dt>
                   4990: <dd><p>This is a top-level command, run it in
                   4991:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4992:          file <code class="filename">README-all.html</code> which contains a
                   4993:          list of all packages currently available in the NetBSD
                   4994:          Packages Collection, together with the category they belong
                   4995:          to and a short description. This file is compiled from the
1.314     nia      4996:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   4997:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4998:          readme</strong></span>.</p></dd>
                   4999: <dt><span class="term">cdrom-readme</span></dt>
                   5000: <dd><p>This is very much the same as the
                   5001:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   5002:          used when generating a pkgsrc tree to be written to a
                   5003:          CD-ROM.  This target also produces
1.314     nia      5004:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   5005:          to refer to URLs based on
                   5006:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   5007:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   5008: <dt><span class="term">show-distfiles</span></dt>
                   5009: <dd><p>This target shows which distfiles and patchfiles
                   5010:          are needed to build the package
                   5011:          (<code class="varname">ALLFILES</code>, which contains all
                   5012:          <code class="varname">DISTFILES</code> and
                   5013:          <code class="varname">PATCHFILES</code>, but not
                   5014:          <code class="filename">patches/*</code>).</p></dd>
                   5015: <dt><span class="term">show-downlevel</span></dt>
                   5016: <dd><p>This target shows nothing if the package is not
                   5017:          installed. If a version of this package is installed,
                   5018:          but is not the version provided in this version of
                   5019:          pkgsrc, then a warning message is displayed. This target
                   5020:          can be used to show which of your installed packages are
                   5021:          downlevel, and so the old versions can be deleted, and
                   5022:          the current ones added.</p></dd>
                   5023: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5024: <dd><p>This target shows the directory in the pkgsrc
                   5025:          hierarchy from which the package can be built and
                   5026:          installed. This may not be the same directory as the one
                   5027:          from which the package was installed. This target is
                   5028:          intended to be used by people who may wish to upgrade
                   5029:          many packages on a single host, and can be invoked from
                   5030:          the top-level pkgsrc Makefile by using the
                   5031:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   5032: <dt><span class="term">show-installed-depends</span></dt>
                   5033: <dd><p>This target shows which installed packages match
                   5034:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5035:          if out of date dependencies are causing build
                   5036:          problems.</p></dd>
                   5037: <dt><span class="term">print-build-depends-list</span></dt>
                   5038: <dd><p>This target shows the list of packages that the current package
                   5039:            depends on for building.</p></dd>
                   5040: <dt><span class="term">print-run-depends-list</span></dt>
                   5041: <dd><p>This target shows the list of packages that the current package
                   5042:            depends on for running.</p></dd>
                   5043: <dt><span class="term">check-shlibs</span></dt>
                   5044: <dd><p>After a package is installed, check all its
                   5045:          binaries and (on ELF platforms) shared libraries to see
                   5046:          if they find the shared libs they need.  Run by default
                   5047:          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>
                   5048: <dt><span class="term">print-PLIST</span></dt>
                   5049: <dd>
                   5050: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5051:          upgraded pkg, this prints out an attempt to generate a
                   5052:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5053:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5054:          to care for shared libs etc., but it is
                   5055:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5056:          result before putting it into
                   5057:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5058:          diff the output of this command against an already
                   5059:          existing <code class="filename">PLIST</code> file.</p>
1.322     leot     5060: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5061:          other methods that don't update file access times, be
                   5062:          sure to add these files manually to your
                   5063:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5064:          -newer</span>&#8221;</span> command used by this target won't catch
                   5065:          them!</p>
                   5066: <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
                   5067:          information on this target.</p>
                   5068: </dd>
                   5069: </dl></div>
                   5070: </div>
                   5071: </div>
                   5072: <div class="chapter">
                   5073: <div class="titlepage"><div><div><h2 class="title">
                   5074: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5075: <div class="toc">
                   5076: <p><b>Table of Contents</b></p>
                   5077: <dl class="toc">
                   5078: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5079: <dd><dl>
1.334     nia      5080: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   5081: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   5082: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299     rillig   5083: </dl></dd>
                   5084: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5085: <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>
                   5086: </dl>
                   5087: </div>
                   5088: <p>When you find a package that is not yet in pkgsrc, you
                   5089: most likely have a URL from where you can download the source
                   5090: code. Starting with this URL, creating a package involves only a
                   5091: few steps.</p>
                   5092: <div class="procedure"><ol class="procedure" type="1">
                   5093: <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
                   5094: enable the basic quality checks.</p></li>
                   5095: <li class="step">
1.322     leot     5096: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.299     rillig   5097: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5098: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5099: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5100: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5101: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5102: </li>
                   5103: <li class="step">
                   5104: <p>Choose one of the top-level directories as the category in
                   5105: which you want to place your package. You can also create a directory of
1.334     nia      5106: your own (maybe called <code class="filename">local</code>). Change into that
                   5107: category directory:</p>
                   5108: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.299     rillig   5109: </li>
                   5110: <li class="step">
1.334     nia      5111: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
                   5112: argument the URL of the distribution file (in most cases a
                   5113: <code class="filename">.tar.gz</code> file). This will download the distribution
                   5114: file and create the necessary files of the package, based on what's in
                   5115: the distribution file:</p>
1.299     rillig   5116: <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>
                   5117: </li>
                   5118: <li class="step">
                   5119: <p>Examine the extracted files to determine the dependencies of
                   5120: your package. Ideally, this is mentioned in some
                   5121: <code class="filename">README</code> file, but things may differ. For each of
                   5122: these dependencies, look where it exists in pkgsrc, and if there is a
                   5123: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5124: line to your package <code class="filename">Makefile</code> which includes that
                   5125: file just before the last line. If the
                   5126: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5127: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5128: that the package's include files and libraries are provided.</p>
1.334     nia      5129: <p>If you just need binaries from a dependent package, add a
1.299     rillig   5130: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5131: version of the dependency and where it can be found in pkgsrc. This line
                   5132: should be placed in the third paragraph. If the dependency is only
                   5133: needed for building the package, but not when using it, use
                   5134: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5135: instead of <code class="varname">DEPENDS</code>.
                   5136: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5137: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5138: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334     nia      5139: packages, i.e. packages for the platform where the package is built;
1.299     rillig   5140: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334     nia      5141: packages, i.e. packages for the platform for which the package
                   5142: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
                   5143: specifies a dependency used only for testing the resulting package
                   5144: built, using the upstream project's included test suite, on the native
                   5145: platform.
1.299     rillig   5146: Your package may then look like this:</p>
                   5147: <pre class="programlisting">
                   5148: [...]
                   5149: 
                   5150: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5151: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5152: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5153: 
                   5154: [...]
                   5155: 
                   5156: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5157: .include "../../devel/glib2/buildlink3.mk"
                   5158: .include "../../mk/bsd.pkg.mk"
                   5159: </pre>
                   5160: </li>
                   5161: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5162: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5163: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5164: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5165: additional explanations.</p></li>
                   5166: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5167: 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
                   5168: over there, you can hopefully continue here.</p></li>
                   5169: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5170: directory from the extracted files. Besides these files, a lot of cache
1.334     nia      5171: files and other system information have been saved in the working
                   5172: directory, which may have become outdated after you edited the
1.299     rillig   5173: <code class="filename">Makefile</code>.</p></li>
                   5174: <li class="step">
                   5175: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5176: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p>
1.334     nia      5177: <p>If the extracted files from the package need to be fixed, run
                   5178: multiple rounds of these commands:</p>
                   5179: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299     rillig   5180: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5181: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334     nia      5182: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
                   5183: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299     rillig   5184: </li>
                   5185: <li class="step"><p>When the package builds fine, the next step is to install
                   5186: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5187: everything works.</p></li>
                   5188: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5189: contains a list of the files that are installed by the package, is
                   5190: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5191: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5192: the file using your preferred text editor to see if the list of
                   5193: files looks plausible.</p></li>
                   5194: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5195: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5196: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5197: had been registered in the database of installed files, but with an
                   5198: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5199: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5200: registered with the list of files from
                   5201: <code class="filename">PLIST</code>.</p></li>
                   5202: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5203: from above again in a single step, making sure that the PLIST is correct
                   5204: and the whole package is created as intended.</p></li>
1.334     nia      5205: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
                   5206: left to do.</p></li>
1.299     rillig   5207: <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>
                   5208: </ol></div>
                   5209: <div class="sect1">
                   5210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5211: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5212: <div class="sect2">
                   5213: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5214: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299     rillig   5215: <p>Python modules and programs packages are easily created using a
                   5216: set of predefined variables.</p>
                   5217: <p>
                   5218: If some Python versions are not supported by the software, set the
                   5219: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5220: that are not supported, e.g.
                   5221: </p>
                   5222: <pre class="programlisting">
                   5223: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5224: </pre>
                   5225: <p>
                   5226: If the packaged software is a Python module, include one of
1.330     wiz      5227: <code class="filename">../../lang/python/egg.mk</code> or
1.299     rillig   5228: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.330     wiz      5229: <p>Most Python packages use setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
1.299     rillig   5230: If the packaged software is using setuptools, you only need
                   5231: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
1.330     wiz      5232: </p>
1.299     rillig   5233: <p>Either way, the package directory should be called
                   5234: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5235: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5236: </p>
                   5237: <pre class="programlisting">
                   5238: DISTNAME=   foopymodule-1.2.10
                   5239: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5240: </pre>
                   5241: <p>If it is an application, include
                   5242: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5243: In order to correctly set the path to the Python interpreter, use the
                   5244: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5245: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5246: For example:
                   5247: </p>
                   5248: <pre class="programlisting">
                   5249: REPLACE_PYTHON=   *.py
                   5250: </pre>
                   5251: <p>Some Python modules have separate distributions for Python-2.x
                   5252: and Python-3.x support. In pkgsrc this is handled by the
                   5253: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5254: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5255: packages that should be depended upon and include
                   5256: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5257: then the pkgsrc infrastructure will depend on the appropriate package
                   5258: version. For example:
                   5259: </p>
                   5260: <pre class="programlisting">
                   5261: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5262: </pre>
                   5263: <p>
                   5264: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5265: of supported packages.</p>
                   5266: </div>
                   5267: <div class="sect2">
                   5268: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5269: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299     rillig   5270: <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>
                   5271: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322     leot     5272: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.299     rillig   5273: Individual packages (and optionally their dependencies) may be created
                   5274: and updated.  R packages generally follow the same form, and most of
                   5275: the relevant information needed is contained in a
                   5276: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5277: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5278: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5279: creates or updates a package in the canonical form.  The resulting
                   5280: package should be reviewed for correctness.</p>
                   5281: </div>
                   5282: <div class="sect2">
                   5283: <div class="titlepage"><div><div><h3 class="title">
1.334     nia      5284: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299     rillig   5285: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322     leot     5286: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.299     rillig   5287: <p>If the TeXlive package name is not known, it may be useful to
                   5288: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5289: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5290: 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
                   5291: archive</a>.</p>
                   5292: <p>If the TeXlive package name is known, download the files from
                   5293: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5294: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5295: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5296: also have associated documentation packages, so download
                   5297: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5298: should be placed in the appropriate category directory, which is often
                   5299: but not always <code class="filename">print</code>.  Then run the following
                   5300: command in the category directory.</p>
                   5301: <pre class="programlisting">
                   5302: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5303: </pre>
                   5304: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5305: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5306: are correct.</p>
                   5307: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5308: currently does not include version information in package filenames
                   5309: and changes their contents periodically when updates occur.
                   5310: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5311: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5312: main one and the corresponding documentation, upload the distfiles
                   5313: with the following command in each package directory.</p>
                   5314: <pre class="programlisting">
                   5315: make upload-distfiles
                   5316: </pre>
                   5317: </div>
                   5318: </div>
                   5319: <div class="sect1">
                   5320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5321: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5322: <div class="sect2">
                   5323: <div class="titlepage"><div><div><h3 class="title">
                   5324: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5325: <div class="sect3">
                   5326: <div class="titlepage"><div><div><h4 class="title">
                   5327: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5328: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5329: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5330: pkgsrc. As the description says it has to do with the web, the obvious
                   5331: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5332: <pre class="programlisting">
                   5333: <code class="prompt">$</code> mkdir www/nvu
                   5334: <code class="prompt">$</code> cd www/nvu
                   5335: </pre>
                   5336: <p>The web site says that the sources are available as a tar file, so
                   5337: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5338: <pre class="programlisting">
                   5339: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5340: </pre>
                   5341: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5342: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5343: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5344: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5345: <code class="varname">COMMENT</code> fields. Then the package
                   5346: <code class="filename">Makefile</code> looked like that:</p>
                   5347: <pre class="programlisting">
                   5348: # $NetBSD $
                   5349: #
                   5350: 
                   5351: DISTNAME=       nvu-1.0-sources
                   5352: PKGNAME=        nvu-1.0
                   5353: CATEGORIES=     www
                   5354: MASTER_SITES=   http://cvs.nvu.com/download/
                   5355: EXTRACT_SUFX=   .tar.bz2
                   5356: 
                   5357: MAINTAINER=     rillig@NetBSD.org
                   5358: HOMEPAGE=       http://cvs.nvu.com/
                   5359: COMMENT=        Web Authoring System
                   5360: 
                   5361: # url2pkg-marker (please do not remove this line.)
                   5362: .include "../../mk/bsd.pkg.mk"
                   5363: </pre>
                   5364: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5365: this is a workaround to prevent CVS expanding to the filename of the
                   5366: guide.</p>
                   5367: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5368: source archive:</p>
                   5369: <pre class="programlisting">
                   5370: url2pkg&gt; Running "make makesum" ...
                   5371: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5372: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5373: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5374: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5375: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5376: url2pkg&gt; Running "make extract" ...
                   5377: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5378: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5379: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5380: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5381: ===&gt; Installing dependencies for nvu-1.0
                   5382: ===&gt; Overriding tools for nvu-1.0
                   5383: ===&gt; Extracting for nvu-1.0
                   5384: url2pkg&gt; Adjusting the Makefile.
                   5385: 
                   5386: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5387: 
                   5388: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5389: </pre>
                   5390: </div>
                   5391: <div class="sect3">
                   5392: <div class="titlepage"><div><div><h4 class="title">
                   5393: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5394: <p>Now that the package has been extracted, let's see what's inside
                   5395: it. The package has a <code class="filename">README.txt</code>, but that only
                   5396: says something about mozilla, so it's probably useless for seeing what
                   5397: dependencies this package has. But since there is a GNU configure script
                   5398: in the package, let's hope that it will complain about everything it
                   5399: needs.</p>
                   5400: <pre class="programlisting">
                   5401: <code class="prompt">$</code> bmake
                   5402: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5403: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5404: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5405: ===&gt; Patching for nvu-1.0
                   5406: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5407: ===&gt; Configuring for nvu-1.0
                   5408: [...]
                   5409: configure: error: Perl 5.004 or higher is required.
                   5410: [...]
                   5411: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5412: [...]
                   5413: </pre>
                   5414: <p>That worked quite well. So I opened the package Makefile in my
                   5415: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5416: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5417: package have changed now, and since a perl wrapper is automatically
                   5418: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5419: from scratch.</p>
                   5420: <pre class="programlisting">
                   5421: <code class="prompt">$</code> bmake clean
                   5422: ===&gt; Cleaning for nvu-1.0
                   5423: <code class="prompt">$</code> bmake
                   5424: [...]
                   5425: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5426: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5427: [...]
                   5428: </pre>
                   5429: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5430: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5431: <pre class="programlisting">
                   5432: [...]
                   5433: checking for GTK - version &gt;= 1.2.0... no
                   5434: *** Could not run GTK test program, checking why...
                   5435: [...]
                   5436: </pre>
                   5437: <p>Now to the other dependencies. The first question is: Where is the
                   5438: GTK package hidden in pkgsrc?</p>
                   5439: <pre class="programlisting">
                   5440: <code class="prompt">$</code> echo ../../*/gtk*
                   5441: [many packages ...]
                   5442: <code class="prompt">$</code> echo ../../*/gtk
                   5443: ../../x11/gtk
                   5444: <code class="prompt">$</code> echo ../../*/gtk2
                   5445: ../../x11/gtk2
                   5446: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5447: ../../x11/gtk2/buildlink3.mk
                   5448: </pre>
                   5449: <p>The first try was definitely too broad. The second one had exactly
                   5450: one result, which is very good. But there is one pitfall with GNOME
                   5451: packages. Before GNOME 2 had been released, there were already many
                   5452: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5453: packages, the GNOME 2 packages were imported as separate packages, and
                   5454: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5455: whether this was the case here, and indeed it was.</p>
                   5456: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5457: file, adding the dependency is very easy. I just inserted an
                   5458: <code class="literal">.include</code> line before the last line of the package
                   5459: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5460: <pre class="programlisting">
                   5461: [...]
                   5462: .include "../../x11/gtk2/buildlink3.mk"
                   5463: .include "../../mk/bsd.pkg.mk
                   5464: </pre>
                   5465: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5466: was:</p>
1.75      rillig   5467: <pre class="programlisting">
1.299     rillig   5468: [...]
                   5469: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5470: checking for GTK - version &gt;= 1.2.0... no
                   5471: *** Could not run GTK test program, checking why...
                   5472: *** The test program failed to compile or link. See the file config.log for the
                   5473: *** exact error that occured. This usually means GTK was incorrectly installed
                   5474: *** or that you have moved GTK since it was installed. In the latter case, you
                   5475: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5476: configure: error: Test for GTK failed.
                   5477: [...]
1.222     sevan    5478: </pre>
1.299     rillig   5479: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5480: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5481: told me that this package really wanted to have the GNOME 1 version of
                   5482: GTK. If the package had looked for GTK2, it would have looked for
                   5483: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5484: So I changed the <code class="literal">x11/gtk2</code> to
                   5485: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5486: and tried again.</p>
1.119     mishka   5487: <pre class="programlisting">
1.299     rillig   5488: [...]
                   5489: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5490: In file included from xpidl.c:42:
                   5491: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5492: In file included from xpidl.c:42:
                   5493: xpidl.h:132: error: parse error before "IDL_ns"
                   5494: [...]
1.222     sevan    5495: </pre>
1.299     rillig   5496: <p>The package still does not find all of its dependencies. Now the
                   5497: question is: Which package provides the
                   5498: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5499: <pre class="programlisting">
1.299     rillig   5500: <code class="prompt">$</code> echo ../../*/*idl*
                   5501: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5502: <code class="prompt">$</code> echo ../../*/*IDL*
                   5503: ../../net/libIDL
1.222     sevan    5504: </pre>
1.299     rillig   5505: <p>Let's take the one from the second try. So I included the
                   5506: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5507: again. But the error didn't change. After digging through some of the
                   5508: code, I concluded that the build process of the package was broken and
                   5509: couldn't have ever worked, but since the Mozilla source tree is quite
                   5510: large, I didn't want to fix it. So I added the following to the package
                   5511: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5512: <pre class="programlisting">
1.299     rillig   5513: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5514: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5515: </pre>
1.299     rillig   5516: <p>The latter line is needed because the package expects the library
                   5517: <code class="filename">libIDL.so</code>, but only
                   5518: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5519: wrapper to rewrite that on the fly.</p>
                   5520: <p>The next problem was related to a recent change of the FreeType
1.322     leot     5521: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.299     rillig   5522: which patch files were relevant for this issue and copied them to the
                   5523: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5524: patches so that they applied cleanly and retried again. This time,
                   5525: everything worked.</p>
1.197     wiz      5526: </div>
1.299     rillig   5527: <div class="sect3">
                   5528: <div class="titlepage"><div><div><h4 class="title">
                   5529: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5530: <pre class="programlisting">
1.299     rillig   5531: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5532: [...]
                   5533: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5534: <code class="prompt">$</code> bmake deinstall
                   5535: <code class="prompt">$</code> bmake install
1.222     sevan    5536: </pre>
1.299     rillig   5537: </div>
                   5538: </div>
1.75      rillig   5539: </div>
                   5540: </div>
1.148     asau     5541: <div class="chapter">
1.75      rillig   5542: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5543: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5544: <div class="toc">
                   5545: <p><b>Table of Contents</b></p>
1.210     leot     5546: <dl class="toc">
1.299     rillig   5547: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5548: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5549: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5550: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5551: <dd><dl>
                   5552: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5553: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5554: <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>
                   5555: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   5556: </dl></dd>
                   5557: </dl>
                   5558: </div>
1.299     rillig   5559: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5560:   each of which forms a well-defined part of the pkgsrc system. Using
1.322     leot     5561:   the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299     rillig   5562:   like pkgsrc requires some discipline to keep the code correct and
                   5563:   understandable.</p>
                   5564: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5565:   programming are variables and shell
                   5566:   commands. Among these shell commands may even be more complex ones
1.322     leot     5567:   like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299     rillig   5568:   as intended it is necessary to quote all variables correctly when they
                   5569:   are used.</p>
                   5570: <p>This chapter describes some patterns that appear quite often in
                   5571:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5572:   with them.</p>
1.148     asau     5573: <div class="sect1">
1.75      rillig   5574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5575: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5577: <p>When you are creating a file as a
                   5578:     target of a rule, always write the data to a temporary file first
                   5579:     and finally rename that file. Otherwise there might occur an error
                   5580:     in the middle of generating the file, and when the user runs
1.322     leot     5581:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299     rillig   5582:     regenerated properly. Example:</p>
1.75      rillig   5583: <pre class="programlisting">
1.299     rillig   5584: wrong:
                   5585:         @echo "line 1" &gt; ${.TARGET}
                   5586:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5587:         @false
                   5588: 
                   5589: correct:
                   5590:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5591:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5592:         @false
                   5593:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5594: </pre>
1.299     rillig   5595: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5596:     <code class="filename">wrong</code> will exist, although there was an error
                   5597:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5598:     correct</strong></span> gives an error message twice, as expected.</p>
1.322     leot     5599: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5600:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5601:     happens when it is interrupted, for example by pressing
                   5602:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.322     leot     5603:     when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5604: </li></ul></div>
                   5605: </div>
                   5606: <div class="sect1">
                   5607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5608: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5609: <p><code class="filename">Makefile</code> variables contain strings that
                   5610:     can be processed using the five operators <code class="code">=</code>,
                   5611:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.322     leot     5612:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5613:     page.</p>
                   5614: <p>When a variable's value is parsed from a
                   5615:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5616:     the backslash character <code class="code">\</code> are handled specially. If a
                   5617:     backslash is the last character in a line, that backslash is removed
                   5618:     from the line and the line continues with the next line of the file.</p>
                   5619: <p>The <code class="code">#</code> character starts a comment that reaches
                   5620:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5621:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5622: <p>The evaluation of variables either happens immediately or lazy.
                   5623:     It happens immediately when the variable occurs on the right-hand
                   5624:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5625:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5626:     In the other cases, it is evaluated lazily.</p>
                   5627: <p>Some of the modifiers split the string into words and then
                   5628:     operate on the words, others operate on the string as a whole. When a
                   5629:     string is split into words, double quotes and single quotes are
1.322     leot     5630:     interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5631: <div class="sect2">
                   5632: <div class="titlepage"><div><div><h3 class="title">
                   5633: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5634: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5635: <li class="listitem"><p>All variable names starting with an underscore
                   5636:        are reserved for use by the pkgsrc infrastructure. They shall
                   5637:        not be used by packages.</p></li>
                   5638: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5639:        lowercase variable names for the iteration
                   5640:        variables.</p></li>
                   5641: <li class="listitem"><p>All list variables should have a plural name,
                   5642:        such as <code class="varname">PKG_OPTIONS</code> or
                   5643:        <code class="varname">DISTFILES</code>.</p></li>
                   5644: </ul></div>
                   5645: </div>
                   5646: </div>
                   5647: <div class="sect1">
                   5648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5649: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5650: <div class="sect2">
                   5651: <div class="titlepage"><div><div><h3 class="title">
                   5652: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5653: <p>When adding a string that possibly contains whitespace or quotes to
                   5654: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5655: modifier.</p>
                   5656: <p>When adding another list to a list (example 2), it must not be
                   5657: quoted, since its elements are already quoted.</p>
1.75      rillig   5658: <pre class="programlisting">
1.299     rillig   5659: STRING=         foo * bar `date`
                   5660: LIST=           # empty
                   5661: ANOTHER_LIST=   a=b c=d
                   5662: 
                   5663: LIST+=          ${STRING:Q}       # 1
                   5664: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5665: </pre>
1.299     rillig   5666: </div>
                   5667: <div class="sect2">
                   5668: <div class="titlepage"><div><div><h3 class="title">
                   5669: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5670: <p>Echoing a string containing special characters needs special
                   5671: work.</p>
1.75      rillig   5672: <pre class="programlisting">
1.299     rillig   5673: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5674: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5675: 
                   5676: all:
                   5677:         echo ${STRING}                  # 1
                   5678:         echo ${STRING:Q}                # 2
                   5679:         printf '%s\n' ${STRING:Q}''     # 3
                   5680:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5681: </pre>
1.299     rillig   5682: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5683: are just copied.</p>
                   5684: <p>Example 2 quotes the string so that the shell interprets it
                   5685: correctly. But the echo command may additionally interpret strings with a
                   5686: leading dash or those containing backslashes.</p>
1.322     leot     5687: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5688: interprets the format string, but not the next argument. The trailing
                   5689: single quotes handle the case when the string is empty. In that case, the
                   5690: :Q modifier would result in an empty string too, which would then be
1.322     leot     5691: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5692: but other programs may care.</p>
                   5693: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5694: need to be quoted because the quoting has already been done
                   5695: when adding elements to the list.</p>
1.75      rillig   5696: </div>
1.148     asau     5697: <div class="sect2">
1.75      rillig   5698: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5699: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5700: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5701: GNU-style configure script (especially those that call other configure
                   5702: scripts), it must not have leading or trailing whitespace, since
                   5703: otherwise the configure script gets confused. To trim leading and
                   5704: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5705: following example:</p>
1.75      rillig   5706: <pre class="programlisting">
1.299     rillig   5707: CPPFLAGS=               # empty
                   5708: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5709: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5710: 
1.299     rillig   5711: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5712: 
1.299     rillig   5713: all:
                   5714:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5715:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5716: </pre>
                   5717: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5718: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5719: space.</p>
                   5720: </div>
                   5721: <div class="sect2">
                   5722: <div class="titlepage"><div><div><h3 class="title">
                   5723: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5724: <p>When a possibly empty variable is used in a shell program, it may
                   5725: lead to a syntax error.</p>
                   5726: <pre class="programlisting">
                   5727: EGFILES=        # empty
1.87      wiz      5728: 
1.299     rillig   5729: install-examples:   # produces a syntax error in the shell
                   5730:         for egfile in ${EGFILES}; do            \
                   5731:                 echo "Installing $$egfile";     \
                   5732:         done
                   5733: </pre>
                   5734: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.322     leot     5735: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5736: To fix this syntax error, use one of the snippets below.</p>
                   5737: <pre class="programlisting">
                   5738: EMPTY=          # empty
1.87      wiz      5739: 
1.299     rillig   5740: install-examples:
                   5741:         for egfile in ${EGFILES} ""; do         \
                   5742:                 [ -n "$$egfile" ] || continue;  \
                   5743:                 echo "Installing $$egfile";     \
                   5744:         done
                   5745: </pre>
                   5746: <p>In this case, an empty string is appended to the iteration list (to
                   5747: prevent the syntax error) and filtered out later.</p>
                   5748: <pre class="programlisting">
                   5749: EGFILES=        # empty
1.87      wiz      5750: 
1.299     rillig   5751: install-examples:
                   5752: .for egfile in ${EGFILES}
                   5753:         echo "Installing ${egfile}"
                   5754: .endfor
1.100     rillig   5755: </pre>
1.299     rillig   5756: <p>If one of the filenames contains special characters, it should be
                   5757: enclosed in single or double quotes.</p>
                   5758: <p>To have a shell command test whether a make variable is empty, use
                   5759: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5760: </div>
                   5761: </div>
                   5762: </div>
                   5763: <div class="chapter">
                   5764: <div class="titlepage"><div><div><h2 class="title">
                   5765: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5766: <div class="toc">
                   5767: <p><b>Table of Contents</b></p>
                   5768: <dl class="toc">
                   5769: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5770: <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>
                   5771: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5772: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5773: </dl>
1.75      rillig   5774: </div>
1.299     rillig   5775: <p>Many packages have the ability to be built to support different
                   5776: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5777: in pkgsrc that provides generic handling of those options that
                   5778: determine different ways in which the packages can be built.  It's
                   5779: possible for the user to specify exactly which sets of options will be
                   5780: built into a package or to allow a set of global default options
                   5781: apply.</p>
                   5782: <p>There are two broad classes of behaviors that one might want to
                   5783: control via options.  One is whether some particular feature is
                   5784: enabled in a program that will be built anyway, often by including or
                   5785: not including a dependency on some other package.  The other is
                   5786: whether or not an additional program will be built as part of the
                   5787: package.  Generally, it is better to make a split package for such
                   5788: additional programs instead of using options, because it enables
                   5789: binary packages to be built which can then be added separately.  For
                   5790: example, the foo package might have minimal dependencies (those
                   5791: packages without which foo doesn't make sense), and then the foo-gfoo
                   5792: package might include the GTK frontend program gfoo.  This is better
                   5793: than including a gtk option to foo that adds gfoo, because either that
                   5794: option is default, in which case binary users can't get foo without
                   5795: gfoo, or not default, in which case they can't get gfoo.  With split
                   5796: packages, they can install foo without having GTK, and later decide to
                   5797: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5798: source users too, avoiding the need for rebuilds.</p>
                   5799: <p>Plugins with widely varying dependencies should usually be split
                   5800: instead of options.</p>
                   5801: <p>It is often more work to maintain split packages, especially if
                   5802: the upstream package does not support this.  The decision of split
                   5803: vs. option should be made based on the likelihood that users will want
                   5804: or object to the various pieces, the size of the dependencies that are
                   5805: included, and the amount of work.</p>
                   5806: <p>A further consideration is licensing.  Non-free parts, or parts
                   5807: that depend on non-free dependencies (especially plugins) should
                   5808: almost always be split if feasible.</p>
                   5809: <div class="sect1">
                   5810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5811: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5812: <p>Global default options are listed in
                   5813: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5814: that should be built into every package if that option is supported.
                   5815: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5816: </div>
1.148     asau     5817: <div class="sect1">
1.75      rillig   5818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5819: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5820: </h2></div></div></div>
                   5821: <p>The following example shows how
                   5822: <code class="filename">bsd.options.mk</code> should be used
                   5823: by the hypothetical ``wibble'' package, either in the package
                   5824: <code class="filename">Makefile</code>, or in a file,
                   5825: e.g. <code class="filename">options.mk</code>, that is included by the
                   5826: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5827: <pre class="programlisting">
1.299     rillig   5828: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5829: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5830: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5831: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5832: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5833: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5834: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5835: 
                   5836: .include "../../mk/bsd.prefs.mk"
                   5837: 
                   5838: # this package was previously named wibble2
                   5839: .if defined(PKG_OPTIONS.wibble2)
                   5840: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5841: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5842:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5843: .endif
                   5844: 
                   5845: .include "../../mk/bsd.options.mk"
                   5846: 
                   5847: # Package-specific option-handling
1.100     rillig   5848: 
1.299     rillig   5849: ###
                   5850: ### FOO support
                   5851: ###
                   5852: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5853: CONFIGURE_ARGS+=    --enable-foo
                   5854: .endif
1.100     rillig   5855: 
1.299     rillig   5856: ###
                   5857: ### LDAP support
                   5858: ###
                   5859: .if !empty(PKG_OPTIONS:Mldap)
                   5860: .  include "../../databases/openldap-client/buildlink3.mk"
                   5861: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5862: .endif
1.100     rillig   5863: 
1.299     rillig   5864: ###
                   5865: ### database support
                   5866: ###
                   5867: .if !empty(PKG_OPTIONS:Mmysql)
                   5868: .  include "../../mk/mysql.buildlink3.mk"
                   5869: .endif
                   5870: .if !empty(PKG_OPTIONS:Mpgsql)
                   5871: .  include "../../mk/pgsql.buildlink3.mk"
                   5872: .endif
                   5873: </pre>
                   5874: <p>The first section contains the information about which build
                   5875: options are supported by the package, and any default options settings
                   5876: if needed.</p>
                   5877: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5878: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.322     leot     5879: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299     rillig   5880: options.  It should be set to
                   5881: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5882: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5883: at the point where the options are processed.</p></li>
                   5884: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5885: build options supported by the package.</p></li>
                   5886: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5887: list of names of groups of mutually exclusive options.  The options in
                   5888: each group are listed in
                   5889: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5890: The most specific setting of any option from the group takes
                   5891: precedence over all other options in the group.  Options from the
                   5892: groups will be automatically added to
                   5893: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5894: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5895: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5896: packages will fail if no option from the group is
                   5897: selected.</p></li>
                   5898: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5899: of names of sets of options.  At least one option from each set must
                   5900: be selected.  The options in each set are listed in
                   5901: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5902: Options from the sets will be automatically added to
                   5903: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5904: fail if no option from the set is selected.</p></li>
                   5905: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5906: build options which are enabled by default.</p></li>
                   5907: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5908: of
                   5909: <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>
                   5910: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5911: their option counterparts.  Pairs should be added with
                   5912: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5913: warning will be issued if the user uses a legacy
                   5914: variable.</p></li>
                   5915: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5916: of
                   5917: <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>
                   5918: pairs that map options that have been renamed to their new
                   5919: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5920: the listing of global legacy options.  A warning will be issued if
                   5921: the user uses a legacy option.</p></li>
                   5922: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5923: options implied by deprecated variables used.  This can be used for
                   5924: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5925: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5926: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5927: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5928: a list of warnings about deprecated variables or options used, and
                   5929: what to use instead.</p></li>
                   5930: </ol></div>
                   5931: <p>A package should never modify
                   5932: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5933: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5934: To suggest a default set of options, use
                   5935: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5936: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5937: including <code class="filename">bsd.options.mk</code>.  If none of
                   5938: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5939: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5940: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5941: happen with platform-specific options if none of them is supported on
                   5942: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5943: empty list and the package is otherwise treated as not using the
                   5944: options framework.</p>
                   5945: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5946: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5947: build options, properly filtered to remove unsupported and duplicate
                   5948: options.</p>
                   5949: <p>The remaining sections contain the logic that is specific to
                   5950: each option.  The correct way to check for an option is to check
                   5951: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5952: <pre class="programlisting">
                   5953: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   5954: </pre>
1.75      rillig   5955: </div>
1.299     rillig   5956: <div class="sect1">
                   5957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5958: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5959: <p>Options that enable similar features in different packages (like
                   5960: optional support for a library) should use a common name in all
                   5961: packages that support it (like the name of the library).  If another
                   5962: package already has an option with the same meaning, use the same
                   5963: name.</p>
                   5964: <p>Options that enable features specific to one package, where it's
                   5965: unlikely that another (unrelated) package has the same (or a similar)
                   5966: optional feature, should use a name prefixed with
                   5967: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5968: <p>If a group of related packages share an optional feature
                   5969: specific to that group, prefix it with the name of the
                   5970: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5971: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5972: <p>For new options, add a line to
                   5973: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5974: fields, separated by tab.  The first field is the option name, the
                   5975: second its description.  The description should be a whole sentence
                   5976: (starting with an uppercase letter and ending with a period) that
                   5977: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5978: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5979: </div>
                   5980: <div class="sect1">
                   5981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5982: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5983: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5984: different dependencies based on the options with which the package was
                   5985: built. For querying these options, the file
                   5986: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5987: typical example looks like this:</p>
1.87      wiz      5988: <pre class="programlisting">
1.299     rillig   5989: pkgbase := libpurple
                   5990: .include "../../mk/pkg-build-options.mk"
                   5991: 
                   5992: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5993: ...
                   5994: .endif
1.229     sevan    5995: </pre>
1.299     rillig   5996: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5997: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5998: options of the libpurple package, which can then be queried like
                   5999: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6000: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6001: details.</p>
1.75      rillig   6002: </div>
                   6003: </div>
1.148     asau     6004: <div class="chapter">
1.75      rillig   6005: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6006: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6007: <div class="toc">
                   6008: <p><b>Table of Contents</b></p>
1.210     leot     6009: <dl class="toc">
1.299     rillig   6010: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   6011: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   6012: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6013: </dl>
                   6014: </div>
1.299     rillig   6015: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6016: by pkgsrc and also for individual packages to define what commands
                   6017: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6018: or for later run-time of an installed packaged (such as
                   6019: <code class="varname">DEPENDS</code>).
                   6020: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6021: package will not be used.</p>
                   6022: <p>When building a package, the replacement tools are
                   6023: made available in a directory (as symlinks or wrapper scripts)
                   6024: that is early in the executable search path. Just like the buildlink
                   6025: system, this helps with consistent builds.</p>
                   6026: <p>A tool may be needed to help build a specific package. For example,
                   6027: perl, GNU make (gmake) or yacc may be needed.</p>
                   6028: <p>Also a tool may be needed, for example, because the native system's supplied
                   6029: tool may be inefficient for building a package with pkgsrc.
                   6030: For example, a package may need GNU awk, bison (instead of
                   6031: yacc) or a better sed.</p>
                   6032: <p>The tools used by a package can be listed by running
                   6033: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6034: <div class="sect1">
1.75      rillig   6035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6036: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6037: <p>The default set of tools used by pkgsrc is defined in
                   6038: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6039: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6040: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6041: These can be seen by running:
                   6042: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6043: <p>If a package needs a specific program to build
                   6044: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6045: to define the tools needed.</p>
1.75      rillig   6046: </div>
1.299     rillig   6047: <div class="sect1">
                   6048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6049: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6050: <p>In the following examples, the :run means that it is needed at
                   6051: run-time (and becomes a DEPENDS).
                   6052: The default is a build dependency which can be set with
                   6053: :build. (So in this example, it is the same as gmake:build
                   6054: and pkg-config:build.)</p>
1.75      rillig   6055: <pre class="programlisting">
1.299     rillig   6056: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6057: </pre>
1.299     rillig   6058: <p>When using the tools framework, a
                   6059: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6060: which contains the full path to the appropriate tool. For example,
                   6061: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6062: on Linux systems.</p>
                   6063: <p>If you always need a pkgsrc version of the
                   6064: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6065: </p>
1.75      rillig   6066: </div>
1.299     rillig   6067: <div class="sect1">
                   6068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6069: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6070: <p>When improving or porting pkgsrc to a new platform, have a look
                   6071: at (or create) the corresponding platform specific make file fragment under
                   6072: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6073: the name of the common tools. For example:</p>
1.75      rillig   6074: <pre class="programlisting">
1.299     rillig   6075: .if exists(/usr/bin/bzcat)
                   6076: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6077: .elif exists(/usr/bin/bzip2)
                   6078: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6079: .endif
                   6080: 
                   6081: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6082: </pre>
1.75      rillig   6083: </div>
                   6084: </div>
1.299     rillig   6085: <div class="chapter">
                   6086: <div class="titlepage"><div><div><h2 class="title">
                   6087: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6088: <div class="toc">
                   6089: <p><b>Table of Contents</b></p>
                   6090: <dl class="toc">
                   6091: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6092: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6093: <dd><dl>
                   6094: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6095: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6096:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6097:       and
                   6098:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6099:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6100: </dl></dd>
                   6101: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6102: <dd><dl>
                   6103: <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>
                   6104: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6105: </dl></dd>
                   6106: </dl>
1.75      rillig   6107: </div>
1.299     rillig   6108: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6109:   are seen by a package's configure and build processes.  This is implemented
                   6110:   in a two step process:</p>
                   6111: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6112: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6113:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6114:       of <code class="varname">WRKDIR</code>.</p></li>
                   6115: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6116:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6117:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6118:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6119:       native compiler on some operating systems look like GCC, so that
                   6120:       packages that expect GCC won't require modifications to build with
                   6121:       those native compilers.</p></li>
                   6122: </ol></div>
                   6123: <p>This normalizes the environment in which a package is built so that the
                   6124:   package may be built consistently despite what other software may be
                   6125:   installed. Please note that the normal system header and library paths,
                   6126:   e.g. <code class="filename">/usr/include</code>,
                   6127:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6128:   designed to insulate the package build from non-system-supplied
                   6129:   software.</p>
1.148     asau     6130: <div class="sect1">
1.75      rillig   6131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6132: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6133: <p>The process of converting packages to use the buildlink3
                   6134:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6135:     The things to keep in mind are:</p>
1.128     wiz      6136: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6137: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6138:        instead of the actual toolchain.  Some packages are tricky,
                   6139:        and the only way to know for sure is the check
                   6140:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6141:        wrappers are being invoked.</p></li>
                   6142: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6143:        the package Makefile, e.g. Java VMs, standalone shells,
                   6144:        etc., because the code to symlink files into
                   6145:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6146:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6147:        </p></li>
                   6148: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6149:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6150:        package's Makefile are added as dependencies for that package.
                   6151:        </p></li>
                   6152: </ol></div>
                   6153: <p>If a dependency on a particular package is required for its libraries and
                   6154:     headers, then we replace:</p>
                   6155: <pre class="programlisting">
                   6156: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6157: </pre>
                   6158: <p>with</p>
                   6159: <pre class="programlisting">
                   6160: .include "../../category/foo/buildlink3.mk"
                   6161: </pre>
                   6162: <p>The buildlink3.mk files usually define the required dependencies.
                   6163:     If you need a newer version of the dependency when using buildlink3.mk
                   6164:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6165: <pre class="programlisting">
1.299     rillig   6166: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6167: .include "../../category/foo/buildlink3.mk"
1.1       grant    6168: </pre>
1.299     rillig   6169: <p>There are several <code class="filename">buildlink3.mk</code>
                   6170:     files in <code class="filename">pkgsrc/mk</code>
                   6171:     that handle special package issues:</p>
                   6172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6173: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6174:        the native or a pkgsrc Berkeley DB implementation based on
                   6175:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6176:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6177: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6178:        comes with neither Curses nor NCurses, this will take care
1.322     leot     6179:        to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.299     rillig   6180: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6181:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6182:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6183:        require a Kerberos 5 implementation.</p></li>
                   6184: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6185:        system-provided Motif installation or adds a dependency on
1.322     leot     6186:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.299     rillig   6187:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6188:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6189:        to choose which Motif version will be used.</p></li>
                   6190: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6191:        system-provided GNU readline or editline (libedit) installation,
1.322     leot     6192:        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>,
                   6193:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.299     rillig   6194:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6195:        If your package really needs GNU readline library, its Makefile
                   6196:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6197:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6198: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6199:        variables that may be used by packages that use the
                   6200:        Open Sound System (OSS) API.</p></li>
                   6201: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6202:        any of the Postgres versions in the variable
                   6203:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6204:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6205:        the file for more information.</p></li>
                   6206: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6207:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322     leot     6208:        a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.299     rillig   6209: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6210:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6211:        library.</p></li>
                   6212: </ul></div>
                   6213: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6214:     files provide a more complete
                   6215:     description of how to use them properly.</p>
1.75      rillig   6216: </div>
1.148     asau     6217: <div class="sect1">
1.75      rillig   6218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6219: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6220: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6221:     included by Makefiles to indicate the need to compile and link
                   6222:     against header files and libraries provided by the package.  A
                   6223:     <code class="filename">buildlink3.mk</code> file should always provide
                   6224:     enough information to add the correct type of dependency
                   6225:     relationship and include any other
                   6226:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6227:     headers and libraries that it needs in turn.</p>
                   6228: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322     leot     6229:     file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.299     rillig   6230:     package is highly recommended.  For most packages, the following
                   6231:     command will generate a good starting point for
                   6232:     <code class="filename">buildlink3.mk</code> files:</p>
                   6233: <pre class="screen">
                   6234: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6235: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6236:     </pre>
1.148     asau     6237: <div class="sect2">
1.75      rillig   6238: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6239: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6240: <p>The following real-life example
                   6241:       <code class="filename">buildlink3.mk</code> is taken
                   6242:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6243: <pre class="programlisting">
1.299     rillig   6244: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6245: 
                   6246: BUILDLINK_TREE+=        tiff
                   6247: 
                   6248: .if !defined(TIFF_BUILDLINK3_MK)
                   6249: TIFF_BUILDLINK3_MK:=
                   6250: 
                   6251: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6252: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6253: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6254: 
                   6255: .include "../../devel/zlib/buildlink3.mk"
                   6256: .include "../../graphics/jpeg/buildlink3.mk"
                   6257: .endif # TIFF_BUILDLINK3_MK
                   6258: 
                   6259: BUILDLINK_TREE+=        -tiff
1.1       grant    6260: </pre>
1.299     rillig   6261: <p>The header and footer manipulate
                   6262:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6263:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6264:       the dependency tree.</p>
                   6265: <p>The main section is protected from multiple inclusion
                   6266:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6267:       added.  Several important variables are set in the section:</p>
                   6268: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6269: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6270:          is the dependency version recorded in the installed
1.299     rillig   6271:          package; this should always be set using
                   6272:          <span class="command"><strong>+=</strong></span> to ensure that
                   6273:          we're appending to any pre-existing list of values.  This
1.300     wiz      6274:          variable should be set to the last version of the
1.299     rillig   6275:          package that had an backwards-incompatible API change.
                   6276:          </p></li>
                   6277: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6278:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6279:          pkgsrc directory.</p></li>
                   6280: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6281:          (not shown above) controls whether we use
                   6282:          <code class="varname">BUILD_DEPENDS</code> or
                   6283:          <code class="varname">DEPENDS</code> to add the dependency on
                   6284:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6285:          selected by setting
                   6286:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6287:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6288:          used.</p></li>
                   6289: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6290:            and
                   6291:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6292:            (not shown above) are lists of subdirectories of
                   6293:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6294:            to add to the header and library search paths.  These
                   6295:            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>
                   6296:          respectively.</p></li>
                   6297: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6298:            (not shown above) is the list of preprocessor flags to add
                   6299:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6300:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6301:            should be avoided and instead be handled using
                   6302:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6303:          above.</p></li>
                   6304: </ul></div>
                   6305: <p>The following variables are all optionally defined within
                   6306:       this second section (protected against multiple inclusion) and
                   6307:       control which package files are symlinked into
                   6308:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6309:       transformed during the symlinking:</p>
                   6310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6311: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6312:            (not shown above) is a shell glob pattern relative to
                   6313:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6314:            to be symlinked into
                   6315:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6316:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6317: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6318:            (not shown above) is a shell pipeline that
                   6319:            outputs to stdout a list of files relative to
                   6320:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6321:            The resulting files are to be symlinked
                   6322:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6323:            this takes the <code class="filename">+CONTENTS</code> of a
                   6324:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6325:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6326: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6327:            (not shown above) is a filter command that filters
                   6328:            <code class="filename">+CONTENTS</code> input into a list of files
                   6329:            relative to
                   6330:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6331:            on stdout.  By default,
                   6332:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6333:            outputs the contents of the <code class="filename">include</code>
                   6334:            and <code class="filename">lib</code> directories in the package
                   6335:            <code class="filename">+CONTENTS</code>.</p></li>
                   6336: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6337:            (not shown above) is a list of sed arguments used to
                   6338:            transform the name of the source filename into a
                   6339:            destination filename, e.g. <span class="command"><strong>-e
                   6340:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6341: </ul></div>
                   6342: <p>This section can additionally include any
                   6343:       <code class="filename">buildlink3.mk</code> needed for
                   6344:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6345:       Including these <code class="filename">buildlink3.mk</code> files
                   6346:       means that the headers and libraries for these
                   6347:       dependencies are also symlinked into
                   6348:       <code class="filename">${BUILDLINK_DIR}</code>
                   6349:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6350:       <code class="filename">buildlink3.mk</code>
                   6351:       file is included. Dependencies are only added for directly
                   6352:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6353: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6354:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6355:       please only add necessary ones, i.e., those whose libraries or
                   6356:       header files are automatically exposed when the package is
                   6357:       use.</p>
                   6358: <p>In particular, if only an executable
                   6359:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6360:       library does not need to be propagated in the
                   6361:       <code class="filename">buildlink3.mk</code> file.</p>
                   6362: <p>The following steps should help you decide if a
                   6363:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6364:       </p>
                   6365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6366: <li class="listitem"><p>Look at the installed header files: What
                   6367:        headers do they include? The packages providing these files
                   6368:        must be buildlinked.</p></li>
                   6369: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6370:        libraries and look against what other libraries they link.
                   6371:        Some of the packages providing these probably need to be
                   6372:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6373:        some systems pulls in the X libraries, so they will show up in
                   6374:        the <code class="filename">ldd</code> output, while on others (like OS
                   6375:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6376:        used as a hint.</p></li>
                   6377: </ul></div>
                   6378: <p>
                   6379:       </p>
                   6380: </div>
1.148     asau     6381: <div class="sect2">
1.75      rillig   6382: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6383: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6384:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6385:       and
                   6386:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6387:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6388: <p>Both variables set lower bounds for a version of this package.
                   6389:       The two variables differ in that one describes source
1.299     rillig   6390:       compatibility (API) and the other binary compatibility (ABI).
                   6391:       The difference is that a change in the API breaks compilation of
                   6392:       programs while changes in the ABI stop compiled programs from
                   6393:       running.</p>
1.300     wiz      6394: <p>The
                   6395:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6396:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6397:       changed very rarely.  (One possible scenario: If all packages
                   6398:       using this package need a higher version than defined in the
                   6399:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6400:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6401:       could be updated to that higher version.)</p>
                   6402: <p>On the other hand, changes to
1.299     rillig   6403:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6404:       are more common.  The variable will need to be updated every
                   6405:       time the major version of one of its shared libraries is changed,
                   6406:       or any other change where a binary built against the previous
                   6407:       version of the package will not run against the new version any
                   6408:       longer.</p>
                   6409: <p>In such a case, the package's
1.299     rillig   6410:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6411:       must be increased to require the new package version.  Then the
                   6412:       <code class="varname">PKGREVISION</code> of all packages
                   6413:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6414:       to be increased, and if they have
                   6415:       <code class="filename">buildlink3.mk</code> files,
                   6416:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6417:       in their <code class="filename">buildlink3.mk</code> files must be
                   6418:       increased to the new version as well. This is required so that a
                   6419:       package will pull in the versions of the packages that use the
                   6420:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6421:       uniquely identify the packages built against the new ABI. The
1.322     leot     6422:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.300     wiz      6423:       help with these updates.</p>
                   6424: <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
                   6425:       about dependencies on other packages, including the
                   6426:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6427: <p>Please take careful consideration before adjusting
                   6428:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6429:       or
                   6430:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6431:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6432:       cause unneeded package deletions and rebuilds.  In many cases,
                   6433:       new versions of packages work just fine with older
                   6434:       dependencies.</p>
1.326     gutterid 6435: <p>Also, it is not needed to set
1.299     rillig   6436:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6437:       when it is identical to
1.326     gutterid 6438:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6439: <p>Note there is also the distinction that users are able to disable
                   6440:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6441:       variable, but there is no equivalent option for API dependencies.</p>
1.75      rillig   6442: </div>
                   6443: </div>
1.148     asau     6444: <div class="sect1">
1.75      rillig   6445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6446: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6447: <p>Some packages in pkgsrc install headers and libraries that
                   6448:       coincide with headers and libraries present in the base system.
                   6449:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6450:       packages should also include a <code class="filename">builtin.mk</code>
                   6451:       file that includes the necessary checks to decide whether using
                   6452:       the built-in software or the pkgsrc software is
                   6453:     appropriate.</p>
                   6454: <p>The only requirements of a builtin.mk file for
                   6455:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6456: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6457: <li class="listitem"><p>It should set
                   6458:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6459:        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>
                   6460:        after it is included.</p></li>
                   6461: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6462:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6463:        which is already set before the
                   6464:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6465: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6466:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6467:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6468: </ol></div>
                   6469: <div class="sect2">
                   6470: <div class="titlepage"><div><div><h3 class="title">
                   6471: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6472: <p>The following is the recommended template for builtin.mk
                   6473:       files:</p>
1.75      rillig   6474: <pre class="programlisting">
1.299     rillig   6475: .if !defined(IS_BUILTIN.foo)
                   6476: #
                   6477: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6478: # genuinely exists in the system or not.
                   6479: #
                   6480: IS_BUILTIN.foo?=        no
1.100     rillig   6481: 
1.299     rillig   6482: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6483: # version can be determined.
                   6484: #
                   6485: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6486: BUILTIN_PKG.foo?=       foo-1.0
                   6487: .  endif
                   6488: .endif  # IS_BUILTIN.foo
1.100     rillig   6489: 
1.299     rillig   6490: .if !defined(USE_BUILTIN.foo)
                   6491: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6492: .  if defined(BUILTIN_PKG.foo)
                   6493: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6494: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6495: USE_BUILTIN.foo!=                                                       \
                   6496:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6497:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6498: .      endif
                   6499: .    endfor
                   6500: .  endif
                   6501: .endif  # USE_BUILTIN.foo
1.100     rillig   6502: 
1.299     rillig   6503: CHECK_BUILTIN.foo?=     no
                   6504: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6505: #
                   6506: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6507: # "yes" or "no".
                   6508: #
                   6509: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6510: </pre>
1.299     rillig   6511: <p>The first section sets
                   6512:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6513:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6514:       in the base system.  This should not be a base system software
                   6515:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6516:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6517:       included as part of the base system.  This variable is only
                   6518:       used internally within the <code class="filename">builtin.mk</code>
                   6519:       file.</p>
                   6520: <p>The second section sets
                   6521:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6522:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6523:       system if it exists (if
                   6524:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6525:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6526:       within the <code class="filename">builtin.mk</code> file.</p>
                   6527: <p>The third section sets
                   6528:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6529:       and is <span class="emphasis"><em>required</em></span> in all
                   6530:       <code class="filename">builtin.mk</code> files.  The code in this
                   6531:       section must make the determination whether the built-in
                   6532:       software is adequate to satisfy the dependencies listed in
                   6533:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6534:       This is typically done by comparing
                   6535:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6536:       against each of the dependencies in
                   6537:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6538:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6539:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6540:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6541:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6542:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6543:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6544:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6545:       that the built-in version of the software is similar enough to
                   6546:       be used as a replacement.</p>
                   6547: <p>The last section is guarded by
                   6548:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6549:       and includes code that uses the value of
                   6550:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6551:       set in the previous section.  This typically includes, e.g.,
                   6552:       adding additional dependency restrictions and listing additional
                   6553:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6554:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6555: </div>
                   6556: <div class="sect2">
                   6557: <div class="titlepage"><div><div><h3 class="title">
                   6558: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6559: <p>When building packages, it's possible to choose whether to set
                   6560:        a global preference for using either the built-in (native)
                   6561:        version or the pkgsrc version of software to satisfy a
                   6562:        dependency.  This is controlled by setting
                   6563:        <code class="varname">PREFER_PKGSRC</code> and
                   6564:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6565:        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
                   6566:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6567:        use the pkgsrc versions of software, while
                   6568:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6569:        built-in versions.  Preferences are determined by the most
                   6570:        specific instance of the package in either
                   6571:        <code class="varname">PREFER_PKGSRC</code> or
                   6572:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6573:        in neither or in both variables, then
                   6574:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6575:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6576:        using pkgsrc versions of software for all but the most basic
                   6577:       bits on a NetBSD system, you can set:</p>
1.75      rillig   6578: <pre class="programlisting">
1.299     rillig   6579: PREFER_PKGSRC=  yes
                   6580: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6581: </pre>
                   6582: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6583:       <code class="filename">builtin.mk</code>
                   6584:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6585:       otherwise it is simply ignored in that list.</p>
1.305     bacon    6586: <p><code class="varname">PREFER_PKGSRC</code> and
                   6587:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6588:       to ensure that the bootstrap process does not use inapropriate
                   6589:       native tools as dependencies for core packages.
                   6590: 
                   6591: </p>
                   6592: <pre class="screen">
                   6593: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6594: </pre>
                   6595: <p>
                   6596: 
1.299     rillig   6597:       Switching between settings globally at a later date can introduce
                   6598:       complications with dependency resolution. This is caused by packages
1.305     bacon    6599:       built with the opposite preference being installed alongside each
                   6600:       other.  Hence, any changes to these variables after bootstrap will
                   6601:       necessitate rebuilding all packages depending on one whose preference
                   6602:       has been changed.  This is not trivial and should be avoided.</p>
                   6603: <p>When using pkgsrc on Linux systems, there is high risk of
                   6604:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6605:       command or library not installed by pkgsrc, e.g. those installed by
                   6606:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6607:       upgraded to a version incompatible with the pkgsrc package at any
                   6608:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6609:       cannot prevent this, as it has no control over other package managers.
                   6610:       Another potential problem is that under Redhat Enterprise and related
                   6611:       Linux systems, yum packages are only patched and never upgraded, so
                   6612:       eventually they may become too outdated for use by pkgsrc.  Even
                   6613:       intentionally using foreign dependencies, not considered leakage, can
                   6614:       lead to these problems, so it is generally discouraged.  In order to
                   6615:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6616:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6617:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6618:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6619:       packages, or by setting --prefer-native to "yes".</p>
1.75      rillig   6620: </div>
1.107     rillig   6621: </div>
1.75      rillig   6622: </div>
1.148     asau     6623: <div class="chapter">
1.75      rillig   6624: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6625: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6626: <div class="toc">
                   6627: <p><b>Table of Contents</b></p>
1.210     leot     6628: <dl class="toc">
1.299     rillig   6629: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6630: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6631: <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>
                   6632: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6633: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6634: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6635: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6636: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6637: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6638: </dl>
                   6639: </div>
1.299     rillig   6640: <p>The <code class="filename">PLIST</code> file contains a package's
                   6641:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6642:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6643:   directory it's been installed in) plus some additional statements
1.322     leot     6644:   - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6645:   This chapter addresses some issues that need attention when
                   6646:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6647:   below!).</p>
1.148     asau     6648: <div class="sect1">
1.75      rillig   6649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6650: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6651: <p>Be sure to add a RCS ID line as the first thing in any
                   6652:     <code class="filename">PLIST</code> file you write:</p>
                   6653: <pre class="programlisting">
                   6654: @comment $NetBSD $
                   6655: </pre>
                   6656: <p>An artificial space has been added between NetBSD and $, this is a
                   6657: workaround here to prevent CVS expanding to the filename of the guide. When
                   6658: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6659: </div>
1.148     asau     6660: <div class="sect1">
1.75      rillig   6661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6662: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6663: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6664:     to output a PLIST that matches any new files since the package
                   6665:     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
                   6666:     more information on this target.</p>
1.75      rillig   6667: </div>
1.148     asau     6668: <div class="sect1">
1.75      rillig   6669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6670: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6671: </h2></div></div></div>
                   6672: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6673:     of AWK patterns and actions that are used to filter the output of
                   6674:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6675:     scripting you like to it, but be careful with quoting.</p>
                   6676: <p>For example, to get all files inside the
                   6677:     <code class="filename">libdata/foo</code> directory removed from the
                   6678:     resulting PLIST:</p>
1.88      wiz      6679: <pre class="programlisting">
1.299     rillig   6680: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6681: </pre>
1.300     wiz      6682: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6683:     evaluated after the file list and directory list are sorted.
                   6684:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6685:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6686:     list and directory list are sorted.</p>
1.299     rillig   6687: </div>
                   6688: <div class="sect1">
                   6689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6690: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6691: <p>A number of variables are substituted automatically in
                   6692:     PLISTs when a package is installed on a system. This includes the
                   6693:     following variables:</p>
                   6694: <div class="variablelist"><dl class="variablelist">
                   6695: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6696: <dd>
                   6697: <p>Some packages like emacs and perl embed information
                   6698:          about which architecture they were built on into the
                   6699:          pathnames where they install their files. To handle this
                   6700:          case, PLIST will be preprocessed before actually used, and
                   6701:          the symbol
                   6702:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6703:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6704:          same is done if the string
                   6705:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6706:          PLIST somewhere - use this on packages that have GNU
                   6707:          autoconf-created configure scripts.</p>
                   6708: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6709: <h3 class="title">Legacy note</h3>
                   6710: <p>There used to be a symbol
                   6711:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6712:            was replaced by the output of <span class="command"><strong>uname
                   6713:            -m</strong></span>, but that's no longer supported and has
                   6714:            been removed.</p>
                   6715: </div>
                   6716: </dd>
                   6717: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6718: <dd>
                   6719: <p>Some packages want to embed the OS name and version
                   6720:          into some paths.  To do this, use these variables in the
                   6721:          <code class="filename">PLIST</code>:
                   6722:          </p>
                   6723: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6724: <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>
                   6725: <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>
                   6726: <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>
                   6727: </ul></div>
                   6728: </dd>
                   6729: </dl></div>
                   6730: <p>For a list of values which are replaced by
                   6731:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6732: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6733: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6734: <p>If you want to change other variables not listed above, you
                   6735:     can add variables and their expansions to this variable in the
                   6736:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, &#8220;Optional files&#8221;</a>):</p>
1.81      rillig   6737: <pre class="programlisting">
1.299     rillig   6738: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6739: </pre>
1.299     rillig   6740: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6741:     in the <code class="filename">PLIST</code> with
                   6742:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6743: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6744:     the common case of conditionally including some
                   6745:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6746:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6747:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6748:     to <code class="literal">yes</code> if the entry should be included.
                   6749:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6750:     in the <code class="filename">PLIST</code> with either
                   6751:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6752:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6753:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6754: <pre class="programlisting">
1.299     rillig   6755: PLIST_VARS+=    foo
                   6756: .if <em class="replaceable"><code>condition</code></em>
                   6757: PLIST.foo=      yes
                   6758: .else
1.174     asau     6759: </pre>
1.299     rillig   6760: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6761: <pre class="programlisting">
1.299     rillig   6762: @comment $NetBSD $
                   6763: bin/bar
                   6764: man/man1/bar.1
                   6765: ${PLIST.foo}bin/foo
                   6766: ${PLIST.foo}man/man1/foo.1
                   6767: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6768: </pre>
1.299     rillig   6769: <p>An artificial space has been added between NetBSD and $, this is a
                   6770: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6771: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6772: </div>
1.299     rillig   6773: <div class="sect1">
                   6774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6775: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6776: <p>Man pages should be installed in compressed form if
                   6777:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6778:     and uncompressed otherwise. To handle this in the
                   6779:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6780:     appended/removed automatically for man pages according to
                   6781:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6782:     or not, see above for details. This modification of the
                   6783:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6784:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6785: </div>
1.148     asau     6786: <div class="sect1">
1.75      rillig   6787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6788: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6789: </h2></div></div></div>
                   6790: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6791:     in generating the binary package, set the variable
                   6792:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.322     leot     6793:     The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6794:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6795:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6796: </div>
1.148     asau     6797: <div class="sect1">
1.75      rillig   6798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6799: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6800: <p>Some packages decide to install a different set of files based on
                   6801:     the operating system being used. These differences can be
                   6802:     automatically handled by using the following files:</p>
                   6803: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6804: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6805: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6806: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6807: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6808: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6809: </ul></div>
1.75      rillig   6810: </div>
1.148     asau     6811: <div class="sect1">
1.75      rillig   6812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6813: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6814: <p>Some packages decide to generate hard-to-guess file names
                   6815:     during installation that are hard to wire down.</p>
                   6816: <p>In such cases, you can set the
                   6817:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6818:     terminated (with a semicolon) that will output PLIST entries which
                   6819:     will be appended to the PLIST</p>
                   6820: <p>You can find one example in editors/xemacs:</p>
                   6821: <pre class="programlisting">
                   6822: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6823: </pre>
                   6824: <p>which will append something like
                   6825:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6826:     <code class="filename">PLIST</code>.
                   6827:     </p>
1.75      rillig   6828: </div>
1.148     asau     6829: <div class="sect1">
1.75      rillig   6830: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6831: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6832: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6833:     multiple (and unrelated) packages install files.  These
                   6834:     directories were problematic because you had to add special
                   6835:     tricks in the PLIST to conditionally remove them, or have some
                   6836:     centralized package handle them.</p>
                   6837: <p>In pkgsrc, it is now easy: Each package should create
                   6838:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6839:     will remove any directories left empty after uninstalling a
                   6840:     package.</p>
                   6841: <p>If a package needs an empty directory to work, create
                   6842:     the directory during installation as usual, and also add an
                   6843:     entry to the PLIST:
                   6844: 
                   6845: </p>
                   6846: <pre class="programlisting">
                   6847: @pkgdir path/to/empty/directory
                   6848: </pre>
                   6849: <p>
                   6850: 
                   6851:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6852:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6853:     </p>
1.75      rillig   6854: </div>
1.299     rillig   6855: </div>
                   6856: <div class="chapter">
                   6857: <div class="titlepage"><div><div><h2 class="title">
                   6858: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6859: <div class="toc">
                   6860: <p><b>Table of Contents</b></p>
                   6861: <dl class="toc">
                   6862: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6863: <dd><dl>
                   6864: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6865: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6866: </dl></dd>
                   6867: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6868: <dd><dl>
                   6869: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6870: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6871: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6872: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6873: </dl></dd>
                   6874: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6875: <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>
                   6876: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6877: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6878: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6879: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6880: <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>
                   6881: </dl>
                   6882: </div>
                   6883: <p>This chapter describes the framework known as
                   6884: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6886: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6887:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6888: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6889:     provided that packages are correctly designed.</p></li>
                   6890: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6891: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6892: <li class="listitem"><p>Registration of system shells.</p></li>
                   6893: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6894: </ul></div>
                   6895: <p>The following sections inspect each of the above points in detail.</p>
                   6896: <p>You may be thinking that many of the things described here could be
                   6897: easily done with simple code in the package's post-installation target
                   6898: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6899: as the code in them is only executed when building from source.  Machines
                   6900: using binary packages could not benefit from it at all (as the code itself
                   6901: could be unavailable).  Therefore, the only way to achieve any of the items
                   6902: described above is by means of the installation scripts, which are
                   6903: automatically generated by pkginstall.</p>
1.148     asau     6904: <div class="sect1">
1.75      rillig   6905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6906: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6907: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6908: of files and directories that belong to a package.  The names used in it
                   6909: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6910: which means that it cannot register files outside this directory (absolute
                   6911: path names are not allowed).  Despite this restriction, some packages need
                   6912: to install files outside this location; e.g., under
                   6913: <code class="filename">${VARBASE}</code> or
                   6914: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6915: is to create such files during installation time by using
                   6916: installation scripts.</p>
                   6917: <p>The generic installation scripts are shell scripts that can
                   6918: contain arbitrary code.  The list of scripts to execute is taken from
                   6919: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6920: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6921: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6922: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6923: commands, so they have the potential to create and manage files
                   6924: anywhere in the file system.</p>
                   6925: <p>Using these general installation files is not recommended, but
                   6926: may be needed in some special cases.  One reason for avoiding them is
                   6927: that the user has to trust the packager that there is no unwanted or
                   6928: simply erroneous code included in the installation script. Also,
                   6929: previously there were many similar scripts for the same functionality,
                   6930: and fixing a common error involved finding and changing all of
                   6931: them.</p>
                   6932: <p>The pkginstall framework offers another, standardized way.  It
                   6933: provides generic scripts to abstract the manipulation of such files
                   6934: and directories based on variables set in the package's
                   6935: <code class="filename">Makefile</code>.  The rest of this section describes
                   6936: these variables.</p>
                   6937: <div class="sect2">
                   6938: <div class="titlepage"><div><div><h3 class="title">
                   6939: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6940: <p>The following variables can be set to request the creation of
                   6941: directories anywhere in the file system:</p>
                   6942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6943: <li class="listitem">
                   6944: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6945:     contain a list of directories that should be created and should attempt
                   6946:     to be destroyed by the installation scripts.  The difference between
                   6947:     the two is that the latter prompts the administrator to remove any
                   6948:     directories that may be left after deinstallation (because they were
                   6949:     not empty), while the former does not.  Example:</p>
                   6950: <pre class="programlisting">
                   6951: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6952: </pre>
                   6953: </li>
                   6954: <li class="listitem">
                   6955: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6956:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6957:     which directories should be created and should attempt to be destroyed
                   6958:     by the installation scripts.  Each tuple holds the following values,
                   6959:     separated by spaces: the directory name, its owner, its group and its
                   6960:     numerical mode.  For example:</p>
                   6961: <pre class="programlisting">
                   6962: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6963:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6964: </pre>
                   6965: <p>The difference between the two is exactly the same as their
                   6966:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6967: </li>
                   6968: </ul></div>
1.75      rillig   6969: </div>
1.299     rillig   6970: <div class="sect2">
                   6971: <div class="titlepage"><div><div><h3 class="title">
                   6972: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6973: <p>Creating non-empty files outside the installation prefix is tricky
                   6974: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6975: To overcome this problem, the only solution is to extract the file in the
                   6976: known place (i.e., inside the installation prefix) and copy it to the
                   6977: appropriate location during installation (done by the installation scripts
                   6978: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6979: file</em></span> in the following paragraphs, which describe the variables
                   6980: that can be used to automatically and consistently handle files outside the
                   6981: installation prefix:</p>
                   6982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6983: <li class="listitem">
                   6984: <p><code class="varname">CONF_FILES</code> and
                   6985:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6986:     During installation time, the master file is copied to the target one
                   6987:     if and only if the latter does not exist.  Upon deinstallation, the
                   6988:     target file is removed provided that it was not modified by the
                   6989:     installation.</p>
                   6990: <p>The difference between the two is that the latter prompts the
                   6991:     administrator to remove any files that may be left after
                   6992:     deinstallation (because they were not empty), while the former does
                   6993:     not.</p>
                   6994: </li>
                   6995: <li class="listitem">
                   6996: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6997:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6998:     files as well as their target locations.  For each of them, it also
                   6999:     specifies their owner, their group and their numeric permissions, in
                   7000:     this order.  For example:</p>
1.88      wiz      7001: <pre class="programlisting">
1.299     rillig   7002: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   7003:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   7004: </pre>
1.299     rillig   7005: <p>The difference between the two is exactly the same as their
                   7006:     non-<code class="varname">PERMS</code> counterparts.</p>
                   7007: </li>
                   7008: </ul></div>
                   7009: </div>
1.75      rillig   7010: </div>
1.148     asau     7011: <div class="sect1">
1.75      rillig   7012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7013: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   7014: <p>Configuration files are special in the sense that they are installed
                   7015: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   7016: need special treatment during installation (most of which is automated by
                   7017: pkginstall).  The main concept you must bear in mind is that files marked
                   7018: as configuration files are automatically copied to the right place (somewhere
                   7019: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   7020: and only if</em></span> they didn't exist before.  Similarly, they will not
                   7021: be removed if they have local modifications.  This ensures that
                   7022: administrators never lose any custom changes they may have made.</p>
                   7023: <div class="sect2">
                   7024: <div class="titlepage"><div><div><h3 class="title">
                   7025: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   7026: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7027: specifies where configuration files shall be installed.  Its contents are
                   7028: set based upon the following variables:</p>
                   7029: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7030: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7031:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7032:     be overridden by the user to point to his preferred location (e.g.,
                   7033:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7034:     Packages must not use it directly.</p></li>
                   7035: <li class="listitem">
                   7036: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7037:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7038:     for the package being built shall be installed.  The definition of this
                   7039:     variable only makes sense in the package's
                   7040:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7041: <p>As an example, consider the Apache package,
1.322     leot     7042:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.299     rillig   7043:     configuration files under the
                   7044:     <code class="filename">httpd/</code> subdirectory of
                   7045:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7046:     Makefile.</p>
                   7047: </li>
                   7048: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7049:     variable that holds this package's configuration directory (if
                   7050:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7051:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7052:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7053: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7054:     directory where the configuration files for the package identified by
                   7055:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7056: </ul></div>
                   7057: <p>Based on the above variables, pkginstall determines the value of
                   7058: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7059: variable that can be used within a package to refer to its configuration
                   7060: directory.  The algorithm used to set its value is basically the
                   7061: following:</p>
                   7062: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7063: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7064:     its value is used.</p></li>
                   7065: <li class="listitem"><p>If the previous variable is not defined but
                   7066:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7067:     <code class="filename">Makefile</code>, the resulting value is
                   7068:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7069: <li class="listitem"><p>Otherwise, it is set to
                   7070:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7071: </ol></div>
                   7072: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7073: 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
                   7074: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7075: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7076: </div>
                   7077: <div class="sect2">
                   7078: <div class="titlepage"><div><div><h3 class="title">
                   7079: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7080: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7081: known place, you need to teach each package where it shall install its
                   7082: files.  In some cases you will have to patch the package Makefiles to
                   7083: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7084: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7085: generated files:</p>
1.75      rillig   7086: <pre class="programlisting">
1.299     rillig   7087: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7088: </pre>
1.299     rillig   7089: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7090: for</em></span> its configuration files, not where they will be originally
                   7091: installed (although the difference is never explicit,
                   7092: unfortunately).</p>
1.75      rillig   7093: </div>
1.299     rillig   7094: <div class="sect2">
                   7095: <div class="titlepage"><div><div><h3 class="title">
                   7096: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7097: <p>As said before, pkginstall automatically handles configuration files.
                   7098: This means that <span class="strong"><strong>the packages themselves must not
                   7099: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7100: directly</strong></span>.  Bad news is that many software installation scripts
                   7101: will, out of the box, mess with the contents of that directory.  So what is
                   7102: the correct procedure to fix this issue?</p>
                   7103: <p>You must teach the package (usually by manually patching it) to
                   7104: install any configuration files under the examples hierarchy,
                   7105: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7106: <code class="filename">PLIST</code> registers them and the administrator always
                   7107: has the original copies available.</p>
                   7108: <p>Once the required configuration files are in place (i.e., under the
                   7109: examples hierarchy), the pkginstall framework can use them as master copies
                   7110: during the package installation to update what is in
                   7111: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7112: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7113: 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
                   7114: about their syntax and their purpose.  Here is an example, taken from the
1.322     leot     7115: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.88      wiz      7116: <pre class="programlisting">
1.299     rillig   7117: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7118: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100     rillig   7119: </pre>
1.299     rillig   7120: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7121: package and has no meaning outside it.</p>
1.75      rillig   7122: </div>
1.299     rillig   7123: <div class="sect2">
                   7124: <div class="titlepage"><div><div><h3 class="title">
                   7125: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7126: <p>The automatic copying of config files can be toggled by setting the
                   7127: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7128: installation.</p>
1.88      wiz      7129: </div>
1.75      rillig   7130: </div>
1.148     asau     7131: <div class="sect1">
1.75      rillig   7132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7133: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7134: <p>System startup scripts are special files because they must be
                   7135: installed in a place known by the underlying OS, usually outside the
                   7136: 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
                   7137: can be used.  However, pkginstall provides a special mechanism to handle
                   7138: these files.</p>
                   7139: <p>In order to provide system startup scripts, the package has
                   7140: to:</p>
                   7141: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7142: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7143:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.338   ! nia      7144:     <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
        !          7145:     has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299     rillig   7146: <li class="listitem">
                   7147: <p>Tell pkginstall to handle it, appending the name of the script,
                   7148:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7149:     Continuing the previous example:</p>
                   7150: <pre class="programlisting">
                   7151: RCD_SCRIPTS+=   cupsd
                   7152: </pre>
                   7153: </li>
                   7154: </ol></div>
                   7155: <p>Once this is done, pkginstall will do the following steps for each
                   7156: script in an automated fashion:</p>
                   7157: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7158: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7159:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7160:     variable.</p></li>
                   7161: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7162:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7163:     that this master file must be explicitly registered in the
                   7164:     <code class="filename">PLIST</code>.</p></li>
                   7165: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7166:     from the examples hierarchy into the system-wide startup scripts
                   7167:     directory.</p></li>
                   7168: </ol></div>
                   7169: <div class="sect2">
                   7170: <div class="titlepage"><div><div><h3 class="title">
                   7171: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7172: <p>The automatic copying of config files can be toggled by setting the
                   7173: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7174: installation.  Note that the scripts will be always copied inside the
                   7175: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7176: matter what the value of this variable is.</p>
1.75      rillig   7177: </div>
                   7178: </div>
1.299     rillig   7179: <div class="sect1">
                   7180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7181: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7182: <p>If a package needs to create special users and/or groups during
                   7183: installation, it can do so by using the pkginstall framework.</p>
                   7184: <p>Users can be created by adding entries to the
                   7185: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7186: syntax:</p>
                   7187: <pre class="programlisting">
                   7188: user:group
                   7189: </pre>
                   7190: <p>Further specification of user details may be done by setting
                   7191: per-user variables.
                   7192: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7193: numeric UID for the user.
                   7194: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7195: user's description or comment.
                   7196: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7197: user's home directory, and defaults to
                   7198: <code class="filename">/nonexistent</code> if not specified.
                   7199: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7200: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7201: not specified.</p>
                   7202: <p>Similarly, groups can be created by adding entries to the
                   7203: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7204: <pre class="programlisting">
                   7205: group
                   7206: </pre>
                   7207: <p>The numeric GID of the group may be set by defining
                   7208: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7209: <p>If a package needs to create the users and groups at an earlier
                   7210: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7211: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7212: <code class="literal">pre-install</code> to indicate the phase before which the
                   7213: users and groups are created. In this case, the numeric UIDs and GIDs
                   7214: of the created users and groups are automatically hardcoded into the
                   7215: final installation scripts.</p>
1.75      rillig   7216: </div>
1.148     asau     7217: <div class="sect1">
1.75      rillig   7218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7219: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7220: <p>Packages that install system shells should register them in the shell
                   7221: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7222: administrator.  This must be done from the installation scripts to keep
                   7223: binary packages working on any system.  pkginstall provides an easy way to
                   7224: accomplish this task.</p>
                   7225: <p>When a package provides a shell interpreter, it has to set the
                   7226: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7227: add some hooks to the installation scripts to handle it.  Consider the
1.322     leot     7228: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.299     rillig   7229: <pre class="programlisting">
                   7230: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7231: </pre>
                   7232: <div class="sect2">
                   7233: <div class="titlepage"><div><div><h3 class="title">
                   7234: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7235: <p>The automatic registration of shell interpreters can be disabled by
                   7236: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7237: environment variable to <code class="literal">NO</code>.</p>
                   7238: </div>
1.75      rillig   7239: </div>
1.148     asau     7240: <div class="sect1">
1.75      rillig   7241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7242: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7243: <p>Packages that install X11 fonts should update the database files
                   7244: that index the fonts within each fonts directory.  This can easily be
                   7245: accomplished within the pkginstall framework.</p>
                   7246: <p>When a package installs X11 fonts, it must list the directories in
                   7247: which fonts are installed in the
                   7248: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7249: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7250: <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
                   7251: installation scripts to run the appropriate commands to update the fonts
                   7252: database files within each of those directories.  For convenience, if the
                   7253: directory path is relative, it is taken to be relative to the package's
1.322     leot     7254: installation prefix.  Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   7255: <pre class="programlisting">
1.299     rillig   7256: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7257: </pre>
1.299     rillig   7258: <div class="sect2">
                   7259: <div class="titlepage"><div><div><h3 class="title">
                   7260: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7261: <p>The automatic update of fonts databases can be disabled by
                   7262: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7263: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7264: </div>
                   7265: </div>
                   7266: </div>
1.148     asau     7267: <div class="chapter">
1.75      rillig   7268: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7269: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7270: <div class="toc">
                   7271: <p><b>Table of Contents</b></p>
1.210     leot     7272: <dl class="toc">
1.267     rillig   7273: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7274: <dd><dl>
1.267     rillig   7275: <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>
                   7276: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7277: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7278: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7279: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7280: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7281: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7282: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7283: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7284: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7285: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7286: </dl></dd>
                   7287: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7288: <dd><dl>
                   7289: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7290: <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>
                   7291: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7292: </dl></dd>
                   7293: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7294: <dd><dl>
                   7295: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7296: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7297: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338   ! nia      7298: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267     rillig   7299: </dl></dd>
                   7300: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7301: <dd><dl>
                   7302: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7303: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      7304: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338   ! nia      7305: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
        !          7306: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
        !          7307: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
        !          7308: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   7309: </dl></dd>
                   7310: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7311: <dd><dl>
                   7312: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7313: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7314: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7315: <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>
                   7316: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7317: </dl></dd>
                   7318: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7319: <dd><dl>
                   7320: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7321: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7322: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7323: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7324: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      7325: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267     rillig   7326: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7327: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318     nia      7328: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
                   7329: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
                   7330: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
                   7331: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
                   7332: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
                   7333: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
                   7334: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87      wiz      7335:     emulation</a></span></dt>
1.318     nia      7336: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
                   7337: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75      rillig   7338: </dl></dd>
1.267     rillig   7339: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7340: </dl>
                   7341: </div>
1.148     asau     7342: <div class="sect1">
1.75      rillig   7343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7344: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7345: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7346:   different platforms. As a result, it is important to ensure,
                   7347:   where possible, that packages in pkgsrc are portable. This
                   7348:   chapter mentions some particular details you should pay
                   7349:   attention to while working on pkgsrc.</p>
1.148     asau     7350: <div class="sect2">
1.78      rillig   7351: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7352: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7353: </h3></div></div></div>
1.78      rillig   7354: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7355:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7356:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7357:     want to use those variables in the preprocessor directives of
1.322     leot     7358:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7359:     <code class="literal">.for</code>), you need to include the file
                   7360:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7361:     loads the user preferences.</p>
1.78      rillig   7362: <p>But note that some variables may not be completely defined
1.219     rillig   7363:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7364:     included, as they may contain references to variables that are
                   7365:     not yet defined. In shell commands (the lines in
                   7366:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7367:     is no problem, since variables are only expanded when they are
                   7368:     used. But in the preprocessor directives mentioned above and in
                   7369:     dependency lines (of the form <code class="literal">target:
                   7370:     dependencies</code>) the variables are expanded at load
                   7371:     time.</p>
1.148     asau     7372: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7373: <h3 class="title">Note</h3>
1.218     rillig   7374: <p>To check whether a variable can be used at load time,
                   7375:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7376: </div>
                   7377: </div>
1.148     asau     7378: <div class="sect2">
1.78      rillig   7379: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7380: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7381: <p>Occasionally, packages require interaction from the user,
                   7382:     and this can be in a number of ways:</p>
1.148     asau     7383: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7384: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7385:        interaction such as entering username/password or accepting a
                   7386:        license on a web page.</p></li>
1.128     wiz      7387: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7388:        passwords.</p></li>
1.128     wiz      7389: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7390: <li class="listitem"><p>help during the build process</p></li>
                   7391: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7392: </ul></div>
1.218     rillig   7393: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7394:     variable to define which stages need interaction. This should be
                   7395:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7396: <pre class="programlisting">
1.100     rillig   7397: INTERACTIVE_STAGE=      configure install
1.222     sevan    7398: </pre>
1.88      wiz      7399: <p>The user can then decide to skip this package by setting the
1.218     rillig   7400:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7401:     are also excluded from bulk builds.</p>
1.75      rillig   7402: </div>
1.148     asau     7403: <div class="sect2">
1.75      rillig   7404: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7405: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7406: <p>Authors of software can choose the licence under which software
                   7407:     can be copied.  The Free Software Foundation has declared some
                   7408:     licenses "Free", and the Open Source Initiative has a definition of
                   7409:     "Open Source".</p>
                   7410: <p>By default, pkgsrc allows packages with Free or Open Source
                   7411:     licenses to be built.  To allow packages with other licenses to be
                   7412:     built as well, the pkgsrc user needs to add these licenses to the
                   7413:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7414:     that this variable only affects which packages may be
                   7415:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7416:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7417: <p>One might want to only install packages with a BSD license,
1.218     rillig   7418:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7419:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7420:     user can override the default by setting the
                   7421:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7422:     of "+=".  The licenses accepted by default are defined in the
                   7423:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7424:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7425: <p>The license tag mechanism is intended to address
1.87      wiz      7426:     copyright-related issues surrounding building, installing and
                   7427:     using a package, and not to address redistribution issues (see
                   7428:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7429:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7430:     Packages with redistribution restrictions should set these
                   7431:     tags.</p>
1.98      wiz      7432: <p>Denoting that a package may be copied according to a
                   7433:     particular license is done by placing the license in
1.87      wiz      7434:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7435:     <code class="varname">LICENSE</code> variable to a string identifying the
1.322     leot     7436:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7437: <pre class="programlisting">
1.100     rillig   7438: LICENSE=        xv-license
1.222     sevan    7439: </pre>
1.87      wiz      7440: <p>When trying to build, the user will get a notice that the
1.98      wiz      7441:     package is covered by a license which has not been placed in the
                   7442:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7443: <pre class="programlisting">
1.100     rillig   7444: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7445: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7446: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7447: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7448: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7449: *** Error code 1
1.222     sevan    7450: </pre>
1.110     hubertf  7451: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7452:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7453:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7454:     convey to pkgsrc that it should not in the future fail because of
                   7455:     that license:</p>
1.78      rillig   7456: <pre class="programlisting">
1.100     rillig   7457: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7458: </pre>
                   7459: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7460:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7461:     is deprecated because it does not crisply refer to a particular
                   7462:     license text.  Another problem with such usage is that it does not
                   7463:     enable a user to tell pkgsrc to proceed for a single package
                   7464:     without also telling pkgsrc to proceed for all packages with that
                   7465:     tag.</p>
                   7466: <div class="sect3">
                   7467: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7468: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7469: <p>When adding a package with a new license, the following steps
                   7470:     are required:</p>
                   7471: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7472: <li class="listitem">
1.284     rillig   7473: <p>Check whether the license qualifies as Free or Open Source by
                   7474:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7475:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7476:     Open Source Initiative</a>.  If this is the case, the filename in
                   7477:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7478:     <code class="filename">-license</code> suffix, and the license name should be
                   7479:     added to:</p>
1.154     rodent   7480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7481: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7482:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7483: <li class="listitem"><p>default_acceptable_licenses in
                   7484:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7485: </ul></div>
                   7486: </li>
1.284     rillig   7487: <li class="listitem"><p>The license text should be added to
                   7488:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7489:     licenses can be seen in this directory.</p></li>
1.154     rodent   7490: </ol></div>
1.222     sevan    7491: </div>
                   7492: <div class="sect3">
                   7493: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7494: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7495: <p>When the license changes (in a way other than formatting),
1.222     sevan    7496:     make sure that the new license has a different name (e.g.,
1.98      wiz      7497:     append the version number if it exists, or the date).  Just
                   7498:     because a user told pkgsrc to build programs under a previous
                   7499:     version of a license does not mean that pkgsrc should build
1.99      rillig   7500:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7501:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7502:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7503:     approved by either of two bodies (FSF or OSI).</p>
                   7504: </div>
1.75      rillig   7505: </div>
1.148     asau     7506: <div class="sect2">
1.75      rillig   7507: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7508: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7509: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7510:     By declaring the restrictions, package tools can
1.98      wiz      7511:     automatically refrain from e.g. placing binary packages on FTP
                   7512:     sites.</p>
1.222     sevan    7513: <p>There are four possible restrictions, which are
1.98      wiz      7514:     the cross product of sources (distfiles) and binaries not being
                   7515:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7516:     language in any license, and because non-Free licenses tend to be
                   7517:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7518:     CD-ROM.
                   7519: 
                   7520:     "FTP" means making the source or binary file available over the
                   7521:     Internet at no charge.
                   7522: 
                   7523:     "CD-ROM" means making the source or binary available on some kind of
                   7524:     media, together with other source and binary packages, which is sold
                   7525:     for a distribution charge.
1.98      wiz      7526:     </p>
                   7527: <p>In order to encode these restrictions, the package system
1.87      wiz      7528:     defines five make variables that can be set to note these
                   7529:     restrictions:</p>
1.148     asau     7530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7531: <li class="listitem">
1.75      rillig   7532: <p><code class="varname">RESTRICTED</code></p>
                   7533: <p>This variable should be set whenever a restriction
1.87      wiz      7534:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7535:        string containing the reason for the restriction.  It should
                   7536:        be understood that those wanting to understand the restriction
                   7537:        will have to read the license, and perhaps seek advice of
                   7538:        counsel.</p>
1.75      rillig   7539: </li>
1.128     wiz      7540: <li class="listitem">
1.75      rillig   7541: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7542: <p>Binaries may not be placed on CD-ROM containing other
                   7543:        binary packages, for which a distribution charge may be made.
                   7544:        In this case, set this variable to
                   7545:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7546: </li>
1.128     wiz      7547: <li class="listitem">
1.75      rillig   7548: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7549: <p>Binaries may not made available on the Internet without
                   7550:        charge.  In this case, set this variable to
                   7551:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7552:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7553: </li>
1.128     wiz      7554: <li class="listitem">
1.75      rillig   7555: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7556: <p>Distfiles may not be placed on CD-ROM, together with
                   7557:        other distfiles, for which a fee may be charged.  In this
                   7558:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7559:        </p>
1.75      rillig   7560: </li>
1.128     wiz      7561: <li class="listitem">
1.75      rillig   7562: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7563: <p>Distfiles may not made available via FTP at no charge.
                   7564:        In this case, set this variable to
                   7565:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7566:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7567: </li>
                   7568: </ul></div>
1.222     sevan    7569: <p>Please note that packages will be removed from pkgsrc when the
                   7570:     distfiles are not distributable and cannot be obtained for a period
                   7571:     of one full quarter branch. Packages with manual/interactive fetch
                   7572:     must have a maintainer and it is his/her responsibility to ensure
                   7573:     this.</p>
1.75      rillig   7574: </div>
1.148     asau     7575: <div class="sect2">
1.75      rillig   7576: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7577: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7578: <p>Your package may depend on some other package being present,
                   7579:     and there are various ways of expressing this dependency.
                   7580:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7581:     <code class="varname">BUILD_DEPENDS</code>,
                   7582:     <code class="varname">TOOL_DEPENDS</code>, and
                   7583:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7584:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7585:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7586:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7587:     See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.290     gutterid 7588: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7589:     definition registers that pre-requisite in the binary package so it
                   7590:     will be pulled in when the binary package is later installed, whilst
                   7591:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7592:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7593:     dependency that is only needed for building or testing the resulting
1.299     rillig   7594:     package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.75      rillig   7595: <p>This means that if you only need a package present whilst
1.290     gutterid 7596:     you are building or testing, it should be noted as a
                   7597:     <code class="varname">TOOL_DEPENDS</code>,
                   7598:     <code class="varname">BUILD_DEPENDS</code>, or
                   7599:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7600:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7601:     packages, i.e. packages for the architecture where the package
                   7602:     is built;
                   7603:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7604:     packages, i.e., packages for the architecture for which the package
1.269     leot     7605:     is built.</p>
1.290     gutterid 7606: <p>The format for a <code class="varname">DEPENDS</code>,
                   7607:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7608:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7609: <pre class="programlisting">
1.100     rillig   7610: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7611: </pre>
1.128     wiz      7612: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7613:     may include any of the wildcard version numbers recognized by
1.322     leot     7614:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7615: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7616: <li class="listitem">
1.75      rillig   7617: <p>If your package needs another package's binaries or
1.160     wiz      7618:        libraries to build and run, and if that package has a
1.87      wiz      7619:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7620: <pre class="programlisting">
1.100     rillig   7621: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7622: </pre>
1.75      rillig   7623: </li>
1.128     wiz      7624: <li class="listitem">
1.160     wiz      7625: <p>If your package needs another package's binaries or
                   7626:        libraries only for building, and if that package has a
                   7627:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7628: <pre class="programlisting">
                   7629: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7630: </pre>
1.160     wiz      7631: <p>but set
                   7632:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7633:        to make it a build dependency only. This case is rather
                   7634:        rare.</p>
                   7635: </li>
                   7636: <li class="listitem">
1.132     spz      7637: <p>If your package needs binaries from another package to build,
1.269     leot     7638:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7639: <pre class="programlisting">
1.269     leot     7640: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7641: </pre>
1.75      rillig   7642: </li>
1.269     leot     7643: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7644:        files to include, etc. from another package to build,
                   7645:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7646: <li class="listitem"><p>If your package needs a library with which to link and
                   7647:        there is no <code class="filename">buildlink3.mk</code> file
                   7648:        available, create one. Using
                   7649:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7650:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7651: <li class="listitem">
1.132     spz      7652: <p>If your package needs some executable to be able to run
                   7653:        correctly and if there's no
                   7654:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7655:        using the <code class="varname">DEPENDS</code> variable. The
1.322     leot     7656:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7657:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7658:        when it runs, and that is specified:</p>
1.75      rillig   7659: <pre class="programlisting">
1.242     wiz      7660: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7661: </pre>
1.132     spz      7662: </li>
1.290     gutterid 7663: <li class="listitem"><p>If your package includes a test suite that has extra
                   7664:         dependencies only required for this purpose (frequently this
                   7665:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7666:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7667: <li class="listitem">
                   7668: <p>You can use wildcards in package dependencies. Note that
                   7669:        such wildcard dependencies are retained when creating binary
                   7670:        packages. The dependency is checked when installing the binary
                   7671:        package and any package which matches the pattern will be
                   7672:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7673: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7674:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7675:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7676:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7677: <p>Wildcards can also be used to specify that a package
1.87      wiz      7678:        will only build against a certain minimum version of a
                   7679:        pre-requisite:</p>
1.75      rillig   7680: <pre class="programlisting">
1.132     spz      7681: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7682: </pre>
1.132     spz      7683: <p>This means that the package will build using version 6.0
                   7684:        of ImageMagick or newer. Such a dependency may be warranted
                   7685:        if, for example, the command line options of an executable
                   7686:        have changed.</p>
                   7687: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7688:        set
                   7689:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7690:        to the appropriate pattern before including its
                   7691:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7692: <pre class="programlisting">
                   7693: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7694: .include "../../graphics/jpeg/buildlink3.mk"
                   7695: </pre>
1.75      rillig   7696: <p>For security fixes, please update the package
1.267     rillig   7697:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7698:        information.</p>
1.75      rillig   7699: </li>
                   7700: </ol></div>
                   7701: <p>If your package needs files from another package to build,
1.87      wiz      7702:     add the relevant distribution files to
                   7703:     <code class="varname">DISTFILES</code>, so they will be extracted
1.322     leot     7704:     automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7705:     (It relies on the jpeg sources being present in source form
                   7706:     during the build.)</p>
1.75      rillig   7707: </div>
1.148     asau     7708: <div class="sect2">
1.75      rillig   7709: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7710: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7711: <p>Your package may conflict with other packages a user might
1.87      wiz      7712:     already have installed on his system, e.g. if your package
1.88      wiz      7713:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7714:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.322     leot     7715: <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>
                   7716:     and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.255     leot     7717:     install the same shared library, thus you set in
                   7718:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7719: <pre class="programlisting">
                   7720: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7721:     </pre>
                   7722: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7723: <pre class="programlisting">
                   7724: CONFLICTS=      libXaw3d-[0-9]*
                   7725:     </pre>
1.322     leot     7726: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7727:     that conflict with existing packages and abort. However, in many
                   7728:     situations this is too late in the process. Binary package managers
                   7729:     will not know about the conflict until they attempt to install the
                   7730:     package after already downloading it and all its dependencies.
                   7731:     Users may also waste time building a package and its dependencies
                   7732:     only to find out at the end that it conflicts with another package
                   7733:     they have installed.</p>
                   7734: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7735:     should be added in all cases where it is known that packages conflict
                   7736:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.322     leot     7737:     exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7738:     managers to inform users that packages cannot be installed onto
                   7739:     the target system.</p>
1.75      rillig   7740: </div>
1.148     asau     7741: <div class="sect2">
1.75      rillig   7742: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7743: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7744: <p>There are several reasons why a package might be
1.88      wiz      7745:     instructed to not build under certain circumstances.  If the
1.87      wiz      7746:     package builds and runs on most platforms, the exceptions
1.193     dholland 7747:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7748:     the package builds and runs on a small handful of platforms,
                   7749:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7750:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7751:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7752:     (OS-version-platform) that can use glob-style
                   7753:     wildcards.</p>
                   7754: <p>If a package is not appropriate for some platforms (as
1.225     maya     7755:     opposed to merely broken), a different set of variables should be
1.193     dholland 7756:     used as this affects failure reporting and statistics.
                   7757:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7758:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7759:     the package is appropriate for only a small handful of platforms
                   7760:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7761:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7762:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7763:     (OS-version-platform) that can use glob-style
                   7764:     wildcards.</p>
1.88      wiz      7765: <p>Some packages are tightly bound to a specific version of an
1.322     leot     7766:     operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7767:     backwards compatible with other versions of the OS, and should be
                   7768:     uploaded to a version specific directory on the FTP server.  Mark
                   7769:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7770:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7771:     the package system internals, but may be used in the
                   7772:     future.</p>
1.75      rillig   7773: <p>If the package should be skipped (for example, because it
1.87      wiz      7774:     provides functionality already provided by the system), set
1.88      wiz      7775:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7776:     the package should fail because some preconditions are not met,
                   7777:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7778:     message.</p>
1.75      rillig   7779: </div>
1.148     asau     7780: <div class="sect2">
1.75      rillig   7781: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7782: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7783: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7784:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7785:     be set in the package Makefile. This will be carried into any
                   7786:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7787:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.322     leot     7788:     not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7789:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7790: </div>
1.148     asau     7791: <div class="sect2">
1.75      rillig   7792: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7793: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7794: <p>When a vulnerability is found, this should be noted in
1.320     wiz      7795:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
                   7796:     Entries in that file consist of three parts:</p>
                   7797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7798: <li class="listitem"><p>package version pattern</p></li>
                   7799: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   7800: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   7801: </ul></div>
                   7802: <p>For the package version pattern please always use `&lt;' to
                   7803:     mark an upper bound (not `&lt;='!). This will avoid possible
                   7804:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   7805:     related to security fixes. Lower bounds can be added too, using
                   7806:     '&gt;' or '&gt;='. For example,
1.321     wiz      7807:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.2</code></span>&#8221;</span> would mark
1.320     wiz      7808:     versions 1.0 (included) to 1.2 (excluded) of
                   7809:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo</code></span>&#8221;</span> as affected by the security
                   7810:     issue.</p>
                   7811: <p>Entries should always be added at the bottom of the file.</p>
                   7812: <p>When fixing packages, please modify the upper bound of the
                   7813:     corresponding entry. To continue the previous example, if a fix
                   7814:     was backported to version 1.1nb2, change the previous pattern to
1.321     wiz      7815:     <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>&#8221;</span>.</p>
1.320     wiz      7816: <p>To locally test a package version pattern against a
                   7817:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   7818:     pmatch</strong></span> command.</p>
                   7819: <p>The URL should be as permanent as possible and provide as
                   7820:     much information about the issue as possible.  CVE entries are
                   7821:     preferred.</p>
                   7822: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138     wiz      7823:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7824: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7825:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7826:     course not necessary if the problem is fixed by using a newer
                   7827:     release of the software), and the pattern in the
                   7828:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7829: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7830:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7831: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7832:     semi-automatically by a weekly cron job.</p>
1.320     wiz      7833: <p>In case a security issue is disputed, please contact
                   7834:     pkgsrc-security@NetBSD.org.</p>
1.75      rillig   7835: </div>
1.148     asau     7836: <div class="sect2">
1.75      rillig   7837: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7838: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7839: <p>When making fixes to an existing package it can be useful
1.87      wiz      7840:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7841:     avoid conflicting with future versions by the original author, a
1.128     wiz      7842:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      7843:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7844:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7845:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7846: <pre class="programlisting">
1.100     rillig   7847: DISTNAME=       foo-17.42
                   7848: PKGREVISION=    9
1.222     sevan    7849: </pre>
1.75      rillig   7850: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7851:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7852:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7853:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7854:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7855: <p>When a new release of the package is released, the
1.87      wiz      7856:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7857:     minor release of the above package, things should be like:</p>
1.75      rillig   7858: <pre class="programlisting">
1.100     rillig   7859: DISTNAME=       foo-17.43
1.222     sevan    7860: </pre>
1.87      wiz      7861: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7862:     non-trivial change in the resulting binary package.  Without a
                   7863:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7864:     version installed has no way of knowing that their package is out
                   7865:     of date.  Thus, changes without increasing
                   7866:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7867:     trivial that no reasonable person would want to upgrade", and this
                   7868:     is the rough test for when increasing
                   7869:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7870:     changes that do not merit increasing
                   7871:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7873: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7874:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7875:       comments in Makefile.</p></li>
                   7876: <li class="listitem"><p>Changing build variables if the resulting binary
                   7877:       package is the same.</p></li>
                   7878: <li class="listitem"><p>Changing
                   7879:       <code class="filename">DESCR</code>.</p></li>
                   7880: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7881:       default options don't change.</p></li>
1.100     rillig   7882: </ul></div>
1.87      wiz      7883: <p>Examples of changes that do merit an increase to
                   7884:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7886: <li class="listitem"><p>Security fixes</p></li>
                   7887: <li class="listitem"><p>Changes or additions to a patch
                   7888:       file</p></li>
                   7889: <li class="listitem"><p>Changes to the
                   7890:       <code class="filename">PLIST</code></p></li>
                   7891: <li class="listitem"><p>A dependency is changed or
                   7892:       renamed.</p></li>
1.100     rillig   7893: </ul></div>
1.78      rillig   7894: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7895:     changes.</p>
1.75      rillig   7896: </div>
1.148     asau     7897: <div class="sect2">
1.79      rillig   7898: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7899: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.295     rillig   7900: <p>When you want to replace the same text in multiple files, or
                   7901: multiple times in the same file, it is cumbersome to maintain a patch
                   7902: file for this. This is where the SUBST framework steps in. It provides an
                   7903: easy-to-use interface for replacing text in files. It just needs the
                   7904: following information:</p>
                   7905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7906: <li class="listitem"><p>In which phase of the package build cycle should the
                   7907: replacement happen?</p></li>
                   7908: <li class="listitem"><p>In which files should the replacement
1.287     rillig   7909: happen?</p></li>
1.295     rillig   7910: <li class="listitem"><p>Which text should be replaced with
                   7911: what?</p></li>
1.287     rillig   7912: </ul></div>
                   7913: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   7914: variables. A minimal example is:</p>
                   7915: <pre class="programlisting">
                   7916: SUBST_CLASSES+=         paths
                   7917: SUBST_STAGE.paths=      pre-configure
                   7918: SUBST_FILES.paths=      src/*.c
                   7919: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7920: </pre>
                   7921: <p>Translated into English, it means: In the pre-configure stage (that
                   7922: is, after applying the patches from the patches/ directory and before
                   7923: running the configure script and the portability check), replace the text
                   7924: <code class="literal">/usr/local</code> with the content of the variable
                   7925: <code class="varname">PREFIX</code>.</p>
                   7926: <p>Each SUBST block starts by appending an identifier to
                   7927: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7928: identifier can be chosen freely by the package. If there should ever be
                   7929: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7930: early, so don't worry about name collisions.</p>
                   7931: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7932: SUBST block are parameterized using this identifier. In the remainder of
                   7933: this section, these parameterized variables are written as
                   7934: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7935: <pre class="programlisting">
                   7936: SUBST_CLASSES+=         paths
                   7937: SUBST_STAGE.paths=      pre-configure
                   7938: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7939: SUBST_FILES.paths=      src/*.c
                   7940: SUBST_FILES.paths+=     scripts/*.sh
                   7941: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7942: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7943: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7944: </pre>
                   7945: <p>To get a complete picture about the SUBST substitutions, run
                   7946: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7947: expected, run pkglint on the package, which detects several typical
                   7948: mistakes surrounding the SUBST blocks. For any questions that might
                   7949: remain after this, have a look at
                   7950: <code class="filename">mk/subst.mk</code>.</p>
                   7951: <div class="sect3">
                   7952: <div class="titlepage"><div><div><h4 class="title">
                   7953: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7954: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7955: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7956: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7957: popular stages are, in chronological order:</p>
                   7958: <div class="variablelist"><dl class="variablelist">
                   7959: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7960: <dd>
                   7961: <p>The substitutions are applied immediately after the
                   7962: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7963: package will leave no traces of the original files.</p>
                   7964: <p>When the substitution applies to files for which there is also a
                   7965: patch in the <code class="filename">patches/</code> directory, this means that the
                   7966: patches will be computed based on the result of the substitution. When
                   7967: these patches are sent to the upstream maintainer later, to be fixed in
                   7968: the upstream package, these patches may no longer match what the upstream
                   7969: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7970: often a better choice.</p>
                   7971: </dd>
                   7972: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7973: <dd>
                   7974: <p>The substitutions are applied after the patches from the
                   7975: <code class="filename">patches/</code> directory. This makes it possible to run
                   7976: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322     leot     7977: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.295     rillig   7978: <p>When updating the patches, it is helpful to explicitly separate the
                   7979: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7980: configure</strong></span>, and to only edit the patches between these commands.
                   7981: Otherwise the substitutions from the SUBST block will end up in the patch
                   7982: file. When this happens in really obvious ways, pkglint will complain
                   7983: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7984: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7985: can only detect these really obvious
                   7986: cases.</p>
                   7987: </dd>
                   7988: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7989: <dd><p>This stage should only be used if the package defines a
                   7990: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7991: happen after that. Typical examples are packages that use the
                   7992: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7993: script from
                   7994: <code class="filename">configure.ac</code>.</p></dd>
                   7995: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7996: <dd><p>This stage is used to fix up any mistakes by the
                   7997: configure stage.</p></dd>
                   7998: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7999: <dd><p>This stage should only be used for substitutions that are
                   8000: clearly related to building the package, not for fixing the
                   8001: configuration. Substitutions for pathnames (such as replacing
                   8002: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   8003: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   8004: actual username) belong in pre-configure or post-configure
                   8005: instead.</p></dd>
                   8006: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   8007: <dd>
                   8008: <p>Just as with pre-build, this stage should only be used
                   8009: for substitutions that are clearly related to building the package, not
                   8010: for fixing the configuration. Substitutions for pathnames (such as
                   8011: replacing <code class="filename">/usr/local</code> with
                   8012: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   8013: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   8014: pre-configure or post-configure instead.</p>
                   8015: <p>A typical use is to update pkg-config files to include the rpath
                   8016: compiler options.</p>
                   8017: </dd>
                   8018: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8019: <dd><p>In general, the install phase should be as simple as
                   8020: possible. As with the pre-build and post-build stages, it should not be
                   8021: used to fix pathnames or user names, these belong in pre-configure
                   8022: instead. There are only few legitimate use cases for applying
                   8023: substitutions in this stage.</p></dd>
                   8024: </dl></div>
                   8025: </div>
                   8026: <div class="sect3">
                   8027: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   8028: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   8029: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8030: filename patterns. These patterns are relative to
                   8031: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8032: A typical example is:</p>
                   8033: <pre class="programlisting">
                   8034: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8035: </pre>
                   8036: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8037: implementation checks that each filename pattern that is mentioned here
                   8038: has an effect. For example, if none of the
                   8039: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8040: and substituted, that filename pattern is redundant and should be left
1.296     rillig   8041: out. By default, the SUBST framework will complain with an error message.
                   8042: If the text to be substituted occurs in some of the files from a single
                   8043: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   8044: framework will only print an INFO message for those files.</p>
                   8045: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   8046: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   8047: <p>Another popular way of choosing the files for the substitutions is
                   8048: via a shell command, like this:</p>
                   8049: <pre class="programlisting">
1.296     rillig   8050: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8051: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8052: </pre>
                   8053: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8054: freely chosen and independent of the SUBST framework.</p>
                   8055: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8056: lists each file individually. Thereby chances are higher that there are
                   8057: filename patterns in which no substitution happens. Since the SUBST
                   8058: framework cannot know whether the filename patterns in
                   8059: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8060: Makefile (where any redundant filename pattern would be suspicious) or
                   8061: been generated by a shell command (in which redundant filename patterns
                   8062: are more likely and to be expected), it will complain about these
                   8063: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8064: command to generate the list of filename patterns often need to set
                   8065: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8066: </div>
                   8067: <div class="sect3">
                   8068: <div class="titlepage"><div><div><h4 class="title">
                   8069: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8070: <p>In most cases, the substitutions are given using one or more
1.322     leot     8071: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8072: <pre class="programlisting">
                   8073: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8074: </pre>
                   8075: <p>Each of the sed commands needs to be preceded by the
                   8076: <code class="literal">-e</code> option and should be specified on a line of its
                   8077: own, to avoid hiding short sed commands at the end of a line.</p>
                   8078: <p>Since the sed commands often contain shell metacharacters as the
                   8079: separator (the <code class="literal">|</code> in the above example), it is common
                   8080: to enclose them in single quotes.</p>
                   8081: <p>A common substitution is to replace placeholders of the form
                   8082: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8083: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8084: <pre class="programlisting">
                   8085: SUBST_VARS.path=        PREFIX
                   8086: </pre>
                   8087: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8088: scripts during the do-configure stage, but in some cases these need to be
                   8089: overridden. The same pattern is also used when a package defines patches
                   8090: that replace previously hard-coded paths like
                   8091: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8092: placeholder first, which then gets substituted by the actual
                   8093: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8094: cases, it works equally well to just use the SUBST framework to directly
                   8095: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8096: thereby omitting the intermediate patch file.</p>
1.295     rillig   8097: <p>If the above is not flexible enough, it is possible to not use sed
                   8098: at all for the substitution but to specify an entirely different command,
                   8099: like this:</p>
1.87      wiz      8100: <pre class="programlisting">
1.295     rillig   8101: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8102: </pre>
                   8103: <p>This is used for the few remaining packages in which the
                   8104: distributed files use Windows-style line endings that need to be
                   8105: converted to UNIX-style line endings.</p>
                   8106: </div>
                   8107: <div class="sect3">
                   8108: <div class="titlepage"><div><div><h4 class="title">
                   8109: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8110: <p>When a SUBST block is applied during a package build, a message is
                   8111: logged. The default message is fine for most purposes but can be
                   8112: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8113: message.</p>
                   8114: </div>
1.79      rillig   8115: </div>
1.75      rillig   8116: </div>
1.148     asau     8117: <div class="sect1">
1.75      rillig   8118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8119: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8120: <div class="sect2">
1.75      rillig   8121: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8122: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8123: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8124:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8125:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8126:     with the name of each file to download as an argument, expecting
                   8127:     it to output the URL of the directory from which to download
1.322     leot     8128:     it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8129:     example of this usage.</p>
1.75      rillig   8130: <p>If the download can't be automated, because the user must
1.87      wiz      8131:     submit personal information to apply for a password, or must pay
                   8132:     for the source, or whatever, you can set
                   8133:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8134:     displayed to the user before aborting the build. Example:</p>
                   8135: <pre class="programlisting">
1.100     rillig   8136: FETCH_MESSAGE=  "Please download the files"
                   8137: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8138: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8139: </pre>
1.75      rillig   8140: </div>
1.148     asau     8141: <div class="sect2">
1.75      rillig   8142: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8143: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8144: <p>Sometimes authors of a software package make some
1.87      wiz      8145:     modifications after the software was released, and they put up a
                   8146:     new distfile without changing the package's version number. If a
                   8147:     package is already in pkgsrc at that time, the checksum will
                   8148:     no longer match. The contents of the new distfile should be
                   8149:     compared against the old one before changing anything, to make
                   8150:     sure the distfile was really updated on purpose, and that
                   8151:     no trojan horse or so crept in.
1.97      rillig   8152:     Please mention that the distfiles were compared and what was found
1.159     rodent   8153:     in your commit message.</p>
1.220     wiz      8154: <p>Then, the correct way to work around this is to set
                   8155:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8156:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8157:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8158:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8159:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8160:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.87      wiz      8161:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8162:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8163:     be appended, like
                   8164:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8165: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8166:     name does not contain a version and the distfile is apt to change. In
                   8167:     cases where the likelihood of this is very small,
                   8168:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8169:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8170:     distfile name changes, even if a package is being moved or
                   8171:     renamed.</p>
1.159     rodent   8172: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8173:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8174:     path in the filenames.
1.159     rodent   8175:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8176:     Furthermore, a mail to the package's authors seems appropriate
                   8177:     telling them that changing distfiles after releases without
                   8178:     changing the file names is not good practice.</p>
1.75      rillig   8179: </div>
1.199     tnn      8180: <div class="sect2">
                   8181: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8182: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8183: <p>Helper methods exist for packages hosted on github.com which
                   8184:     will often have distfile names that clash with other packages, for
                   8185:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8186:     from below:</p>
1.199     tnn      8187: <div class="sect3">
                   8188: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8189: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8190: <p>If your distfile URL looks similar to
1.303     bacon    8191:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8192:       then you are packaging a tagged release.</p>
1.199     tnn      8193: <pre class="programlisting">
1.303     bacon    8194: DISTNAME=       example-1.0
1.200     tnn      8195: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8196: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8197: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8198: EXTRACT_SUFX=   .zip
                   8199: </pre>
                   8200: </div>
                   8201: <div class="sect3">
                   8202: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8203: <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>
                   8204: <p>If your distfile looks similar to
                   8205:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8206:       release, then set the package version to 0.0.0.N, where N is the number
                   8207:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8208:       This will (almost) ensure that the first tagged release will have a
                   8209:       version greater than this one so that package upgrades will function
                   8210:       properly.</p>
                   8211: <pre class="programlisting">
                   8212: DISTNAME=       example-0.0.0.347
                   8213: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8214: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8215: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8216: </pre>
                   8217: </div>
                   8218: <div class="sect3">
                   8219: <div class="titlepage"><div><div><h4 class="title">
                   8220: <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>
                   8221: <p>If your distfile looks similar to
                   8222:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8223:       then include the last release version and the commit count since that
                   8224:       release in the package version and set GITHUB_TAG to the commit hash.
                   8225:       The latest release and commit count are shown in the output of
                   8226:       "git describe --tags":
                   8227:       </p>
                   8228: <pre class="screen">
                   8229: # git clone https://github.com/username/example
                   8230: # cd example
                   8231: # git describe --tags
                   8232: 1.2.3-5-g988881a
                   8233: </pre>
1.199     tnn      8234: <pre class="programlisting">
1.303     bacon    8235: DISTNAME=       example-1.2.3.5
                   8236: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8237: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8238: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8239: </pre>
1.199     tnn      8240: </div>
                   8241: <div class="sect3">
                   8242: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8243: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8244: <p>If your distfile URL looks similar to
1.303     bacon    8245:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8246:       then you are packaging a release.</p>
1.199     tnn      8247: <pre class="programlisting">
                   8248: DISTNAME=       offensive-1.6
1.200     tnn      8249: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8250: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8251: GITHUB_PROJECT= example
1.200     tnn      8252: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8253: EXTRACT_SUFX=   .zip
1.222     sevan    8254: </pre>
1.199     tnn      8255: </div>
                   8256: </div>
1.75      rillig   8257: </div>
1.148     asau     8258: <div class="sect1">
1.75      rillig   8259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8260: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8261: <div class="sect2">
1.75      rillig   8262: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8263: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8264: <p>pkgsrc supports many different machines, with different
1.87      wiz      8265:     object formats like a.out and ELF, and varying abilities to do
                   8266:     shared library and dynamic loading at all. To accompany this,
                   8267:     varying commands and options have to be passed to the
                   8268:     compiler, linker, etc. to get the Right Thing, which can be
                   8269:     pretty annoying especially if you don't have all the machines
                   8270:     at your hand to test things.  The
1.322     leot     8271:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      8272:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8273:     both static and dynamic libraries from a set of source files,
                   8274:     thus being platform-independent.</p>
                   8275: <p>Here's how to use libtool in a package in seven simple
                   8276:     steps:</p>
1.128     wiz      8277: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8278: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8279:        Makefile.</p></li>
1.128     wiz      8280: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8281:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8282:        add it to the definition of <code class="varname">CC</code>, if only
                   8283:        libraries are being built in a given Makefile. This one command
                   8284:        will build both PIC and non-PIC library objects, so you need not
                   8285:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8286: <li class="listitem">
1.75      rillig   8287: <p>For the linking of the library, remove any
1.128     wiz      8288:        <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
                   8289:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8290: <pre class="programlisting">
1.100     rillig   8291: ${LIBTOOL} --mode=link \
                   8292:     ${CC} -o ${.TARGET:.a=.la} \
                   8293:         ${OBJS:.o=.lo} \
                   8294:         -rpath ${PREFIX}/lib \
                   8295:         -version-info major:minor
1.222     sevan    8296: </pre>
1.75      rillig   8297: <p>Note that the library is changed to have a
1.87      wiz      8298:        <code class="filename">.la</code> extension, and the objects are
                   8299:        changed to have a <code class="filename">.lo</code>
                   8300:        extension. Change <code class="varname">OBJS</code> as
                   8301:        necessary. This automatically creates all of the
                   8302:        <code class="filename">.a</code>,
                   8303:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8304:        necessary) in the build directory. Be sure to include
1.128     wiz      8305:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8306:        minor are zero, as libtool will otherwise strip off the
                   8307:        shared library version.</p>
1.75      rillig   8308: <p>From the libtool manual:</p>
                   8309: <pre class="programlisting">
1.100     rillig   8310: So, libtool library versions are described by three integers:
1.69      rillig   8311: 
1.100     rillig   8312: CURRENT
                   8313: The most recent interface number that this library implements.
1.69      rillig   8314: 
1.100     rillig   8315: REVISION
                   8316: The implementation number of the CURRENT interface.
1.69      rillig   8317: 
1.100     rillig   8318: AGE
                   8319: The difference between the newest and oldest interfaces that
                   8320: this library implements.  In other words, the library implements
                   8321: all the interface numbers in the range from number `CURRENT -
                   8322: AGE' to `CURRENT'.
1.1       grant    8323: 
1.100     rillig   8324: If two libraries have identical CURRENT and AGE numbers, then the
                   8325: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8326: </pre>
1.128     wiz      8327: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8328:        different results for a.out and ELF (excluding symlinks)
                   8329:        in only one case. An ELF library of the form
1.128     wiz      8330:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8331:        will have a symlink of
1.128     wiz      8332:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8333:        on an a.out platform. This is handled
                   8334:        automatically.</p>
1.128     wiz      8335: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8336:        directory of the library being built.</p>
1.76      rillig   8337: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8338:        <code class="filename">.la</code> file, the other files will be
                   8339:        added automatically.</p>
1.75      rillig   8340: </li>
1.128     wiz      8341: <li class="listitem">
1.76      rillig   8342: <p>When linking shared object (<code class="filename">.so</code>)
1.322     leot     8343:        files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8344:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8345:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8346:        tacked on.</p>
1.76      rillig   8347: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8348:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8349: </li>
1.128     wiz      8350: <li class="listitem">
1.75      rillig   8351: <p>When linking programs that depend on these libraries
1.87      wiz      8352:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.322     leot     8353:        the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8354:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8355:        libraries (static or shared), but please be aware that
                   8356:        libtool will not allow you to specify a relative path in
1.128     wiz      8357:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8358:        expects you to change that argument to be the
                   8359:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8360: <pre class="programlisting">
1.100     rillig   8361: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8362: </pre>
1.75      rillig   8363: <p>should be changed to:</p>
                   8364: <pre class="programlisting">
1.100     rillig   8365: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8366: </pre>
1.75      rillig   8367: <p>and it will do the right thing with the libraries.</p>
                   8368: </li>
1.128     wiz      8369: <li class="listitem">
1.322     leot     8370: <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>
                   8371:        or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8372:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8373:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8374: <pre class="programlisting">
1.126     jakllsch 8375: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8376: </pre>
1.76      rillig   8377: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8378:        shared library, any needed symlinks, and run
1.322     leot     8379:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8380: </li>
1.128     wiz      8381: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8382:        the <code class="filename">.la</code>
                   8383:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8384: </ol></div>
                   8385: </div>
1.148     asau     8386: <div class="sect2">
1.75      rillig   8387: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8388: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8389: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8390:     package Makefile. This will override the package's own libtool
                   8391:     in most cases.  For older libtool using packages,  libtool is
                   8392:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8393:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8394:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8395: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8396:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8397:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8398:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8399:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8400: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8401:     libraries built and installed, then use
                   8402:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8403: <p>If your package makes use of the platform-independent library
1.87      wiz      8404:     for loading dynamic shared objects, that comes with libtool
                   8405:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8406: <p>Some packages use libtool incorrectly so that the package
                   8407:     may not work or build in some circumstances. Some of the more
                   8408:     common errors are:</p>
1.148     asau     8409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8410: <li class="listitem">
1.75      rillig   8411: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8412:        executable or library. This in itself isn't a problem if one of two things
                   8413:        has been done:</p>
1.128     wiz      8414: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8415: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8416:            <code class="filename">libfoo.la</code>, not
                   8417:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8418: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8419: </ol></div>
                   8420: </li>
1.128     wiz      8421: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8422:        The function lt_dlinit() should be called and the macro
                   8423:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8424:        executables.</p></li>
1.75      rillig   8425: </ul></div>
                   8426: </div>
1.148     asau     8427: <div class="sect2">
1.75      rillig   8428: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8429: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8430: <p>If a package needs GNU autoconf or automake to be executed
1.338   ! nia      8431:     to regenerate the
        !          8432:     <code class="filename">configure</code>
        !          8433:     script and <code class="filename">Makefile.in</code> makefile
        !          8434:     templates from <code class="filename">configure.ac</code> and
        !          8435:     <code class="filename">Makefile.am</code>,
        !          8436:     then they should be executed in a pre-configure target:</p>
1.75      rillig   8437: <pre class="programlisting">
1.338   ! nia      8438: USE_TOOLS+=    autoconf automake autoreconf
        !          8439: GNU_CONFIGURE= yes
1.100     rillig   8440: ...
1.1       grant    8441: 
1.100     rillig   8442: pre-configure:
1.338   ! nia      8443:         set -e; cd ${WRKSRC} &amp;&amp; autoreconf -fi
1.100     rillig   8444: ...
1.222     sevan    8445: </pre>
1.338   ! nia      8446: <p>Packages which use GNU Automake will sometimes
        !          8447:     require GNU Make (<code class="literal">gmake</code> in
        !          8448:     <code class="varname">USE_TOOLS</code>),
        !          8449:     but not always.  Note that autoreconf
        !          8450:     only needs to be executed if <code class="filename">configure.ac</code>
        !          8451:     or Makefiles are modified, or <code class="filename">configure</code>
        !          8452:     is not present.</p>
1.75      rillig   8453: <p>There are times when the configure process makes
1.87      wiz      8454:     additional changes to the generated files, which then causes
                   8455:     the build process to try to re-execute the automake sequence.
                   8456:     This is prevented by touching various files in the configure
                   8457:     stage. If this causes problems with your package you can set
                   8458:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8459:     Makefile.</p>
1.75      rillig   8460: </div>
1.338   ! nia      8461: <div class="sect2">
        !          8462: <div class="titlepage"><div><div><h3 class="title">
        !          8463: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
        !          8464: <p>Packages using Meson to configure need to include:
        !          8465: 
        !          8466: </p>
        !          8467: <pre class="programlisting">
        !          8468: .include "../../devel/meson/build.mk"
        !          8469: </pre>
        !          8470: <p>In nearly all cases (any program with dependencies),
        !          8471:     pkg-config needs to be added to
        !          8472:     <code class="varname">USE_TOOLS</code>.  If the package installs
        !          8473:     translation files for non-English languages, also
        !          8474:     add msgfmt and xgettext:
        !          8475: 
        !          8476: </p>
        !          8477: <pre class="programlisting">
        !          8478: USE_TOOLS+=    pkg-config msgfmt xgettext
        !          8479: </pre>
        !          8480: <p>If any options need to be passed to Meson, use
        !          8481:     <code class="varname">MESON_ARGS</code> instead of
        !          8482:     <code class="varname">CONFIGURE_ARGS</code>:
        !          8483: 
        !          8484: </p>
        !          8485: <pre class="programlisting">
        !          8486: MESON_ARGS+=   -Dx11=false
        !          8487: </pre>
        !          8488: </div>
1.75      rillig   8489: </div>
1.148     asau     8490: <div class="sect1">
1.75      rillig   8491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8492: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8493: <div class="sect2">
1.87      wiz      8494: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8495: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.338   ! nia      8496: <p>Compilers for the C and C++ languages comes with
1.87      wiz      8497:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8498:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8499:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8500: <p>To declare which language's compiler a package needs, set
                   8501:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327     wiz      8502:     currently are:
                   8503:     </p>
                   8504: <pre class="programlisting">
                   8505:        c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
                   8506:        c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
                   8507:        fortran77, java, objc, obj-c++, and ada.
                   8508:     </pre>
                   8509: <p>
                   8510:     (and any combination).  The default is
1.128     wiz      8511:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8512:     written in C++, usually need a C compiler for the configure
                   8513:     phase.</p>
1.338   ! nia      8514: <p>To express a general requirement on a specific C or C++
        !          8515:     version, normally only <code class="varname">GCC_REQD</code> needs to be set.
        !          8516:     For example, GCC 7 includes support for C++17, so if the package uses
        !          8517:     C++17 it should specify:
        !          8518: 
        !          8519:     </p>
        !          8520: <pre class="programlisting">
        !          8521:        GCC_REQD+=      7
        !          8522:     </pre>
        !          8523: <p>Language variants like <code class="literal">c++11</code> for
        !          8524:     <code class="varname">USE_LANGUAGES</code> should only be specified
        !          8525:     if the package does not explicitly set <code class="literal">-std=...</code>
        !          8526:     when compiling (i.e. the package assumes the compiler defaults to
        !          8527:     C++11 or some other standard).  This is usually a bug in the
        !          8528:     upstream build system.</p>
        !          8529: <p>GCC version 5 includes support for C++14, while GCC 4.7 includes
        !          8530:     more-or-less complete support for C++11.  For more information, consult
        !          8531:     <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.87      wiz      8532: </div>
1.148     asau     8533: <div class="sect2">
1.87      wiz      8534: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8535: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8536: <p>If a program is written in Java, use the Java framework in
                   8537:     pkgsrc.  The package must include
                   8538:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8539:     provides the following variables:</p>
1.148     asau     8540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8541: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8542:       dependency on the JDK is added.  If
1.128     wiz      8543:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8544:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8545:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8546:       JDK.</p></li>
1.128     wiz      8547: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8548:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8549:       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
                   8550:       <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
                   8551:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8552:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8553:       above. This variable is not set by default.</p></li>
1.130     wiz      8554: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8555:       automatically set to the runtime location of the used Java
                   8556:       implementation dependency. It may be used to set
                   8557:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8558:       needs this variable to be defined.
                   8559:       </p></li>
1.87      wiz      8560: </ul></div>
                   8561: </div>
1.148     asau     8562: <div class="sect2">
1.87      wiz      8563: <div class="titlepage"><div><div><h3 class="title">
1.320     wiz      8564: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
                   8565: <p>If a program is written in Go and has any dependencies on
                   8566:     other Go modules, have the package include
                   8567:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8568: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8569: <li class="listitem"><p>Generate a list of those dependencies with
                   8570:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8571:       go-modules.mk</strong></span>.</p></li>
1.338   ! nia      8572: <li class="listitem"><p>Prepend
        !          8573:       <code class="literal">.include "go-modules.mk"</code> to any other
        !          8574:       <code class="literal">.include</code>s.</p></li>
        !          8575: <li class="listitem"><p>Incorporate these modules in
        !          8576:       <code class="filename">distinfo</code> with <span class="command"><strong>make
        !          8577:       makesum</strong></span>.</p></li>
        !          8578: </ol></div>
        !          8579: </div>
        !          8580: <div class="sect2">
        !          8581: <div class="titlepage"><div><div><h3 class="title">
        !          8582: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
        !          8583: <p>If a program is written in Rust and uses Cargo to build,
        !          8584:     have the package include
        !          8585:     <code class="filename">../../lang/rust/cargo.mk</code>.</p>
        !          8586: <div class="orderedlist"><ol class="orderedlist" type="1">
        !          8587: <li class="listitem"><p>Generate a list of those dependencies with
        !          8588:       <span class="command"><strong>make CARGO_ARGS="build --release" build &amp;&amp;
        !          8589:       make print-cargo-depends &gt; cargo-depends.mk</strong></span>.</p></li>
        !          8590: <li class="listitem"><p>Prepend
        !          8591:       <code class="literal">.include "cargo-depends.mk"</code> to any other
        !          8592:       <code class="literal">.include</code>s.</p></li>
1.320     wiz      8593: <li class="listitem"><p>Incorporate these modules in
                   8594:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8595:       makesum</strong></span>.</p></li>
                   8596: </ol></div>
                   8597: </div>
                   8598: <div class="sect2">
                   8599: <div class="titlepage"><div><div><h3 class="title">
1.338   ! nia      8600: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318     nia      8601: <p>If your package contains interpreted Perl scripts, add
1.128     wiz      8602:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8603:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8604:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8605:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8606:     that you want adjusted. Every occurrence of
                   8607:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325     gutterid 8608:     replaced with the full path to the Perl executable.</p>
                   8609: <p>If a particular version of Perl is needed, set the
1.87      wiz      8610:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8611:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.318     nia      8612: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing Perl modules">Section 21.6.6, &#8220;Packages installing Perl modules&#8221;</a> for information
1.325     gutterid 8613:     about handling Perl modules.</p>
                   8614: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8615:     for the language now known as Raku.</p>
1.87      wiz      8616: </div>
1.148     asau     8617: <div class="sect2">
1.87      wiz      8618: <div class="titlepage"><div><div><h3 class="title">
1.338   ! nia      8619: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8620: <p><code class="varname">REPLACE_SH</code>,
                   8621:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8622:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309     gutterid 8623:     hash bangs in files. Please use the appropriate one, preferring
1.147     wiz      8624:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8625:     Each should contain a list of scripts, relative to
                   8626:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8627:     occurrence of the matching shell in a she-bang line will be
                   8628:     replaced with the full path to the shell executable.
1.147     wiz      8629:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8630:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8631: </div>
1.148     asau     8632: <div class="sect2">
1.147     wiz      8633: <div class="titlepage"><div><div><h3 class="title">
1.338   ! nia      8634: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325     gutterid 8635: <p>There are further similar REPLACE variables available, e.g.,
                   8636:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8637:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326     gutterid 8638:     noted above, have their actions defined centrally in
1.325     gutterid 8639:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326     gutterid 8640:     languages define the actions of these variables within their own
                   8641:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
                   8642:     actioned in <code class="filename">lang/php/phpversion.mk</code>, and
                   8643:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325     gutterid 8644:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8645:     consult the mk files found within their specific directories (the
1.331     gutterid 8646:     naming convention varies), or check the list found in
                   8647:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325     gutterid 8648: <p>Currently, special handling for other languages varies
1.87      wiz      8649:     in pkgsrc.  If a compiler package provides a
                   8650:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8651:     just add a (build) dependency on the appropriate compiler
                   8652:     package.</p>
                   8653: </div>
                   8654: </div>
1.148     asau     8655: <div class="sect1">
1.87      wiz      8656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8657: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8658: <p>The most common failures when building a package are that
                   8659:        some platforms do not provide certain header files, functions or
                   8660:        libraries, or they provide the functions in a library that the
                   8661:        original package author didn't know. To work around this, you
                   8662:        can rewrite the source code in most cases so that it does not
                   8663:        use the missing functions or provides a replacement function.</p>
1.148     asau     8664: <div class="sect2">
1.77      rillig   8665: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8666: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8667: <p>If a package already comes with a GNU configure script, the
                   8668:        preferred way to fix the build failure is to change the
                   8669:        configure script, not the code. In the other cases, you can
                   8670:        utilize the C preprocessor, which defines certain macros
                   8671:        depending on the operating system and hardware architecture it
                   8672:        compiles for. These macros can be queried using for example
                   8673:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8674:        system, hardware architecture and compiler has its own macro.
                   8675:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8676:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8677:        are all defined, you know that you are using NetBSD on an i386
                   8678:        compatible CPU, and your compiler is GCC.</p>
                   8679: <p>The list of the following macros for hardware and
                   8680:        operating system depends on the compiler that is used. For
                   8681:        example, if you want to conditionally compile code on Solaris,
                   8682:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8683:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8684: <div class="sect3">
1.75      rillig   8685: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8686: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.338   ! nia      8687: <p>To distinguish between specific NetBSD versions,
        !          8688:         you should use the following code.</p>
        !          8689: <pre class="programlisting">
        !          8690: #ifdef __NetBSD__
        !          8691: #include &lt;sys/param.h&gt;
        !          8692: #if __NetBSD_Prereq__(9,99,17)
        !          8693: /* use a newer feature */
        !          8694: #else
        !          8695: /* older code */
        !          8696: #endif
        !          8697: #endif
        !          8698: 
        !          8699: #ifndef _WIN32
        !          8700: /* Unix-like specific code */
        !          8701: #endif
        !          8702: </pre>
1.75      rillig   8703: <p>To distinguish between 4.4 BSD-derived systems and the
                   8704:         rest of the world, you should use the following code.</p>
                   8705: <pre class="programlisting">
1.100     rillig   8706: #include &lt;sys/param.h&gt;
                   8707: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8708: /* BSD-specific code goes here */
                   8709: #else
                   8710: /* non-BSD-specific code goes here */
                   8711: #endif
1.75      rillig   8712: </pre>
1.338   ! nia      8713: <p>You can also test for the following macros:</p>
1.75      rillig   8714: <pre class="programlisting">
1.151     obache   8715: Cygwin      __CYGWIN__
                   8716: DragonFly   __DragonFly__
1.100     rillig   8717: FreeBSD     __FreeBSD__
1.151     obache   8718: Haiku       __HAIKU__
1.100     rillig   8719: Interix     __INTERIX
                   8720: IRIX        __sgi (TODO: get a definite source for this)
1.338   ! nia      8721: Linux       __linux
1.193     dholland 8722: Mac OS X    __APPLE__
1.151     obache   8723: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8724: Minix3      __minix
1.100     rillig   8725: NetBSD      __NetBSD__
                   8726: OpenBSD     __OpenBSD__
                   8727: Solaris     sun, __sun
1.338   ! nia      8728: Unix(-like) __unix
1.75      rillig   8729: </pre>
                   8730: </div>
1.148     asau     8731: <div class="sect3">
1.75      rillig   8732: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8733: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8734: <pre class="programlisting">
1.100     rillig   8735: i386        i386, __i386, __i386__
1.338   ! nia      8736: x86-64      __amd64__, __x86_64__
        !          8737: ARM         __arm__
1.100     rillig   8738: MIPS        __mips
                   8739: SPARC       sparc, __sparc
1.338   ! nia      8740: PowerPC     __powerpc
1.75      rillig   8741: </pre>
                   8742: </div>
1.148     asau     8743: <div class="sect3">
1.75      rillig   8744: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8745: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8746: <pre class="programlisting">
1.100     rillig   8747: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8748: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8749: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8750: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8751: </pre>
                   8752: </div>
                   8753: </div>
1.148     asau     8754: <div class="sect2">
1.78      rillig   8755: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8756: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8757: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8758:         combinations of compiler version and architecture and almost
                   8759:         always relation to optimisation being enabled.  Common symptoms
                   8760:         are gcc internal errors or never finishing compiling a
1.78      rillig   8761:        file.</p>
                   8762: <p>Typically, a workaround involves testing the
                   8763:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8764:         optimisation for that combination of file,
1.198     tnn      8765:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8766: <p>This used to be a big problem in the past, but is rarely
                   8767:        needed now as compiler technology has matured. If you still need
                   8768:        to add a compiler specific workaround, please do so in the file
                   8769:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8770:        compiler version as detailed as possible.</p>
1.78      rillig   8771: </div>
1.148     asau     8772: <div class="sect2">
1.78      rillig   8773: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8774: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8775: <p>Compilation sometimes fails with an error message like this:</p>
                   8776: <pre class="programlisting">
                   8777: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8778:     fatal error: pango/pango.h: No such file or directory
                   8779: </pre>
                   8780: <p>The proper way to fix this problem depends on the type of the
                   8781: header, which is described in the following sections.</p>
                   8782: <div class="sect3">
                   8783: <div class="titlepage"><div><div><h4 class="title">
                   8784: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8785: <p>If the header name looks like it comes from a different package,
                   8786: that other package should be included via the buildlink3
                   8787: framework.</p>
                   8788: <p>First, look whether the header is somewhere in the buildlink3
                   8789: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8790: the missing Pango header:</p>
                   8791: <pre class="programlisting">
                   8792: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8793: </pre>
                   8794: <p>In the case of Pango, the output is:</p>
                   8795: <pre class="programlisting">
                   8796: work/.buildlink/include/pango-1.0/pango/pango.h
                   8797: </pre>
                   8798: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8799: in the <code class="filename">.buildlink</code> directory, it would have been
                   8800: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8801: path component though, which means that the compiler command line must
                   8802: contain an option of the form
                   8803: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8804: most cases this option is generated by the configure script, which can be examined using:</p>
                   8805: <pre class="programlisting">
                   8806: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8807: -I/usr/pkg/include/pango-1.0
                   8808: -I/usr/pkg/include/pango-1.0
                   8809: -I/usr/pkg/include/pango-1.0
                   8810: -I/usr/pkg/include/pango-1.0
                   8811: -I/usr/pkg/include/pango-1.0
                   8812: </pre>
                   8813: <p>This looks good. These options are transformed by the buildlink
                   8814: wrapper to refer to the correct path inside
                   8815: <code class="filename">work/.buildlink</code>.</p>
                   8816: <p>Since the compilation fails though, examine the compiler command
                   8817: lines in <code class="filename">work/.work.log</code> to see whether the
                   8818: <code class="literal">-I</code> option is included in the particular command
                   8819: line.</p>
                   8820: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8821: build-env</strong></span>, which sets up an interactive, realistic environment
                   8822: including all the pkgsrc wrapper commands and environment variables. From
                   8823: there, try to compile some simple example programs that use the
                   8824: header.</p>
                   8825: </div>
                   8826: <div class="sect3">
                   8827: <div class="titlepage"><div><div><h4 class="title">
                   8828: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8829: <p>If the name of the header seems to come from the package itself,
                   8830: and if the build is run with parallel jobs, the package may have some
                   8831: undeclared dependencies between the <code class="filename">.c</code> and the
                   8832: <code class="filename">.h</code> files, and a C file is compiled before its
                   8833: required header is generated.</p>
                   8834: <p>To see whether the build runs with parallel jobs, run
                   8835: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8836: like this:</p>
                   8837: <pre class="programlisting">
                   8838:   usr   MAKE_JOBS=              7
                   8839:   pkg   MAKE_JOBS_SAFE          # undefined
                   8840:   def   _MAKE_JOBS_N=           7
                   8841: </pre>
                   8842: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8843: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8844: package could have disabled parallel builds by setting
                   8845: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8846: in this case it hasn't.</p>
                   8847: <p>To see whether the build failure is caused by parallel builds,
                   8848: first save the exact error message and a bit of context, maybe you need
                   8849: it later for reporting a bug. Next, run:</p>
                   8850: <pre class="programlisting">
                   8851: MAKE_JOBS_SAFE=no bmake clean build
                   8852: </pre>
                   8853: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8854: report</a> against the pkgsrc package, including the exact error
                   8855: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8856: </div>
1.288     rillig   8857: <div class="sect3">
                   8858: <div class="titlepage"><div><div><h4 class="title">
                   8859: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8860: <p>Pkgsrc does not work reliably if any of
                   8861: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8862: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8863: bootstrap program prevents installing pkgsrc in symlink-based
                   8864: directories. Existing pkgsrc installations are not checked for symlinks
                   8865: though.</p>
                   8866: <p>The "No such file or directory" error messages are a typical
                   8867: symptom of symlinks, and it's quite difficult to find out that this is
                   8868: the actual cause.</p>
                   8869: </div>
                   8870: <div class="sect3">
                   8871: <div class="titlepage"><div><div><h4 class="title">
                   8872: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8873: <p>When building a hierarchy of packages, it may happen that one
                   8874: package is built and then pkgsrc is updated. This situation can provoke
                   8875: various hard to diagnose build errors. To clean up the situation:</p>
                   8876: <pre class="programlisting">
1.338   ! nia      8877: <code class="prompt">$</code> (cd ../../ &amp;&amp; cat mk/bsd.pkg.mk &gt;/dev/null &amp;&amp; rm -rf */*/work)
1.288     rillig   8878: </pre>
1.338   ! nia      8879: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
        !          8880: prevent running this command in the wrong directory.)</p>
1.288     rillig   8881: <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
                   8882: that directory as well.</p>
                   8883: </div>
                   8884: <div class="sect3">
                   8885: <div class="titlepage"><div><div><h4 class="title">
                   8886: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8887: <p>On platforms other than BSD, third-party packages are installed in
                   8888: <code class="filename">/usr/include</code>, together with the base system. This
                   8889: means that pkgsrc cannot distinguish between headers provided by the base
                   8890: system (which it needs) and headers from third-party packages (which are
                   8891: often included in pkgsrc as well). This can lead to subtle version
                   8892: mismatches.</p>
                   8893: <p>In pkgsrc installations that have been active for several years, it
                   8894: may happen that some files are manually deleted. To exclude this unlikely
                   8895: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8896: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8897: check/fix dependencies.</p>
                   8898: <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>
                   8899: for contact information. Be prepared to describe what you have tried so
                   8900: far and what any error messages were.</p>
                   8901: </div>
1.287     rillig   8902: </div>
                   8903: <div class="sect2">
                   8904: <div class="titlepage"><div><div><h3 class="title">
                   8905: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8906: </h3></div></div></div>
1.92      rillig   8907: <p>This error message often means that a package did not
1.78      rillig   8908:        link to a shared library it needs. The following functions are
                   8909:        known to cause this error message over and over.</p>
                   8910: <div class="informaltable">
1.216     tnn      8911: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8912: <colgroup>
                   8913: <col>
                   8914: <col>
                   8915: <col>
                   8916: </colgroup>
                   8917: <thead><tr>
                   8918: <th>Function</th>
                   8919: <th>Library</th>
                   8920: <th>Affected platforms</th>
                   8921: </tr></thead>
                   8922: <tbody>
                   8923: <tr>
                   8924: <td>accept, bind, connect</td>
                   8925: <td>-lsocket</td>
                   8926: <td>Solaris</td>
                   8927: </tr>
                   8928: <tr>
                   8929: <td>crypt</td>
                   8930: <td>-lcrypt</td>
                   8931: <td>DragonFly, NetBSD</td>
                   8932: </tr>
                   8933: <tr>
                   8934: <td>dlopen, dlsym</td>
                   8935: <td>-ldl</td>
                   8936: <td>Linux</td>
                   8937: </tr>
                   8938: <tr>
                   8939: <td>gethost*</td>
                   8940: <td>-lnsl</td>
                   8941: <td>Solaris</td>
                   8942: </tr>
                   8943: <tr>
                   8944: <td>inet_aton</td>
                   8945: <td>-lresolv</td>
                   8946: <td>Solaris</td>
                   8947: </tr>
                   8948: <tr>
                   8949: <td>nanosleep, sem_*, timer_*</td>
                   8950: <td>-lrt</td>
                   8951: <td>Solaris</td>
                   8952: </tr>
                   8953: <tr>
                   8954: <td>openpty</td>
                   8955: <td>-lutil</td>
                   8956: <td>Linux</td>
                   8957: </tr>
                   8958: </tbody>
                   8959: </table>
                   8960: </div>
1.338   ! nia      8961: <p>To fix these linker errors, it is often sufficient to add
1.87      wiz      8962:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8963:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338   ! nia      8964:     <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87      wiz      8965:     bmake</strong></span>.</p>
1.148     asau     8966: <div class="sect3">
1.92      rillig   8967: <div class="titlepage"><div><div><h4 class="title">
1.338   ! nia      8968: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92      rillig   8969: <p>When you are using the SunPro compiler, there is another
                   8970: possibility. That compiler cannot handle the following code:</p>
                   8971: <pre class="programlisting">
1.100     rillig   8972: extern int extern_func(int);
1.93      rillig   8973: 
1.100     rillig   8974: static inline int
                   8975: inline_func(int x)
                   8976: {
1.92      rillig   8977:         return extern_func(x);
1.100     rillig   8978: }
1.93      rillig   8979: 
1.100     rillig   8980: int main(void)
                   8981: {
1.92      rillig   8982:         return 0;
1.100     rillig   8983: }
1.92      rillig   8984: </pre>
                   8985: <p>It generates the code for <code class="function">inline_func</code> even if
                   8986: that function is never used. This code then refers to
                   8987: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8988: solve this problem you can try to tell the package to disable inlining
                   8989: of functions.</p>
                   8990: </div>
1.87      wiz      8991: </div>
1.148     asau     8992: <div class="sect2">
1.87      wiz      8993: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8994: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8995: <p>Sometimes packages fail to build because the compiler runs
                   8996:     into an operating system specific soft limit.  With the
                   8997:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338   ! nia      8998:     to unlimit the resources.  The allowed values are any combination of
        !          8999:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>,
        !          9000:     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
        !          9001:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>,
        !          9002:     <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> and
        !          9003:     <span class="quote">&#8220;<span class="quote">virtualsize</span>&#8221;</span>.
1.87      wiz      9004:     Setting this variable is similar to running the shell builtin
1.110     hubertf  9005:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      9006:     segment size or maximum stack size of a process, respectively, to
                   9007:     their hard limits.</p>
1.78      rillig   9008: </div>
1.75      rillig   9009: </div>
1.148     asau     9010: <div class="sect1">
1.75      rillig   9011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9012: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     9013: <div class="sect2">
1.75      rillig   9014: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9015: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  9016: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      9017:     with some operating systems cannot create more than one
                   9018:     directory at a time. As such, you should call
                   9019:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9020: <pre class="programlisting">
1.100     rillig   9021: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9022: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    9023: </pre>
1.338   ! nia      9024: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
        !          9025:     directly, you can also append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
        !          9026:     dir2</code></span>&#8221;</span> to the <code class="varname">INSTALLATION_DIRS</code>
        !          9027:     variable, which will automatically do the right thing.</p>
1.75      rillig   9028: </div>
1.148     asau     9029: <div class="sect2">
1.75      rillig   9030: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9031: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      9032: <p>In general, documentation should be installed into
1.87      wiz      9033:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338   ! nia      9034:     <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87      wiz      9035:     includes the version number of the package).</p>
1.84      wiz      9036: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      9037:     directory where HTML documentation is installed with the
1.338   ! nia      9038:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag is
        !          9039:     needed because otherwise the documentation ends up in
        !          9040:     <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
        !          9041:     pkgsrc, the HTML documentation should go into the package-specific
        !          9042:     directory, just like any other documentation.</p>
1.87      wiz      9043: <p>An exception to the above is that library API documentation
1.322     leot     9044:     generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      9045:     browsers (devhelp) should be left at their default location, which
                   9046:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9047:     documentation can be recognized from files ending in
                   9048:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9049:     (It is also acceptable to install such files in
                   9050:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9051:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9052:     <code class="filename">.devhelp*</code> file must be directly in that
                   9053:     directory then, no additional subdirectory level is allowed in
                   9054:     this case. This is usually achieved by using
1.128     wiz      9055:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      9056:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9057:     though.)</p>
1.75      rillig   9058: </div>
1.148     asau     9059: <div class="sect2">
1.75      rillig   9060: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9061: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   9062: <p>Certain packages, most of them in the games category, install
1.87      wiz      9063:     a score file that allows all users on the system to record their
                   9064:     highscores.  In order for this to work, the binaries need to be
                   9065:     installed setgid and the score files owned by the appropriate
1.142     wiz      9066:     group and/or owner (traditionally the "games" user/group).  Set
                   9067:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      9068:     following variables, documented in more detail in
                   9069:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      9070:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9071:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     9072:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   9073:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   9074:     <code class="varname">GAMEDATA_PERMS</code> and
                   9075:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   9076: <p>An example that illustrates some of the variables described above is
                   9077:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   9078:     used to properly set directory permissions of the directory where the
                   9079:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   9080:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   9081:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   9082:     binary:</p>
                   9083: <pre class="programlisting">
1.223     rillig   9084: USE_GAMESGROUP=         yes
1.210     leot     9085: 
1.223     rillig   9086: BUILD_DEFS+=            VARBASE
1.210     leot     9087: 
1.223     rillig   9088: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   9089: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9090: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    9091: </pre>
1.210     leot     9092: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9093:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9094:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9095:     needed to be accessed by setgid games and
                   9096:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 9097: <p>A package should therefore never hard code file ownership or
1.210     leot     9098:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9099:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9100:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9101:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   9102: </div>
1.148     asau     9103: <div class="sect2">
1.75      rillig   9104: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9105: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9106: <p><code class="varname">DESTDIR</code> support means that a package
                   9107:     installs into a staging directory, not the final location of the
                   9108:     files. Then a binary package is created which can be used for
                   9109:     installation as usual. There are two ways: Either the package must
1.128     wiz      9110:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   9111:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     9112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9113: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     9114:       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>.
                   9115:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      9116:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   9117:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9118:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9119:       the inclusion.</p></li>
1.128     wiz      9120: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9121:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9122: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9123:       automatically. Many manual rules and pre/post-install often are
                   9124:       incorrect; fix them.</p></li>
1.128     wiz      9125: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9126:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9127: <li class="listitem"><p>In general, packages should support
1.103     wiz      9128:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9129:       DESTDIR.</p></li>
                   9130: </ul></div>
                   9131: </div>
1.148     asau     9132: <div class="sect2">
1.103     wiz      9133: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9134: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9135: <p>Your package may also contain scripts with hardcoded paths to
1.318     nia      9136:       other interpreters besides (or as well as) Perl.  To correct the
1.87      wiz      9137:       full pathname to the script interpreter, you need to set the
                   9138:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9139:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9140: <pre class="programlisting">
1.100     rillig   9141: REPLACE_INTERPRETER+=   tcl
                   9142: REPLACE.tcl.old=        .*/bin/tclsh
                   9143: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9144: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9145: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    9146: </pre>
1.75      rillig   9147: </div>
1.148     asau     9148: <div class="sect2">
1.75      rillig   9149: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9150: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75      rillig   9151: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9152:     the Makefile fragment
                   9153:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9154:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9155:     configuration for such modules as well as various hooks to tune
                   9156:     this configuration.  See comments in this file for
                   9157:     details.</p>
1.75      rillig   9158: <p>Perl5 modules will install into different places depending
1.87      wiz      9159:     on the version of perl used during the build process.  To
                   9160:     address this, pkgsrc will append lines to the
                   9161:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9162:     the installed <code class="filename">.packlist</code> file generated by
                   9163:     most perl5 modules.  This is invoked by defining
                   9164:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9165:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9166:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9167:     e.g.:</p>
1.75      rillig   9168: <pre class="programlisting">
1.153     wiz      9169: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9170: </pre>
1.153     wiz      9171: <p>The perl5 config variables
                   9172:     <code class="varname">installarchlib</code>,
                   9173:     <code class="varname">installscript</code>,
                   9174:     <code class="varname">installvendorbin</code>,
                   9175:     <code class="varname">installvendorscript</code>,
                   9176:     <code class="varname">installvendorarch</code>,
                   9177:     <code class="varname">installvendorlib</code>,
                   9178:     <code class="varname">installvendorman1dir</code>, and
                   9179:     <code class="varname">installvendorman3dir</code> represent those
                   9180:     locations in which components of perl5 modules may be installed,
                   9181:     provided as variable with uppercase and prefixed with
                   9182:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9183:     and may be used by perl5 packages that don't have a packlist.
                   9184:     These variables are also substituted for in the
                   9185:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9186:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9187: </div>
1.148     asau     9188: <div class="sect2">
1.75      rillig   9189: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9190: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9191: <p>Some packages install info files or use the
1.128     wiz      9192:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      9193:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9194:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9195:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9196:     handle registration of the info files in the Info directory
1.128     wiz      9197:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9198:     files registration is either provided by the system, or by a
                   9199:     special purpose package automatically added as dependency if
                   9200:     needed.</p>
1.75      rillig   9201: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9202:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9203:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9204:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9205: <p>The info files for the package should be listed in the
1.87      wiz      9206:     package <code class="filename">PLIST</code>; however any split info files
                   9207:     need not be listed.</p>
1.128     wiz      9208: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9209:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9210:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9211:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9212:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9213:     variable in the package <code class="filename">Makefile</code>. By
                   9214:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9215:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9216:     does not match the required minimum, a build dependency on the
1.322     leot     9217:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      9218:     be added automatically.</p>
1.75      rillig   9219: <p>The build and installation process of the software provided
1.87      wiz      9220:     by the package should not use the
1.110     hubertf  9221:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9222:     info files is the task of the package
                   9223:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9224:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9225: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9226:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9227:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9228:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9229: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9230:     no effect except the logging of a message. The script overriding
1.110     hubertf  9231:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9232:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9233:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9234: </div>
1.148     asau     9235: <div class="sect2">
1.75      rillig   9236: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9237: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9238: <p>All packages that install manual pages should install them
1.87      wiz      9239:     into the same directory, so that there is one common place to look
                   9240:     for them. In pkgsrc, this place is
                   9241:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9242:     should be used in packages. The default for
                   9243:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9244:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9245:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9246: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9247: <h3 class="title">Note</h3>
1.87      wiz      9248: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9249:     is far from complete.</p>
1.75      rillig   9250: </div>
1.81      rillig   9251: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9252:     <code class="filename">man/</code> as the top level directory for the man
                   9253:     page file entries, and the pkgsrc framework will convert as
                   9254:     needed. In all other places, the correct
                   9255:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9256: <p>Packages that are
                   9257:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9258:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9259:     <code class="filename">./configure</code>
                   9260:     --mandir switch to set where the man pages should be installed.
                   9261:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9262:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9263: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9264:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9265:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9266:     Or if the <code class="filename">./configure</code> script uses
                   9267:     a non-standard use of --mandir, you can set
                   9268:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9269: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      9270:     information on installation of compressed manual pages.</p>
1.75      rillig   9271: </div>
1.148     asau     9272: <div class="sect2">
1.75      rillig   9273: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9274: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9275: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9276:     the fonts database in the directory where they get installed at
                   9277:     installation and deinstallation time.  This can be automatically
                   9278:     done by using the pkginstall framework.</p>
1.75      rillig   9279: <p>You can list the directories where fonts are installed in the
1.87      wiz      9280:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9281:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9282:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      9283:     Also make sure that the database file
                   9284:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9285: <p>Note that you should not create new directories for fonts;
1.87      wiz      9286:     instead use the standard ones to avoid that the user needs to
                   9287:     manually configure his X server to find them.</p>
1.75      rillig   9288: </div>
1.148     asau     9289: <div class="sect2">
1.75      rillig   9290: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9291: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9292: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9293:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9294:     etc.), you need to take some extra steps:</p>
1.128     wiz      9295: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9296: <li class="listitem"><p>Include
1.87      wiz      9297:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9298:        your <code class="filename">Makefile</code>, which takes care of
                   9299:        registering those files in system-wide catalogs at
                   9300:        installation and deinstallation time.</p></li>
1.128     wiz      9301: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9302:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9303: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9304:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9305: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9306:        to be added to the SGML catalog.  These come in groups of
                   9307:        three strings; see xmlcatmgr(1) for more information
                   9308:        (specifically, arguments recognized by the 'add' action).
                   9309:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9310: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9311:        to be added to the XML catalog.  These come in groups of three
                   9312:        strings; see xmlcatmgr(1) for more information (specifically,
                   9313:        arguments recognized by the 'add' action).  Note that you will
                   9314:        normally not use this variable.</p></li>
1.75      rillig   9315: </ol></div>
                   9316: </div>
1.148     asau     9317: <div class="sect2">
1.75      rillig   9318: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9319: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9320: <p>If a package provides extensions to the MIME database by
1.87      wiz      9321:     installing <code class="filename">.xml</code> files inside
                   9322:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9323:     need to take some extra steps to ensure that the database is kept
                   9324:     consistent with respect to these new files:</p>
1.128     wiz      9325: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9326: <li class="listitem"><p>Include
1.87      wiz      9327:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9328:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9329:        this same directory, which is reserved for inclusion from
                   9330:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9331:        care of rebuilding the MIME database at installation and
                   9332:        deinstallation time, and disallows any access to it directly
                   9333:        from the package.</p></li>
1.128     wiz      9334: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9335:        <code class="filename">share/mime</code> directory,
                   9336:        <span class="emphasis"><em>except</em></span> for files saved under
                   9337:        <code class="filename">share/mime/packages</code>.  The former are
                   9338:        handled automatically by
                   9339:        the update-mime-database program, but the latter are
                   9340:        package-dependent and must be removed by the package that
                   9341:        installed them in the first place.</p></li>
1.128     wiz      9342: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9343:        from the PLIST.  They will be handled by the shared-mime-info
                   9344:        package.</p></li>
1.75      rillig   9345: </ol></div>
                   9346: </div>
1.148     asau     9347: <div class="sect2">
1.75      rillig   9348: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9349: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93      rillig   9350: <p>If a package uses intltool during its build, add
                   9351:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9352:     which forces it to use the intltool package provided by pkgsrc,
                   9353:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9354: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9355:     latest available version; this way, the package benefits of any
                   9356:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9357: </div>
1.148     asau     9358: <div class="sect2">
1.75      rillig   9359: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9360: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9361: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9362:     the startup directory by default, but you can enable it, by adding
                   9363:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9364:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9365:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9366:     it will automatically remove the scripts when the package is
                   9367:     deinstalled.</p>
1.75      rillig   9368: </div>
1.148     asau     9369: <div class="sect2">
1.75      rillig   9370: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9371: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9372: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9373:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9374:     updated.</p>
1.148     asau     9375: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9376: <h3 class="title">Note</h3>
1.125     wiz      9377: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9378:     packages should install files
1.125     wiz      9379:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9380:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9381: </div>
1.128     wiz      9382: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9383: <li class="listitem"><p>Include
1.125     wiz      9384:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9385:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9386:       database at installation and deinstallation time.</p></li>
1.128     wiz      9387: <li class="listitem">
1.75      rillig   9388: <p>If your package installs files into a texmf
1.87      wiz      9389:       tree other than the one
1.125     wiz      9390:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9391:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9392:       trees that need database update.</p>
1.75      rillig   9393: <p>If your package also installs font map files that need
1.110     hubertf  9394:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9395:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9396:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9397:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9398:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9399:       be run automatically at installation/deinstallation to
                   9400:       enable/disable font map files for TeX output
                   9401:       drivers.</p>
1.75      rillig   9402: </li>
1.128     wiz      9403: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9404:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9405:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9406: </ol></div>
                   9407: </div>
1.148     asau     9408: <div class="sect2">
1.85      jmmv     9409: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9410: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87      wiz      9411:     emulation</h3></div></div></div>
                   9412: <p>There are some packages that provide libraries and
                   9413:     executables for running binaries from a one operating system
                   9414:     on a different one (if the latter supports it).  One example
                   9415:     is running Linux binaries on NetBSD.</p>
1.322     leot     9416: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9417:     helps in extracting and packaging Linux rpm packages.</p>
                   9418: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9419:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9420:     if all libraries for each installed executable can be found by
                   9421:     the dynamic linker.  Since the standard dynamic linker is run,
                   9422:     this fails for emulation packages, because the libraries used
                   9423:     by the emulation are not in the standard directories.</p>
                   9424: </div>
1.299     rillig   9425: <div class="sect2">
                   9426: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9427: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299     rillig   9428: <p>If a package installs images under the
                   9429:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9430:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9431:     database, you need to take some extra steps to make sure that the
                   9432:     shared theme directory is handled appropriately and that the cache
                   9433:     database is rebuilt:</p>
                   9434: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9435: <li class="listitem"><p>Include
                   9436:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9437: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9438:        entry that refers to the theme cache.</p></li>
                   9439: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9440:          directories from the <code class="filename">share/icons/hicolor</code>
                   9441:          hierarchy because they will be handled automatically.</p></li>
                   9442: </ol></div>
                   9443: <p>The best way to verify that the PLIST is correct with
                   9444:       respect to the last two points is to regenerate it using
                   9445:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9446: </div>
                   9447: <div class="sect2">
                   9448: <div class="titlepage"><div><div><h3 class="title">
1.318     nia      9449: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299     rillig   9450: <p>If a package installs <code class="filename">.desktop</code> files
                   9451:       under <code class="filename">share/applications</code> and these include
                   9452:       MIME information (MimeType key), you need to take extra steps to
                   9453:       ensure that they are registered into the MIME database:</p>
                   9454: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9455: <li class="listitem"><p>Include
                   9456:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9457: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9458:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9459:          It will be handled automatically.</p></li>
                   9460: </ol></div>
                   9461: <p>The best way to verify that the PLIST is correct with
                   9462:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9463:       print-PLIST</strong></span>.</p>
                   9464: </div>
                   9465: </div>
                   9466: <div class="sect1">
                   9467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9468: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9469: <p>In some cases one does not have the time to solve a problem
                   9470:   immediately. In this case, one can plainly mark a package as broken.  For
                   9471:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9472:   reason why the package is broken (similar to the
                   9473:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9474:   the package will immediately be shown this message, and the build
                   9475:   will not be even tried.</p>
                   9476: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9477:   intervals.</p>
                   9478: </div>
                   9479: </div>
                   9480: <div class="chapter">
                   9481: <div class="titlepage"><div><div><h2 class="title">
                   9482: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9483: <div class="toc">
                   9484: <p><b>Table of Contents</b></p>
                   9485: <dl class="toc">
                   9486: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9487: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9488: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9489: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9490: </dl>
                   9491: </div>
                   9492: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9493: site</a>:</p>
                   9494: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9495:   environment, an intuitive and attractive desktop for users, and the
                   9496:   GNOME development platform, an extensive framework for building
                   9497:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9498: <p>pkgsrc provides a seamless way to automatically build and install
                   9499: a complete GNOME environment <span class="emphasis"><em>under many different
                   9500: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9501: the most advanced build and packaging systems for GNOME due to its
                   9502: included technologies buildlink3, the wrappers and tools framework and
                   9503: automatic configuration file management.  Lots of efforts are put into
                   9504: achieving a completely clean deinstallation of installed software
                   9505: components.</p>
                   9506: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9507: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9508: under this operating system.</p>
1.299     rillig   9509: <p>This chapter is aimed at pkgsrc developers and other people
                   9510: interested in helping our GNOME porting and packaging efforts.  It
                   9511: provides instructions on how to manage the existing packages and some
                   9512: important information regarding their internals.</p>
                   9513: <div class="sect1">
                   9514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9515: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9516: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9517: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     9518: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.299     rillig   9519:     the core GNOME desktop environment.  It only includes the necessary
                   9520:     bits to get it to boot correctly, although it may lack important
                   9521:     functionality for daily operation.  The idea behind this package is
                   9522:     to let end users build their own configurations on top of this one,
                   9523:     first installing this meta package to achieve a functional setup and
                   9524:     then adding individual applications.</p></li>
1.322     leot     9525: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.299     rillig   9526:     complete installation of the GNOME platform and desktop as defined
                   9527:     by the GNOME project; this is based on the components distributed in
                   9528:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9529:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9530:     official FTP server.  Developer-only tools found in those
                   9531:     directories are not installed unless required by some other
                   9532:     component to work properly.  Similarly, packages from the bindings
                   9533:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9534:     in unless required as a dependency for an end-user component.  This
1.322     leot     9535:     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>
                   9536: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.299     rillig   9537:     Installs all the tools required to build a GNOME component when
                   9538:     fetched from the CVS repository.  These are required to let the
                   9539:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9540: </ul></div>
                   9541: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9542: sorted in a way that eases updates: a package may depend on other
                   9543: packages listed before it but not on any listed after it.  It is very
                   9544: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9545: change it to alphabetical sorting!</em></span></p>
                   9546: </div>
                   9547: <div class="sect1">
                   9548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9549: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9550: <p>Almost all GNOME applications are written in C and use a common
                   9551: set of tools as their build system.  Things get different with the new
                   9552: bindings to other languages (such as Python), but the following will
                   9553: give you a general idea on the minimum required tools:</p>
                   9554: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9555: <li class="listitem">
                   9556: <p>Almost all GNOME applications use the GNU Autotools as their
                   9557:     build system.  As a general rule you will need to tell this to your
                   9558:     package:</p>
                   9559: <pre class="programlisting">
1.338   ! nia      9560: GNU_CONFIGURE=  yes
        !          9561: USE_LIBTOOL=    yes
        !          9562: USE_TOOLS+=     gmake
1.299     rillig   9563: </pre>
                   9564: </li>
                   9565: <li class="listitem">
                   9566: <p>If the package uses pkg-config to detect dependencies, add this
                   9567:     tool to the list of required utilities:</p>
                   9568: <pre class="programlisting">
1.338   ! nia      9569: USE_TOOLS+=     pkg-config
1.299     rillig   9570: </pre>
1.322     leot     9571: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.299     rillig   9572:     the end of the build process to ensure that you did not miss to
                   9573:     specify any dependency in your package and that the version
                   9574:     requirements are all correct.</p>
                   9575: </li>
                   9576: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9577:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9578:     to handle dependencies and to force the package to use the latest
                   9579:     available version.</p></li>
                   9580: <li class="listitem">
                   9581: <p>If the package uses gtk-doc (a documentation generation
                   9582:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9583:     tool is rather big and the distfile should come with pregenerated
                   9584:     documentation anyway; if it does not, it is a bug that you ought to
                   9585:     report.  For such packages you should disable gtk-doc (unless it is
                   9586:     the default):</p>
                   9587: <pre class="programlisting">
1.338   ! nia      9588: CONFIGURE_ARGS+=        --disable-gtk-doc
1.299     rillig   9589: </pre>
                   9590: <p>The default location of installed HTML files
                   9591:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9592:     and should not be changed unless the package insists on installing
                   9593:     them somewhere else.  Otherwise programs as
                   9594:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9595:     do that with an entry similar to:</p>
                   9596: <pre class="programlisting">
1.338   ! nia      9597: CONFIGURE_ARGS+=        --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299     rillig   9598: </pre>
                   9599: </li>
                   9600: </ul></div>
                   9601: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9602: files under the installation prefix to maintain databases.  In this
                   9603: context, shared means that those exact same directories and files are
                   9604: used among several different packages, leading to conflicts in the
                   9605: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9606: handle the most common cases, so you have to forget about using
                   9607: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9608: omitting shared files from them.  If you find yourself doing those,
                   9609: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9610: <p>The following table lists the common situations that result in
                   9611: using shared directories or files.  For each of them, the appropriate
                   9612: solution is given.  After applying the solution be sure to
                   9613: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9614: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9615: <div class="table">
                   9616: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9617: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9618: <colgroup>
                   9619: <col>
                   9620: <col>
                   9621: </colgroup>
                   9622: <thead><tr>
                   9623: <th>If the package...</th>
                   9624: <th>Then...</th>
                   9625: </tr></thead>
                   9626: <tbody>
                   9627: <tr>
                   9628: <td>Installs icons under the
                   9629:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9630:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318     nia      9631: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, &#8220;Packages installing hicolor icons&#8221;</a>.</td>
1.299     rillig   9632: </tr>
                   9633: <tr>
                   9634: <td>Installs files under
                   9635:         <code class="filename">share/mime/packages</code>.</td>
1.318     nia      9636: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.299     rillig   9637: </tr>
                   9638: <tr>
                   9639: <td>Installs <code class="filename">.desktop</code> files under
                   9640:         <code class="filename">share/applications</code> and these include MIME
                   9641:         information.</td>
1.318     nia      9642: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.299     rillig   9643: </tr>
                   9644: </tbody>
                   9645: </table></div>
1.75      rillig   9646: </div>
1.299     rillig   9647: <br class="table-break">
1.75      rillig   9648: </div>
1.148     asau     9649: <div class="sect1">
1.87      wiz      9650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9651: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9652: <p>When seeing GNOME as a whole, there are two kinds of
                   9653: updates:</p>
                   9654: <div class="variablelist"><dl class="variablelist">
                   9655: <dt><span class="term">Major update</span></dt>
                   9656: <dd>
                   9657: <p>Given that there is still a very long way for GNOME 3 (if it
                   9658:       ever appears), we consider a major update one that goes from a
                   9659:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9660:       where <code class="literal">Y</code> is even and greater than
                   9661:       <code class="literal">X</code>.  These are hard to achieve because they
                   9662:       introduce lots of changes in the components' code and almost all
                   9663:       GNOME distfiles are updated to newer versions.  Some of them can
                   9664:       even break API and ABI compatibility with the previous major
                   9665:       version series.  As a result, the update needs to be done all at
                   9666:       once to minimize breakage.</p>
                   9667: <p>A major update typically consists of around 80 package
                   9668:       updates and the addition of some new ones.</p>
                   9669: </dd>
                   9670: <dt><span class="term">Minor update</span></dt>
                   9671: <dd>
                   9672: <p>We consider a minor update one that goes from a
                   9673:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9674:       one where <code class="literal">Y</code> is greater than
                   9675:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9676:       not update all GNOME components, can be done in an incremental way
                   9677:       and do not break API nor ABI compatibility.</p>
                   9678: <p>A minor update typically consists of around 50 package
                   9679:       updates, although the numbers here may vary a lot.</p>
                   9680: </dd>
                   9681: </dl></div>
                   9682: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9683: release (either major or minor), the following steps should be
                   9684: followed:</p>
                   9685: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9686: <li class="listitem">
1.299     rillig   9687: <p>Get a list of all the tarballs that form the new release by
                   9688:     using the following commands.  These will leave the full list of the
                   9689:     components' distfiles into the <code class="filename">list.txt</code>
                   9690:     file:</p>
                   9691: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9692:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9693:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9694: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9695:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9696:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9697: </li>
1.299     rillig   9698: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9699:     bump their version to the release you are updating them to.  The
                   9700:     three meta packages should be always consistent with versioning.
                   9701:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9702:     in them.</p></li>
1.128     wiz      9703: <li class="listitem">
1.299     rillig   9704: <p>For each meta package, update all its
                   9705:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9706:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9707:     newer version (even if found in the FTP) because the meta packages
                   9708:     are supposed to list the exact versions that form a specific GNOME
                   9709:     release.  Exceptions are permitted here if a newer version solves a
                   9710:     serious issue in the overall desktop experience; these typically
                   9711:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9712:     from the developers.</p>
                   9713: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9714:     should be updated to the latest version available (if found in
                   9715:     pkgsrc).  This is the case, for example, of the dependencies on the
1.322     leot     9716:     GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.75      rillig   9717: </li>
1.128     wiz      9718: <li class="listitem">
1.299     rillig   9719: <p>Generate a patch from the modified meta packages and extract the
                   9720:     list of "new" lines.  This will provide you an outline on what
                   9721:     packages need to be updated in pkgsrc and in what order:</p>
                   9722: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.75      rillig   9723: </li>
1.299     rillig   9724: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9725:     installed packages and start over from scratch at this point.</p></li>
                   9726: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9727:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9728:     it in order.  For major desktop updates none of these should be
                   9729:     committed until the entire set is completed because there are chances
                   9730:     of breaking not-yet-updated packages.</p></li>
                   9731: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9732:     the tree one by one with appropriate log messages.  At the end,
                   9733:     commit the three meta package updates and all the corresponding
                   9734:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9735:     <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>
                   9736: </ol></div>
                   9737: </div>
                   9738: <div class="sect1">
                   9739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9740: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9741: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9742: packages.  Please, it is very important that you always, always,
                   9743: <span class="strong"><strong>always</strong></span> feed back any portability
                   9744: 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
                   9745: their attention on portability issues and to ensure that future versions
                   9746: can be built out-of-the box on NetBSD.  The less custom patches in
                   9747: pkgsrc, the easier further updates are.  Those developers in charge of
                   9748: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 9749: <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
                   9750: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   9751: of them do.  Do not be short on your reports: always provide detailed
                   9752: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 9753: maximum portability and, if at all possible, provide a patch against the
                   9754: main Git branch.  The more verbose you are, the higher chances of your
                   9755: patch being accepted.</p>
1.299     rillig   9756: <p>Also, please avoid using preprocessor magic to fix portability
                   9757: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9758: GNOME to their operating system, the official GNOME sources are now
                   9759: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9760: and similar macros.  This hurts portability.  Please see our patching
                   9761: 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
                   9762: details.</p>
                   9763: </div>
1.75      rillig   9764: </div>
1.148     asau     9765: <div class="chapter">
1.75      rillig   9766: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9767: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9768: <div class="toc">
                   9769: <p><b>Table of Contents</b></p>
1.210     leot     9770: <dl class="toc">
1.267     rillig   9771: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9772: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9773: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9774: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9775: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9776: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9777: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9778: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9779: </dl>
                   9780: </div>
1.148     asau     9781: <div class="sect1">
1.75      rillig   9782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9783: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9784: <p>Our policy is that we accept binaries only from pkgsrc
                   9785:        developers to guarantee that the packages don't contain any
                   9786:        trojan horses etc. This is not to annoy anyone but rather to
                   9787:        protect our users! You're still free to put up your home-made
                   9788:        binary packages and tell the world where to get them. NetBSD
                   9789:        developers doing bulk builds and wanting to upload them please
1.267     rillig   9790:        see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174     asau     9791: builds)</i></a>.</p>
1.75      rillig   9792: </div>
1.148     asau     9793: <div class="sect1">
1.75      rillig   9794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9795: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333     nia      9796: <p>Firstly, you can import new packages into
                   9797:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
                   9798:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   9799:        for details.</p>
                   9800: <p>Next, check that your package is complete, compiles and
1.299     rillig   9801:        runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.333     nia      9802:        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>
                   9803:        tool and fix any errors that appear.</p>
                   9804: <p>Finally, send a report to the pkgsrc bug tracking system,
1.322     leot     9805:        either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9806:        that, go to the web page
1.289     leot     9807:        <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      9808:        which contains some instructions and a link to a form where you
                   9809:        can submit packages.  The
1.322     leot     9810:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      9811:        also available as a substitute for either of the above two tools.
                   9812:        </p>
1.87      wiz      9813: <p>In the form of the problem report, the category should be
1.128     wiz      9814:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9815:        and version number, and the description field should contain a
                   9816:        short description of your package (contents of the COMMENT
1.333     nia      9817:        variable or DESCR file are OK).</p>
1.75      rillig   9818: </div>
1.148     asau     9819: <div class="sect1">
1.75      rillig   9820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9821: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9822: <p>Please note all package additions, updates, moves, and
1.93      rillig   9823:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9824:        important to keep this file up to date and conforming to the
                   9825:        existing format, because it will be used by scripts to
1.289     leot     9826:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9827:        sites. Additionally, check the
1.76      rillig   9828:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9829:        for the package you updated or removed, in case it was mentioned
                   9830:        there.</p>
                   9831: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9832:        bumped, the change should appear in
1.93      rillig   9833:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9834:        related or otherwise relevant. Mass bumps that result from a
                   9835:        dependency being updated should not be mentioned. In all other
                   9836:        cases it's the developer's decision.</p>
                   9837: <p>There is a make target that helps in creating proper
1.110     hubertf  9838:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9839:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9840:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9841:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9842:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9843:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9844:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9845:   For new packages, or package moves or removals, set the
                   9846:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9847:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9848:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9849:   not the same as your NetBSD login name. The target also automatically
                   9850:   removes possibly existing entries for the package in the
                   9851:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9852:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9853:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9854:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9855:   makes the cvs commands use the main repository.
                   9856:   </p>
1.75      rillig   9857: </div>
1.148     asau     9858: <div class="sect1">
1.75      rillig   9859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9860: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9861: <p>For several years, there have been mirrors of pkgsrc in
                   9862:   fossil, git, and hg. Standard practise when using these tools is to
                   9863:   make the first line of a commit message function as a summary that
                   9864:   can be read without the rest, such as is commonly done with "git log
                   9865:   --oneline". For this reason, we have the following guidelines for
                   9866:   pkgsrc commit messages:</p>
                   9867: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9868: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9869:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9870:     package, include the name of the package. For updates, include the
                   9871:     version to which it is updated.</p></li>
                   9872: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9873: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9874:     package, reason for a change) and any relevant PRs. Wrap this
                   9875:     section.</p></li>
                   9876: </ul></div>
                   9877: <p>Here is an example:
                   9878:   </p>
                   9879: <pre class="programlisting">
                   9880:   libxslt: update to 1.0.30
                   9881: 
                   9882:   Changes since 1.0.29:
                   9883:   ...
                   9884:   </pre>
                   9885: <p>
                   9886:   </p>
                   9887: <p>Here is another example:
                   9888:   </p>
                   9889: <pre class="programlisting">
                   9890:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9891: 
                   9892:   (rationale)
                   9893:   </pre>
                   9894: <p>
                   9895:   </p>
                   9896: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9897:   allowed on the pkgsrc repository to change commit messages.</p>
                   9898: </div>
                   9899: <div class="sect1">
                   9900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9901: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9902: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9903:   access to the pkgsrc repository.</p>
                   9904: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9905: Start by adding the directory and then files in the directory. Don't
                   9906: forget to add the new package to the category's
                   9907: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9908: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9909: <pre class="programlisting">
                   9910: <code class="prompt">$</code> cd .../pkgsrc/category
                   9911: <code class="prompt">$</code> cvs add pkgname
                   9912: <code class="prompt">$</code> cd pkgname
                   9913: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9914: <code class="prompt">$</code> cvs add patches/p*
                   9915: <code class="prompt">$</code> cvs status | less
1.141     wiz      9916: <code class="prompt">$</code> cvs commit
1.140     wiz      9917: <code class="prompt">$</code> cd ..
                   9918: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9919: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9920: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9921: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9922: </pre>
1.87      wiz      9923: <p>The commit message of the initial import should include part of the
1.76      rillig   9924:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9925:   what the package is/does.</p>
1.140     wiz      9926: <p>Also mention the new package in
                   9927: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9928: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9929: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9930: </div>
1.148     asau     9931: <div class="sect1">
1.75      rillig   9932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9933: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9934: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9935:   changes between old and new versions into the commit log when updating
1.87      wiz      9936:   a package. There are various reasons for this:</p>
1.148     asau     9937: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9938: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9939:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9940: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9941:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9942: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9943:   repository is very useful for people who read the pkgsrc-changes mailing
                   9944:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9945:   the package.</p></li>
1.75      rillig   9946: </ul></div>
1.87      wiz      9947: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9948:   has been released, it should not automatically be upgraded in the CVS
                   9949:   repository.  We prefer to be conservative in the packages that are
                   9950:   included in pkgsrc - development or beta packages are not really the
                   9951:   best thing for most places in which pkgsrc is used. Please use your
                   9952:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9953:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9954: </div>
1.148     asau     9955: <div class="sect1">
1.75      rillig   9956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9957: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9958: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9959: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9960:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9961: <p>
1.290     gutterid 9962:   Also, when renaming a package, please add
1.282     leot     9963:   the package name and version pattern(s) of the previous package
                   9964:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9965:   This may be repeated for multiple renames.
                   9966:   The new package would be an exact replacement.
1.282     leot     9967:   Example:
1.122     reed     9968: </p>
1.282     leot     9969: <pre class="programlisting">
                   9970: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9971: SUPERSEDES+=    optcomp-[0-9]*
                   9972: </pre>
1.128     wiz      9973: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9974:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9975:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9976:   not be an exact replacement but is a suggestion for the replaced
                   9977:   functionality.</p>
                   9978: </div>
1.148     asau     9979: <div class="sect1">
1.122     reed     9980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9981: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9982: <p>It is preferred that packages are not renamed or moved, but if needed
                   9983:   please follow these steps.
                   9984: </p>
1.128     wiz      9985: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9986: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9987: <li class="listitem">
1.75      rillig   9988: <p>Remove all CVS dirs.</p>
1.87      wiz      9989: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9990: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9991: <p>and use that for further work.</p>
1.75      rillig   9992: </li>
1.128     wiz      9993: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9994: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9995: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9996: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9997: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9998: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9999: for doing an update using pkgsrc building; for example, it can
1.322     leot     10000: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     10001: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   10002: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   10003: it may have multiple matches, so the tool should also check on the
                   10004: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   10005: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   10006: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      10007: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   10008: place.</p></li>
1.128     wiz      10009: <li class="listitem">
1.75      rillig   10010: <p>Check if any package depends on it:
                   10011: </p>
                   10012: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   10013: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   10014: </li>
1.128     wiz      10015: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   10016: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   10017: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   10018: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   10019: <li class="listitem">
1.75      rillig   10020: <p>Commit the changed and removed files:</p>
                   10021: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      10022: <p>(and any packages from step 5, of course).</p>
1.75      rillig   10023: </li>
                   10024: </ol></div>
                   10025: </div>
                   10026: </div>
1.148     asau     10027: <div class="chapter">
1.75      rillig   10028: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   10029: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   10030: <p>This section contains the answers to questions that may
                   10031:        arise when you are writing a package. If you don't find your
                   10032:        question answered here, first have a look in the other chapters,
                   10033:        and if you still don't have the answer, ask on the
                   10034:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     10035: <div class="qandaset">
1.289     leot     10036: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   10037: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   10038:        MAKEFLAGS, .MAKEFLAGS and
                   10039:        MAKE_FLAGS?</a>
                   10040: </dt>
1.267     rillig   10041: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   10042:        MAKE, GMAKE and
                   10043:        MAKE_PROGRAM?</a>
                   10044: </dt>
1.267     rillig   10045: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   10046:        CC, PKG_CC and
                   10047:        PKGSRC_COMPILER?</a>
                   10048: </dt>
1.338   ! nia      10049: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   10050:        VARNAME=BUILDLINK_PREFIX.foo
                   10051:        say it's empty?</a>
                   10052: </dt>
1.338   ! nia      10053: <dt>24.5. <a href="#devfaq.master_sites">What does
1.78      rillig   10054:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   10055:        don't understand the := inside
                   10056:        it.</a>
                   10057: </dt>
1.338   ! nia      10058: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   10059:        developers?</a>
                   10060: </dt>
1.338   ! nia      10061: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   10062:        documentation?</a>
                   10063: </dt>
1.338   ! nia      10064: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289     leot     10065: What shall I do?</a>
1.92      rillig   10066: </dt>
1.75      rillig   10067: </dl>
1.148     asau     10068: <table border="0" style="width: 100%;">
                   10069: <colgroup>
1.75      rillig   10070: <col align="left" width="1%">
1.128     wiz      10071: <col>
1.148     asau     10072: </colgroup>
1.75      rillig   10073: <tbody>
1.148     asau     10074: <tr class="question">
1.75      rillig   10075: <td align="left" valign="top">
1.289     leot     10076: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   10077: </td>
                   10078: <td align="left" valign="top"><p>What is the difference between
                   10079:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10080:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10081: </tr>
                   10082: <tr class="answer">
1.91      rillig   10083: <td align="left" valign="top"></td>
1.338   ! nia      10084: <td align="left" valign="top">
        !          10085: <p><code class="varname">MAKEFLAGS</code> are the flags passed
        !          10086:        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>
        !          10087: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
        !          10088:        passed to the <code class="varname">MAKE_PROGRAM</code> when building the
        !          10089:        package.</p>
        !          10090: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
        !          10091:        <span class="command"><strong>bmake</strong></span> and should not be used by
        !          10092:        packages.</p>
        !          10093: </td>
1.75      rillig   10094: </tr>
1.148     asau     10095: <tr class="question">
1.75      rillig   10096: <td align="left" valign="top">
1.289     leot     10097: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   10098: </td>
                   10099: <td align="left" valign="top"><p>What is the difference between
                   10100:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10101:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10102: </tr>
                   10103: <tr class="answer">
1.91      rillig   10104: <td align="left" valign="top"></td>
1.338   ! nia      10105: <td align="left" valign="top">
        !          10106: <p><code class="varname">MAKE</code> is the path to the
1.322     leot     10107:        <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.338   ! nia      10108:        infrastructure.</p>
        !          10109: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
        !          10110:        need to say <code class="varname">USE_TOOLS+=gmake</code> to use
        !          10111:        that.</p>
        !          10112: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
        !          10113:        program that is used for building the package.</p>
        !          10114: </td>
1.75      rillig   10115: </tr>
1.148     asau     10116: <tr class="question">
1.75      rillig   10117: <td align="left" valign="top">
1.289     leot     10118: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   10119: </td>
                   10120: <td align="left" valign="top"><p>What is the difference between
                   10121:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10122:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10123: </tr>
                   10124: <tr class="answer">
1.91      rillig   10125: <td align="left" valign="top"></td>
1.75      rillig   10126: <td align="left" valign="top">
1.338   ! nia      10127: <p><code class="varname">CC</code> is the path to the real C
        !          10128:        compiler, which can be configured by the pkgsrc user.</p>
        !          10129: <p><code class="varname">PKG_CC</code> is the path to the compiler
        !          10130:        wrapper.</p>
        !          10131: <p><code class="varname">PKGSRC_COMPILER</code> is
        !          10132:        <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
        !          10133:        compiler that should be used. See
        !          10134:        <code class="filename">mk/compiler.mk</code> for more information about
        !          10135:        the latter variable.</p>
1.75      rillig   10136: </td>
                   10137: </tr>
1.148     asau     10138: <tr class="question">
1.75      rillig   10139: <td align="left" valign="top">
1.338   ! nia      10140: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.75      rillig   10141: </td>
1.110     hubertf  10142: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10143:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10144:        say it's empty?</p></td>
                   10145: </tr>
                   10146: <tr class="answer">
1.91      rillig   10147: <td align="left" valign="top"></td>
1.75      rillig   10148: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10149:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10150:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10151:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10152:        command.</p></td>
                   10153: </tr>
1.148     asau     10154: <tr class="question">
1.78      rillig   10155: <td align="left" valign="top">
1.338   ! nia      10156: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.78      rillig   10157: </td>
                   10158: <td align="left" valign="top"><p>What does
1.220     wiz      10159:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10160:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10161:        it.</p></td>
                   10162: </tr>
                   10163: <tr class="answer">
1.91      rillig   10164: <td align="left" valign="top"></td>
1.338   ! nia      10165: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
        !          10166:        assignment operator, even though it may look like one.
1.78      rillig   10167:        Instead, it is a degenerate form of
1.220     wiz      10168:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.322     leot     10169:        which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10170:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10171:        case of <code class="varname">MASTER_SITE_*</code>,
                   10172:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10173:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10174:        <code class="code">package/</code>. That's where the
                   10175:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10176:        together.</p></td>
                   10177: </tr>
1.148     asau     10178: <tr class="question">
1.78      rillig   10179: <td align="left" valign="top">
1.338   ! nia      10180: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.78      rillig   10181: </td>
                   10182: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10183:        developers?</p></td>
                   10184: </tr>
                   10185: <tr class="answer">
1.91      rillig   10186: <td align="left" valign="top"></td>
1.148     asau     10187: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10188: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   10189: <dd><p>This is a list for technical discussions related
                   10190:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10191:        pkgsrc infrastructure, proposed new features, questions related
                   10192:        to porting pkgsrc to a new platform, advice for maintaining a
                   10193:        package, patches that affect many packages, help requests moved
                   10194:        from pkgsrc-users when an infrastructure bug is found,
                   10195:        etc.</p></dd>
1.289     leot     10196: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   10197: <dd><p>All bug reports in category "pkg" sent with
1.322     leot     10198:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10199:        directly; use one of the other mailing
                   10200:        lists.</p></dd>
                   10201: </dl></div></td>
                   10202: </tr>
1.148     asau     10203: <tr class="question">
1.80      rillig   10204: <td align="left" valign="top">
1.338   ! nia      10205: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.80      rillig   10206: </td>
                   10207: <td align="left" valign="top"><p>Where is the pkgsrc
                   10208:        documentation?</p></td>
                   10209: </tr>
                   10210: <tr class="answer">
1.91      rillig   10211: <td align="left" valign="top"></td>
1.80      rillig   10212: <td align="left" valign="top">
                   10213: <p>There are many places where you can find
                   10214:        documentation about pkgsrc:</p>
1.148     asau     10215: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10216: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10217:        of chapters that explain large parts of pkgsrc, but some
                   10218:        chapters tend to be outdated. Which ones they are is hard to
                   10219:        say.</p></li>
1.289     leot     10220: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   10221:        about certain features, announcements of new parts of the pkgsrc
                   10222:        infrastructure and sometimes even announcements that a certain
                   10223:        feature has been marked as obsolete. The benefit here is that
                   10224:        each message has a date appended to it.</p></li>
1.128     wiz      10225: <li class="listitem"><p>Many of the files in the
1.80      rillig   10226:        <code class="filename">mk/</code> directory start with a comment that
                   10227:        describes the purpose of the file and how it can be used by the
1.92      rillig   10228:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10229:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10230:        help</strong></span>.</p></li>
1.128     wiz      10231: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10232:        information, but they tend to be highly abbreviated, especially
                   10233:        for actions that occur often. Some contain a detailed
                   10234:        description of what has changed, but they are geared towards the
                   10235:        other pkgsrc developers, not towards an average pkgsrc user.
                   10236:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10237:        don't know what has been before, these messages may not be worth
                   10238:        too much to you.</p></li>
1.128     wiz      10239: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10240:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10241:        mind of the developer who wrote the code. To get this
1.110     hubertf  10242:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10243:        to see who has written it and ask on the
                   10244:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10245:        find your questions later (see above). To be sure that the
                   10246:        developer in charge reads the mail, you may CC him or
                   10247:        her.</p></li>
                   10248: </ul></div>
1.299     rillig   10249: </td>
                   10250: </tr>
                   10251: <tr class="question">
                   10252: <td align="left" valign="top">
1.338   ! nia      10253: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.299     rillig   10254: </td>
1.338   ! nia      10255: <td align="left" valign="top"><p>I have a little time to kill.
1.299     rillig   10256: What shall I do?</p></td>
                   10257: </tr>
                   10258: <tr class="answer">
                   10259: <td align="left" valign="top"></td>
                   10260: <td align="left" valign="top">
                   10261: <p>This is not really an FAQ yet, but here's the answer
                   10262: anyway.</p>
1.148     asau     10263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10264: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322     leot     10265:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.299     rillig   10266:     will tell you about newer versions of installed packages that are
                   10267:     available, but not yet updated in pkgsrc.</p></li>
                   10268: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10269:     &mdash; it contains a list of suggested new packages and a list of
                   10270:     cleanups and enhancements for pkgsrc that would be nice to
                   10271:     have.</p></li>
                   10272: <li class="listitem"><p>Review packages for which review was requested on
                   10273:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10274:     mailing list.</p></li>
1.85      jmmv     10275: </ul></div>
1.299     rillig   10276: </td>
1.85      jmmv     10277: </tr>
                   10278: </tbody>
1.299     rillig   10279: </table>
1.85      jmmv     10280: </div>
                   10281: </div>
1.75      rillig   10282: </div>
1.148     asau     10283: <div class="part">
1.75      rillig   10284: <div class="titlepage"><div><div><h1 class="title">
                   10285: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10286: <div class="partintro">
1.75      rillig   10287: <div></div>
                   10288: <p>This part of the guide deals with everything
                   10289:        from the infrastructure that is behind the interfaces described
                   10290:        in the developer's guide. A casual package maintainer should not
                   10291:        need anything from this part.</p>
                   10292: <div class="toc">
                   10293: <p><b>Table of Contents</b></p>
1.210     leot     10294: <dl class="toc">
1.299     rillig   10295: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10296: <dd><dl>
1.299     rillig   10297: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10298: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10299: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75      rillig   10300: <dd><dl>
1.299     rillig   10301: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10302: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75      rillig   10303: </dl></dd>
1.299     rillig   10304: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10305: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10306: <dd><dl>
1.299     rillig   10307: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10308: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10309: </dl></dd>
1.299     rillig   10310: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10311: <dd><dl>
1.299     rillig   10312: <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>
                   10313: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10314: </dl></dd>
                   10315: </dl></dd>
1.299     rillig   10316: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig   10317: <dd><dl>
1.299     rillig   10318: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10319: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10320: <dd><dl>
1.299     rillig   10321: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10322: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10323: </dl></dd>
                   10324: </dl></dd>
1.299     rillig   10325: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10326: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   10327: </dl>
                   10328: </div>
                   10329: </div>
1.148     asau     10330: <div class="chapter">
1.75      rillig   10331: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10332: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10333: <div class="toc">
                   10334: <p><b>Table of Contents</b></p>
1.210     leot     10335: <dl class="toc">
1.299     rillig   10336: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10337: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10338: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig   10339: <dd><dl>
1.299     rillig   10340: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10341: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig   10342: </dl></dd>
1.299     rillig   10343: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10344: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10345: <dd><dl>
1.299     rillig   10346: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10347: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10348: </dl></dd>
1.299     rillig   10349: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10350: <dd><dl>
1.299     rillig   10351: <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>
                   10352: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10353: </dl></dd>
                   10354: </dl>
                   10355: </div>
                   10356: <p>The pkgsrc infrastructure consists of many small Makefile
                   10357:        fragments. Each such fragment needs a properly specified
                   10358:        interface. This chapter explains how such an interface looks
                   10359:        like.</p>
1.148     asau     10360: <div class="sect1">
1.75      rillig   10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10362: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10363: <p>Whenever a variable is defined in the pkgsrc
                   10364:        infrastructure, the location and the way of definition provide
                   10365:        much information about the intended use of that variable.
                   10366:        Additionally, more documentation may be found in a header
                   10367:        comment or in this pkgsrc guide.</p>
                   10368: <p>A special file is
                   10369:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10370:        variables that are intended to be user-defined. They are either
                   10371:        defined using the <code class="literal">?=</code> operator or they are
                   10372:        left undefined because defining them to anything would
1.128     wiz      10373:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10374:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10375:        file.</p>
                   10376: <p>Outside this file, the following conventions apply:
                   10377:        Variables that are defined using the <code class="literal">?=</code>
                   10378:        operator may be overridden by a package.</p>
                   10379: <p>Variables that are defined using the <code class="literal">=</code>
                   10380:        operator may be used read-only at run-time.</p>
                   10381: <p>Variables whose name starts with an underscore must not be
                   10382:        accessed outside the pkgsrc infrastructure at all. They may
                   10383:        change without further notice.</p>
1.148     asau     10384: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10385: <h3 class="title">Note</h3>
                   10386: <p>These conventions are currently not applied
                   10387:        consistently to the complete pkgsrc
                   10388:        infrastructure.</p>
                   10389: </div>
                   10390: </div>
1.148     asau     10391: <div class="sect1">
1.81      rillig   10392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10393: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10394: <p>All variables that contain lists of things should default
                   10395:        to being empty. Two examples that do not follow this rule are
                   10396:        <code class="varname">USE_LANGUAGES</code> and
                   10397:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10398:        modified using the <code class="literal">+=</code> operator in package
                   10399:        <code class="filename">Makefile</code>s (or other files included by
                   10400:        them), since there is no guarantee whether the variable is
                   10401:        already set or not, and what its value is. In the case of
1.128     wiz      10402:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10403:        the default value and just define it as in the following
                   10404:        example.</p>
                   10405: <pre class="programlisting">
1.100     rillig   10406: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10407: </pre>
                   10408: <p>Because of the selection of this default value, the same
                   10409:        value appears in many package Makefiles. Similarly for
                   10410:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10411:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10412:        doesn't stand out. Nevertheless it is mentioned in many
                   10413:        files.</p>
                   10414: </div>
1.148     asau     10415: <div class="sect1">
1.81      rillig   10416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10417: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148     asau     10418: <div class="sect2">
1.75      rillig   10419: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10420: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75      rillig   10421: <p>Variable evaluation takes place either at load time or at
                   10422:        runtime, depending on the context in which they occur. The
                   10423:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10425: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10426:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10427: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10428:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10429: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10430: </ul></div>
                   10431: <p>A special exception are references to the iteration
                   10432:        variables of <code class="literal">.for</code> loops, which are expanded
                   10433:        inline, no matter in which context they appear.</p>
                   10434: <p>As the values of variables may change during load time,
                   10435:        care must be taken not to evaluate them by accident. Typical
                   10436:        examples for variables that should not be evaluated at load time
                   10437:        are <code class="varname">DEPENDS</code> and
                   10438:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10439:        clear, here is an example:</p>
                   10440: <pre class="programlisting">
1.100     rillig   10441: CONFIGURE_ARGS=         # none
                   10442: CFLAGS=                 -O
                   10443: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10444: 
1.100     rillig   10445: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10446: 
1.100     rillig   10447: CFLAGS+=                -Wall
1.222     sevan    10448: </pre>
1.75      rillig   10449: <p>This code shows how the use of the <code class="literal">:=</code>
                   10450:        operator can quickly lead to unexpected results. The first
                   10451:        paragraph is fairly common code. The second paragraph evaluates
                   10452:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10453:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10454:        <code class="literal">-Wall</code> is appended to the
                   10455:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10456:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10457:        paragraphs from above typically occur in completely unrelated
                   10458:        files.</p>
                   10459: </div>
1.148     asau     10460: <div class="sect2">
1.75      rillig   10461: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10462: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75      rillig   10463: <p>After all the files have been loaded, the values of the
                   10464:        variables cannot be changed anymore. Variables that are used in
                   10465:        the shell commands are expanded at this point.</p>
                   10466: </div>
                   10467: </div>
1.148     asau     10468: <div class="sect1">
1.75      rillig   10469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10470: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10471: <p>There are many ways in which the definition and use of a
1.218     rillig   10472:        variable can be restricted in order to detect bugs and violations
                   10473:        of the (mostly unwritten) policies. A package can be checked with
                   10474:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10475:        rules.</p>
1.78      rillig   10476: </div>
1.148     asau     10477: <div class="sect1">
1.78      rillig   10478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10479: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10480: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10481:        of the following classes. Cases where a file falls into more
                   10482:        than one class should be avoided as it often leads to subtle
                   10483:        bugs.</p>
1.148     asau     10484: <div class="sect2">
1.75      rillig   10485: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10486: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10487: <p>In a traditional imperative programming language some of
1.76      rillig   10488:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10489:        procedures. They take some input parameters and&mdash;after
                   10490:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10491:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10492:        care must be taken not to use parameter names that have already
                   10493:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10494:        bad choice for a parameter name.</p>
                   10495: <p>Procedures are completely evaluated at preprocessing time.
                   10496:        That is, when calling a procedure all input parameters must be
                   10497:        completely resolvable. For example,
                   10498:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10499:        parameter since it is very likely that further text will be
                   10500:        added after calling the procedure, which would effectively apply
                   10501:        the procedure to only a part of the variable. Also, references
1.218     rillig   10502:        to other variables will be modified after calling the
1.75      rillig   10503:        procedure.</p>
                   10504: <p>A procedure can declare its output parameters either as
                   10505:        suitable for use in preprocessing directives or as only
                   10506:        available at runtime. The latter alternative is for variables
                   10507:        that contain references to other runtime variables.</p>
                   10508: <p>Procedures shall be written such that it is possible to
                   10509:        call the procedure more than once. That is, the file must not
                   10510:        contain multiple-inclusion guards.</p>
                   10511: <p>Examples for procedures are
1.76      rillig   10512:        <code class="filename">mk/bsd.options.mk</code> and
                   10513:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10514:        that the parameters are evaluated at load time, they should be
                   10515:        assigned using the <code class="literal">:=</code> operator, which should
                   10516:        be used only for this purpose.</p>
                   10517: </div>
1.148     asau     10518: <div class="sect2">
1.75      rillig   10519: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10520: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10521: <p>Action files take some input parameters and may define
                   10522:        runtime variables. They shall not define loadtime variables.
                   10523:        There are action files that are included implicitly by the
                   10524:        pkgsrc infrastructure, while other must be included
                   10525:        explicitly.</p>
                   10526: <p>An example for action files is
1.76      rillig   10527:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10528: </div>
                   10529: </div>
1.148     asau     10530: <div class="sect1">
1.81      rillig   10531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10532: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10533: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10534:        a set of variable definitions, and include the file
                   10535:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10536:        Before that, they may also include various other
                   10537:        <code class="filename">*.mk</code> files if they need to query the
                   10538:        availability of certain features like the type of compiler or
                   10539:        the X11 implementation. Due to the heavy use of preprocessor
                   10540:        directives like <code class="literal">.if</code> and
                   10541:        <code class="literal">.for</code>, the order in which the files are loaded
                   10542:        matters.</p>
                   10543: <p>This section describes at which point the various files
                   10544:        are loaded and gives reasons for that order.</p>
1.148     asau     10545: <div class="sect2">
1.81      rillig   10546: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10547: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10548: </h3></div></div></div>
                   10549: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10550:        is to define some essential variables like
                   10551:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10552:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10553: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10554:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10555:        After that, those variables
1.81      rillig   10556:        that have not been overridden by the user are loaded from
                   10557:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10558: <p>After the user settings, the system settings and platform
                   10559:        settings are loaded, which may override the user
                   10560:        settings.</p>
                   10561: <p>Then, the tool definitions are loaded. The tool wrappers
                   10562:        are not yet in effect. This only happens when building a
                   10563:        package, so the proper variables must be used instead of the
                   10564:        direct tool names.</p>
                   10565: <p>As the last steps, some essential variables from the
                   10566:        wrapper and the package system flavor are loaded, as well as the
                   10567:        variables that have been cached in earlier phases of a package
                   10568:        build.</p>
                   10569: </div>
1.148     asau     10570: <div class="sect2">
1.81      rillig   10571: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10572: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10573: </h3></div></div></div>
1.81      rillig   10574: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10575: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10576:        loaded, which fill default values for those variables that have
1.93      rillig   10577:        not been defined by the package. These variables may later
1.81      rillig   10578:        be used even in unrelated files.</p>
                   10579: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10580:        provides the target <code class="literal">error-check</code> that is added
                   10581:        as a special dependency to all other targets that use
                   10582:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10583:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10584: <p>Then, the package-specific hacks from
                   10585:        <code class="filename">hacks.mk</code> are included.</p>
                   10586: <p>Then, various other files follow. Most of them don't have
                   10587:        any dependencies on what they need to have included before or
                   10588:        after them, though some do.</p>
                   10589: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10590:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10591:        restricts the use of these variables to all the files that have
                   10592:        been included before. Appearances in later files will be
                   10593:        silently ignored.</p>
                   10594: <p>Then, the files for the main targets are included, in the
                   10595:        order of later execution, though the actual order should not
                   10596:        matter.</p>
                   10597: <p>At last, some more files are included that don't set any
                   10598:        interesting variables but rather just define make targets to be
                   10599:        executed.</p>
                   10600: </div>
                   10601: </div>
1.75      rillig   10602: </div>
1.148     asau     10603: <div class="chapter">
1.75      rillig   10604: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10605: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75      rillig   10606: <div class="toc">
                   10607: <p><b>Table of Contents</b></p>
1.210     leot     10608: <dl class="toc">
1.299     rillig   10609: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10610: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10611: <dd><dl>
1.299     rillig   10612: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10613: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10614: </dl></dd>
                   10615: </dl>
                   10616: </div>
                   10617: <p>The pkgsrc infrastructure consists of a large codebase,
                   10618:        and there are many corners where every little bit of a file is
                   10619:        well thought out, making pkgsrc likely to fail as soon as
                   10620:        anything is changed near those parts. To prevent most changes
                   10621:        from breaking anything, a suite of regression tests should go
                   10622:        along with every important part of the pkgsrc infrastructure.
                   10623:        This chapter describes how regression tests work in pkgsrc and
                   10624:        how you can add new tests.</p>
1.148     asau     10625: <div class="sect1">
1.75      rillig   10626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10627: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322     leot     10628: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10629:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10630:        can simply run that command, which will run all tests in the
1.283     rillig   10631:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10632: </div>
1.148     asau     10633: <div class="sect1">
1.75      rillig   10634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10635: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10636: <p>Every directory in the <code class="filename">regress/</code>
                   10637:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10638:        is considered a regression test. This file is a shell program
1.110     hubertf  10639:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10640:        The following functions can be overridden to suit your
                   10641:        needs.</p>
1.148     asau     10642: <div class="sect2">
1.75      rillig   10643: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10644: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10645: <p>These functions do not take any parameters. Although they
                   10646:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.289     leot     10647:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10648:        question</a> for details.</p>
1.148     asau     10649: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10650: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10651: <dd><p>This function prepares the environment for the
                   10652:        test. By default it does nothing.</p></dd>
1.218     rillig   10653: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10654: <dd>
                   10655: <p>This function runs the actual test. By default,
1.75      rillig   10656:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10657:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10658:        error messages into the file
1.218     rillig   10659:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10660: <p>When defining this function, make sure that all output that
                   10661:        needs to be checked is written to the correct output file.
                   10662:        Example:</p>
                   10663: <pre class="programlisting">
                   10664: do_test() {
1.223     rillig   10665:         echo "Example output"
1.218     rillig   10666: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10667: </pre>
                   10668: </dd>
                   10669: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10670: <dd>
                   10671: <p>This function is run after the test and is
1.75      rillig   10672:        typically used to compare the actual output from the one that is
                   10673:        expected. It can make use of the various helper functions from
1.218     rillig   10674:        the next section. Example:</p>
                   10675: <pre class="programlisting">
                   10676: check_result() {
1.223     rillig   10677:         exit_status 0
                   10678:         output_require "Example"
                   10679:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10680:         output_prohibit "no such file or directory"
1.283     rillig   10681:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10682: }
                   10683: </pre>
                   10684: </dd>
                   10685: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10686: <dd><p>This function cleans everything up after the
                   10687:        test has been run. By default it does nothing.</p></dd>
                   10688: </dl></div>
                   10689: </div>
1.148     asau     10690: <div class="sect2">
1.75      rillig   10691: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10692: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148     asau     10693: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10694: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10695: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10696: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10697: <dd><p>This function compares the exitcode of the
1.218     rillig   10698:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10699:        If they differ, the test will fail.</p></dd>
1.218     rillig   10700: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10701: <dd>
                   10702: <p>This function checks for each of its parameters
                   10703:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10704:        extended regular expression. If it does not, the test will
1.218     rillig   10705:        fail. Example:</p>
                   10706: <pre class="programlisting">
1.219     rillig   10707: output_require "looks fine"
                   10708: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10709: </pre>
                   10710: </dd>
1.292     leot     10711: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10712: <dd><p>This function checks for each of its parameters
1.110     hubertf  10713:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10714:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10715:        If any of the regular expressions matches, the test will
                   10716:        fail.</p></dd>
                   10717: </dl></div>
                   10718: </div>
                   10719: </div>
                   10720: </div>
1.148     asau     10721: <div class="chapter">
1.75      rillig   10722: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10723: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10724: <div class="toc">
                   10725: <p><b>Table of Contents</b></p>
1.299     rillig   10726: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   10727: </div>
                   10728: <p>The pkgsrc system has already been ported to many
                   10729:        operating systems, hardware architectures and compilers. This
                   10730:        chapter explains the necessary steps to make pkgsrc even more
                   10731:        portable.</p>
1.148     asau     10732: <div class="sect1">
1.75      rillig   10733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10734: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10735: <p>To port pkgsrc to a new operating system (called
                   10736:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10737:        following files:</p>
1.148     asau     10738: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10739: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10740: <dd><p>This file contains some basic definitions, for
                   10741:        example the name of the C
                   10742:        compiler.</p></dd>
1.76      rillig   10743: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10744: <dd><p>Insert code that defines the variables
                   10745:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327     wiz      10746:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75      rillig   10747:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10748:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10749:        appear in this file.</p></dd>
1.93      rillig   10750: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10751: <dd><p>This file contains the platform-specific
                   10752:        definitions that are used by pkgsrc. Start by copying one of the
                   10753:        other files and edit it to your
                   10754:        needs.</p></dd>
1.93      rillig   10755: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10756: <dd><p>This file defines the paths to all the tools
                   10757:        that are needed by one or the other package in pkgsrc, as well
                   10758:        as by pkgsrc itself. Find out where these tools are on your
                   10759:        platform and add them.</p></dd>
                   10760: </dl></div>
                   10761: <p>Now, you should be able to build some basic packages, like
1.322     leot     10762:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10763: </div>
                   10764: </div>
                   10765: </div>
1.148     asau     10766: <div class="appendix">
                   10767: <div class="titlepage"><div><div><h1 class="title">
                   10768: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10769: <div class="toc">
                   10770: <p><b>Table of Contents</b></p>
1.210     leot     10771: <dl class="toc">
1.75      rillig   10772: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10773: <dd><dl>
                   10774: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10775: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10776: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10777: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10778: </dl></dd>
                   10779: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10780: </dl>
                   10781: </div>
                   10782: <p>We checked to find a piece of software that wasn't in the packages
                   10783:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10784:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10785:     present in the tree is beyond us, but it's useful for the purposes of
                   10786:     this exercise.</p>
1.148     asau     10787: <div class="sect1">
1.75      rillig   10788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10789: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10790: <div class="sect2">
1.75      rillig   10791: <div class="titlepage"><div><div><h3 class="title">
                   10792: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10793: <pre class="programlisting">
1.100     rillig   10794: # $NetBSD$
                   10795: #
1.1       grant    10796: 
1.100     rillig   10797: DISTNAME=       bison-1.25
                   10798: CATEGORIES=     devel
1.286     rillig   10799: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10800: 
1.136     dholland 10801: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10802: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10803: COMMENT=        GNU yacc clone
1.1       grant    10804: 
1.100     rillig   10805: GNU_CONFIGURE=  yes
1.152     wiz      10806: INFO_FILES=     yes
1.1       grant    10807: 
1.100     rillig   10808: .include "../../mk/bsd.pkg.mk"
1.1       grant    10809: </pre>
1.75      rillig   10810: </div>
1.148     asau     10811: <div class="sect2">
1.75      rillig   10812: <div class="titlepage"><div><div><h3 class="title">
                   10813: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10814: <pre class="programlisting">
1.100     rillig   10815: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.322     leot     10816: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10817: of the NetBSD source tree is beyond me.
1.1       grant    10818: </pre>
1.75      rillig   10819: </div>
1.148     asau     10820: <div class="sect2">
1.75      rillig   10821: <div class="titlepage"><div><div><h3 class="title">
                   10822: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10823: <pre class="programlisting">
1.100     rillig   10824: @comment $NetBSD$
                   10825: bin/bison
                   10826: man/man1/bison.1.gz
                   10827: share/bison.simple
                   10828: share/bison.hairy
1.1       grant    10829: </pre>
1.75      rillig   10830: </div>
1.148     asau     10831: <div class="sect2">
1.75      rillig   10832: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10833: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10834: <p>The NetBSD package system comes with
1.322     leot     10835:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10836:        which helps to check the contents of these
                   10837:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10838:        directory of the package you wish to examine and run
1.110     hubertf  10839:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10840: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10841: ERROR: Makefile: Each package must define its LICENSE.
                   10842: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10843: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10844: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10845: 1 error, 2 warnings and 1 note found.
                   10846: (Run "pkglint -e" to show explanations.)
                   10847: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10848: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10849: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10850:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10851:        -Wall</strong></span> for a very thorough check.</p>
                   10852: </div>
                   10853: </div>
1.148     asau     10854: <div class="sect1">
1.75      rillig   10855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10856: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10857: <p>Create the directory where the package lives,
                   10858:       plus any auxiliary directories:</p>
                   10859: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10860: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10861: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10862: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10863: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   10864:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10865:       then continue with fetching the distfile:</p>
                   10866: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10867: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10868: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10869: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10870: ftp: Error retrieving file: 500 Internal error
                   10871: 
                   10872: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10873: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10874: ftp: Error retrieving file: 500 Internal error
                   10875: 
                   10876: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10877: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10878: Successfully retrieved file.</pre>
                   10879: <p>Generate the checksum of the distfile into
1.76      rillig   10880:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10881: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10882: <p>Now compile:</p>
                   10883: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10884: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10885: ===&gt;  Extracting for bison-1.25
                   10886: ===&gt;  Patching for bison-1.25
                   10887: ===&gt;   Ignoring empty patch directory
                   10888: ===&gt;  Configuring for bison-1.25
                   10889: creating cache ./config.cache
                   10890: checking for gcc... cc
                   10891: checking whether we are using GNU C... yes
                   10892: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10893: checking how to run the C preprocessor... cc -E
                   10894: checking for minix/config.h... no
                   10895: checking for POSIXized ISC... no
                   10896: checking whether cross-compiling... no
                   10897: checking for ANSI C header files... yes
                   10898: checking for string.h... yes
                   10899: checking for stdlib.h... yes
                   10900: checking for memory.h... yes
                   10901: checking for working const... yes
                   10902: checking for working alloca.h... no
                   10903: checking for alloca... yes
                   10904: checking for strerror... yes
                   10905: updating cache ./config.cache
                   10906: creating ./config.status
                   10907: creating Makefile
                   10908: ===&gt;  Building for bison-1.25
                   10909: 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
                   10910: 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
                   10911: 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
                   10912: 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
                   10913: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10914: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    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 getargs.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 gram.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 lalr.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 lex.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 main.c
                   10920: 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
                   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 output.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 print.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 reader.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 reduce.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 symtab.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 warshall.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 version.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 getopt.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 getopt1.c
                   10930: 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
                   10931: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10932: rm -f bison.s1
1.75      rillig   10933: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10934: <p>Everything seems OK, so install the files:</p>
                   10935: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10936: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10937: ===&gt;  Installing for bison-1.25
                   10938: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10939: rm -f /usr/pkg/bin/bison
                   10940: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10941: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10942: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10943: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10944: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10945: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10946: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10947: ===&gt;  Registering installation for bison-1.25</pre>
                   10948: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10949:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10950:       binary package, do this now:</p>
                   10951: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10952: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10953: ===&gt;  Building package for bison-1.25
                   10954: Creating package bison-1.25.tgz
                   10955: Registering depends:.
1.75      rillig   10956: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10957: <p>Now that you don't need the source and object files
                   10958:       any more, clean up:</p>
                   10959: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10960: ===&gt;  Cleaning for bison-1.25</pre>
                   10961: </div>
                   10962: </div>
1.148     asau     10963: <div class="appendix">
                   10964: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     10965: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75      rillig   10966: <div class="toc">
                   10967: <p><b>Table of Contents</b></p>
1.210     leot     10968: <dl class="toc">
1.322     leot     10969: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   10970: <dd><dl>
                   10971: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   10972: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   10973: </dl></dd>
                   10974: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   10975: <dd><dl>
                   10976: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   10977: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   10978: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   10979: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   10980: </dl></dd>
                   10981: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   10982: <dd><dl>
                   10983: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   10984: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   10985: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   10986: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   10987: </dl></dd>
1.75      rillig   10988: </dl>
                   10989: </div>
1.322     leot     10990: <p>
                   10991: A number of mechanisms are available in pkgsrc to improve the security of the
                   10992: resulting system. This page describes the mechanisms, and gives hints
                   10993: about detecting and fixing problems.
                   10994: </p>
                   10995: <p>
                   10996: Mechanisms can be enabled individually in
                   10997: <code class="filename">mk.conf</code>, and are
                   10998: individually described below.
                   10999: </p>
                   11000: <p>
                   11001: Typically, a feature will cause some programs to fail to build or work
                   11002: when first enabled. This can be due to latent problems in the
                   11003: program, and can be due to other reasons. After enough testing to
                   11004: have confidence that user problems will be quite rare, individual
                   11005: mechanisms will be enabled by default.
                   11006: </p>
                   11007: <p>
                   11008: For each mechanism, see the Caveats section below for an explanation
                   11009: of what might go wrong at compile time and at run time, and how to
                   11010: notice and address these problems.
                   11011: </p>
1.148     asau     11012: <div class="sect1">
1.75      rillig   11013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11014: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
                   11015: <div class="sect2">
                   11016: <div class="titlepage"><div><div><h3 class="title">
                   11017: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
                   11018: <div class="sect3">
                   11019: <div class="titlepage"><div><div><h4 class="title">
                   11020: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
                   11021: <p>
                   11022: This allows substitute wrappers to be used for some commonly used
                   11023: library functions that do not have built-in bounds checking - but
                   11024: could in some cases.
                   11025: </p>
                   11026: <p>
                   11027: Two mitigation levels are available:
                   11028: </p>
                   11029: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11030: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   11031: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   11032: </ul></div>
                   11033: <p>
                   11034: "strong" has been enabled by default since pkgsrc-2017Q3.
                   11035: </p>
                   11036: </div>
                   11037: <div class="sect3">
                   11038: <div class="titlepage"><div><div><h4 class="title">
                   11039: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
                   11040: <p>
                   11041: This enables a stack-smashing protection mitigation. It is done by adding a
                   11042: guard variable to functions with vulnerable objects. The guards are initialized
                   11043: when a function is entered and then checked when the function exits. The guard
                   11044: check will fail and the program forcibly exited if the variable was modified in
                   11045: the meantime. This can happen in case of buffer overflows or memory corruption,
                   11046: and therefore exposing these bugs.
                   11047: </p>
                   11048: <p>
                   11049: Different mitigation levels are available:
                   11050: </p>
                   11051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11052: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   11053: by the compiler;</p></li>
                   11054: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   11055: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   11056: two settings above.</p></li>
                   11057: </ul></div>
                   11058: <p>
                   11059: This mitigation is supported by both GCC and clang. It may be supported in
                   11060: additional compilers, possibly under a different name. It is particularly useful
                   11061: for unsafe programming languages, such as C/C++.
                   11062: </p>
                   11063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11064: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   11065: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   11066: </ul></div>
                   11067: <p>More details can be found here:</p>
                   11068: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11069: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11070: </p></li></ul></div>
                   11071: </div>
                   11072: <div class="sect3">
                   11073: <div class="titlepage"><div><div><h4 class="title">
                   11074: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
                   11075: <p>
                   11076: This requests the creation of PIE (Position Independent Executables) for all
                   11077: executables. The PIE mechanism is normally used for shared libraries, so that
                   11078: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11079: useful security properties; however, it is necessary to fully leverage some,
                   11080: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11081: (ASLR), which causes different addresses to be used each time a program is run.
                   11082: This makes it more difficult for an attacker to guess addresses and thus makes
                   11083: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11084: program, instead of the stack and heap only.
                   11085: </p>
                   11086: <p>
                   11087: PIE executables will only be built for toolchains that are known to support PIE.
                   11088: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11089: </p>
                   11090: <p>
                   11091: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11092: </p>
1.75      rillig   11093: </div>
1.325     gutterid 11094: <div class="sect3">
                   11095: <div class="titlepage"><div><div><h4 class="title">
1.334     nia      11096: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322     leot     11097: <p>
                   11098: This also makes the exploitation of some security vulnerabilities more
                   11099: difficult in some cases.
                   11100: </p>
                   11101: <p>Two different mitigation levels are available:</p>
                   11102: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11103: <li class="listitem"><p>
1.334     nia      11104: partial (the default): the ELF sections are reordered so that internal data sections
1.322     leot     11105: precede the program's own data sections, and non-PLT GOT is read-only;
                   11106: </p></li>
                   11107: <li class="listitem"><p>
                   11108: full: in addition to partial RELRO, every relocation is performed immediately
1.333     nia      11109: when starting the program, allowing the entire GOT to be read-only.  This
                   11110: can greatly slow down startup of large programs.
1.322     leot     11111: </p></li>
                   11112: </ul></div>
                   11113: <p>
                   11114: This is currently supported by GCC. Many software distributions now enable this
1.335     nia      11115: feature by default, at the "partial" level.
1.322     leot     11116: </p>
                   11117: <p>
                   11118: More details can be found here:
                   11119: </p>
                   11120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11121: <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>
                   11122: </p></li></ul></div>
1.75      rillig   11123: </div>
1.334     nia      11124: </div>
                   11125: <div class="sect2">
                   11126: <div class="titlepage"><div><div><h3 class="title">
                   11127: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
                   11128: <div class="sect3">
                   11129: <div class="titlepage"><div><div><h4 class="title">
                   11130: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
                   11131: <p>
                   11132: With this option, pkgsrc will try to build packages reproducibly. This allows
                   11133: packages built from the same tree and with the same options, to produce
                   11134: identical results bit by bit. This option should be combined with ASLR and
                   11135: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
                   11136: attackers attempting to exploit security vulnerabilities.
                   11137: </p>
                   11138: <p>
                   11139: More details can be found here:
                   11140: </p>
                   11141: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11142: <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>
                   11143: </p></li></ul></div>
                   11144: <p>
                   11145: More work likely needs to be done before pkgsrc is fully reproducible.
                   11146: </p>
                   11147: </div>
1.322     leot     11148: <div class="sect3">
                   11149: <div class="titlepage"><div><div><h4 class="title">
1.334     nia      11150: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322     leot     11151: <p>
                   11152: This uses <code class="literal">-fstack-check</code> with GCC for
                   11153: another stack protection mitigation.
                   11154: </p>
                   11155: <p>
                   11156: It asks the compiler to generate code verifying that it does not corrupt the
                   11157: stack. According to GCC's manual page, this is really only useful for
                   11158: multi-threaded programs.
                   11159: </p>
1.76      rillig   11160: </div>
                   11161: </div>
                   11162: </div>
1.148     asau     11163: <div class="sect1">
1.76      rillig   11164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11165: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
                   11166: <div class="sect2">
                   11167: <div class="titlepage"><div><div><h3 class="title">
                   11168: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
                   11169: <div class="sect3">
                   11170: <div class="titlepage"><div><div><h4 class="title">
                   11171: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
                   11172: <p>
                   11173: A number of packages may fail to build with this option enabled. The
                   11174: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11175: compilation flag when building libraries or executables (or ideally
                   11176: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11177: <code class="varname">CFLAGS</code> already, but requires the package to
                   11178: actually support it.
                   11179: </p>
                   11180: <div class="sect4">
                   11181: <div class="titlepage"><div><div><h5 class="title">
                   11182: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
                   11183: <p>
                   11184: These instructions are meant as a reference only; they likely need to be adapted
                   11185: for many packages individually.
                   11186: </p>
                   11187: <p>
                   11188: For packages using <code class="filename">Makefiles</code>:
                   11189: </p>
                   11190: <pre class="programlisting">
                   11191: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11192: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11193: </pre>
                   11194: <p>
                   11195: For packages using <code class="filename">Imakefiles</code>:
                   11196: </p>
                   11197: <pre class="programlisting">
                   11198: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11199: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11200: </pre>
                   11201: </div>
                   11202: </div>
                   11203: <div class="sect3">
                   11204: <div class="titlepage"><div><div><h4 class="title">
                   11205: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
                   11206: <p>
                   11207: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11208: scenarios are essentially possible. This is nearly always due to a bug in
                   11209: the program being exposed due to ASLR.
                   11210: </p>
                   11211: </div>
                   11212: <div class="sect3">
                   11213: <div class="titlepage"><div><div><h4 class="title">
                   11214: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
                   11215: <p>
                   11216: Ideally, packages should be fixed for compatibility with MKPIE.
                   11217: However, in some cases this is very difficult, due to complex build systems,
                   11218: packages using non-standard toolchains, or programming languages with odd
                   11219: bootstrapping mechanisms.
                   11220: </p>
                   11221: <p>
                   11222: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11223: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11224: <code class="filename">bsd.prefs.mk</code> is included.
                   11225: </p>
                   11226: </div>
                   11227: </div>
                   11228: <div class="sect2">
                   11229: <div class="titlepage"><div><div><h3 class="title">
                   11230: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
                   11231: <div class="sect3">
                   11232: <div class="titlepage"><div><div><h4 class="title">
                   11233: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
                   11234: <p>
                   11235: This feature makes use of pre-processing directives to look for hardened,
                   11236: alternative implementations of essential library calls. Some programs may fail
                   11237: to build as a result; this usually happens for those trying too hard to be
                   11238: portable, or otherwise abusing definitions in the standard library.
                   11239: </p>
                   11240: </div>
                   11241: <div class="sect3">
                   11242: <div class="titlepage"><div><div><h4 class="title">
                   11243: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
                   11244: <p>
                   11245: This feature may cause some programs to crash, usually indicating an
                   11246: actual bug in the program. The fix will typically involve patching the
                   11247: original program's source code.
                   11248: </p>
                   11249: </div>
                   11250: <div class="sect3">
                   11251: <div class="titlepage"><div><div><h4 class="title">
                   11252: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
                   11253: <p>
                   11254: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11255: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11256: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11257: optimization level. This cannot easily be applied globally, as some packages
                   11258: may require specific optimization levels.
                   11259: </p>
                   11260: </div>
                   11261: <div class="sect3">
                   11262: <div class="titlepage"><div><div><h4 class="title">
                   11263: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
                   11264: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11265: <h3 class="title">Note</h3>
                   11266: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11267: the program!  This is a very bad idea and will expose you to security
                   11268: vulnerabilities.
                   11269: </p>
                   11270: </div>
                   11271: <p>
                   11272: To disable FORTIFY on a per-package basis, set the following
                   11273: in the package's <code class="filename">Makefile</code>
                   11274: before <code class="filename">bsd.prefs.mk</code> is included:
                   11275: </p>
                   11276: <pre class="programlisting">
                   11277: FORTIFY_SUPPORTED=     no
                   11278: </pre>
                   11279: </div>
                   11280: </div>
                   11281: <div class="sect2">
                   11282: <div class="titlepage"><div><div><h3 class="title">
                   11283: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
                   11284: <div class="sect3">
                   11285: <div class="titlepage"><div><div><h4 class="title">
                   11286: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
                   11287: <p>
                   11288: For better protection, full RELRO requires every symbol to be resolved when the
                   11289: program starts, rather than simply when required at run-time. This will have
                   11290: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11291: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11292: background are affected only when started. Programs loading plug-ins at
                   11293: run-time are affected when loading the plug-ins.
                   11294: </p>
                   11295: <p>
                   11296: The impact is not expected to be noticeable on modern hardware, except in some
                   11297: cases for big programs.
                   11298: </p>
                   11299: </div>
                   11300: <div class="sect3">
                   11301: <div class="titlepage"><div><div><h4 class="title">
                   11302: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
                   11303: <p>
                   11304: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11305: RELRO: for instance, with an initialization routine listing any other plug-in
                   11306: required. With full RELRO, the missing symbols are resolved before the
                   11307: initialization routine can run, and the dynamic loader will not be able to find
                   11308: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11309: drivers. Partial RELRO can be applied instead in this case.
                   11310: </p>
                   11311: </div>
                   11312: <div class="sect3">
                   11313: <div class="titlepage"><div><div><h4 class="title">
                   11314: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
                   11315: <p>
                   11316: To disable RELRO on a per-package basis, set the following
                   11317: in the package's <code class="filename">Makefile</code>
                   11318: before <code class="filename">bsd.prefs.mk</code> is included:
                   11319: </p>
                   11320: <pre class="programlisting">
                   11321: RELRO_SUPPORTED=       no
                   11322: </pre>
1.324     nia      11323: <p>
                   11324: It is also possible to at most enable partial RELRO, by
                   11325: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11326: </p>
1.322     leot     11327: </div>
                   11328: </div>
                   11329: <div class="sect2">
                   11330: <div class="titlepage"><div><div><h3 class="title">
                   11331: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
                   11332: <div class="sect3">
                   11333: <div class="titlepage"><div><div><h4 class="title">
                   11334: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
                   11335: <p>
                   11336: The stack-smashing protection provided by this option does not work for some
                   11337: programs. The most common situation in which this happens is when the program
                   11338: allocates variables on the stack, with the size determined at run-time.
                   11339: </p>
                   11340: </div>
                   11341: <div class="sect3">
                   11342: <div class="titlepage"><div><div><h4 class="title">
                   11343: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
                   11344: <p>
                   11345: Again, this feature may cause some programs to crash via a
                   11346: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11347: </p>
                   11348: <p>
                   11349: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11350: messages are sent and - by default -
                   11351: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11352: </p>
                   11353: <pre class="programlisting">
                   11354: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11355: </pre>
                   11356: <p>
                   11357: (where <code class="literal">hostname</code> is the hostname(1) and
                   11358: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11359: </p>
                   11360: <p>
                   11361: Patching the original program is then required.
                   11362: </p>
                   11363: <p>
                   11364: Rebuilding the package via:
                   11365: </p>
                   11366: <pre class="programlisting">
                   11367: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11368: </pre>
                   11369: <p>
                   11370: and inspecting the backtrace of the coredump via the debugger
                   11371: should point out the problematic call by inspecting the frame
                   11372: calling the _chk() (SSP) function.
                   11373: </p>
                   11374: </div>
                   11375: <div class="sect3">
                   11376: <div class="titlepage"><div><div><h4 class="title">
                   11377: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
                   11378: <p>
                   11379: The compiler emits extra code when using this feature: a check for buffer
                   11380: overflows is performed when entering and exiting functions, requiring an extra
                   11381: variable on the stack. The level of protection can otherwise be adjusted to
                   11382: affect only those functions considered more sensitive by the compiler (with
                   11383: -fstack-protector instead of -fstack-protector-all).
                   11384: </p>
                   11385: <p>
                   11386: The impact is not expected to be noticeable on modern hardware. However,
                   11387: programs with a hard requirement to run at the fastest possible speed should
                   11388: avoid using this feature, or using libraries built with this feature.
                   11389: </p>
                   11390: </div>
                   11391: <div class="sect3">
                   11392: <div class="titlepage"><div><div><h4 class="title">
                   11393: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
                   11394: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11395: <h3 class="title">Note</h3>
                   11396: <p>SSP should not be disabled to work around runtime crashes in
                   11397: the program!  This is a very bad idea and will expose you to security
                   11398: vulnerabilities.</p>
                   11399: </div>
                   11400: <p>
                   11401: To disable SSP on a per-package basis, set the following
                   11402: in the package's <code class="filename">Makefile</code>
                   11403: before <code class="filename">bsd.prefs.mk</code> is included:
                   11404: </p>
                   11405: <pre class="programlisting">
                   11406: SSP_SUPPORTED= no
                   11407: </pre>
                   11408: </div>
                   11409: </div>
                   11410: </div>
                   11411: <div class="sect1">
                   11412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11413: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
                   11414: <p>
                   11415: The illusion of security is worse than having no security at all. This section
                   11416: lists a number of ways to ensure the security features requested are actually
                   11417: effective.
                   11418: </p>
                   11419: <p>
                   11420: These instructions were obtained and tested on a system derived from NetBSD 7
                   11421: (amd64). YMMV.
                   11422: </p>
                   11423: <div class="sect2">
                   11424: <div class="titlepage"><div><div><h3 class="title">
                   11425: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
                   11426: <p>
                   11427: The ELF executable type in use changes for binaries built as PIE; without:
                   11428: </p>
                   11429: <pre class="programlisting">
                   11430: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11431: /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
                   11432: </pre>
                   11433: <p>as opposed to the following binary, built as PIE:</p>
                   11434: <pre class="programlisting">
                   11435: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11436: /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
                   11437: </pre>
                   11438: <p>
                   11439: The latter result is then what is expected.
                   11440: </p>
                   11441: </div>
                   11442: <div class="sect2">
                   11443: <div class="titlepage"><div><div><h3 class="title">
                   11444: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
                   11445: <p>
                   11446: The following command should list a section called RELRO:
                   11447: </p>
                   11448: <pre class="programlisting">
                   11449: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11450: 
                   11451: /path/to/bin/ary:     file format elf64-x86-64
                   11452: 
                   11453: Program Header:
                   11454: [...]
                   11455:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11456: </pre>
                   11457: <p>
                   11458: This check is now performed automatically if
                   11459: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11460: </p>
                   11461: </div>
                   11462: <div class="sect2">
                   11463: <div class="titlepage"><div><div><h3 class="title">
                   11464: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
                   11465: <p>
                   11466: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11467: the <code class="varname">BIND_NOW</code> flag:
                   11468: </p>
                   11469: <pre class="programlisting">
                   11470: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11471: 
                   11472: /path/to/bin/ary:     file format elf64-x86-64
                   11473: 
                   11474: Dynamic Section:
                   11475: [...]
                   11476:   BIND_NOW             0x0000000000000000
                   11477: </pre>
                   11478: <p>
                   11479: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11480: </p>
                   11481: <p>
                   11482: This check is now performed automatically (where supported) if
                   11483: <code class="varname">PKG_DEVELOPER</code> is set.
                   11484: </p>
                   11485: </div>
                   11486: <div class="sect2">
                   11487: <div class="titlepage"><div><div><h3 class="title">
                   11488: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323     nia      11489: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11490: <h3 class="title">Note</h3>
                   11491: <p>
                   11492: Checking for SSP using this method only works where the operating system
                   11493: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11494: on recent NetBSD/FreeBSD/Linux versions.
                   11495: </p>
                   11496: </div>
1.322     leot     11497: <p>
                   11498: Building objects, binaries and libraries with SSP will affect the presence of
                   11499: additional symbols in the resulting file:
                   11500: </p>
                   11501: <pre class="programlisting">
                   11502: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11503: [...]
                   11504:                  U __stack_chk_fail
                   11505: 0000000000600ea0 B __stack_chk_guard
                   11506: </pre>
                   11507: <p>
                   11508: This is an indicator that the program was indeed built with support for SSP.
                   11509: </p>
                   11510: <p>
                   11511: This check is now performed automatically (where supported) if
                   11512: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11513: </p>
                   11514: </div>
                   11515: </div>
                   11516: </div>
                   11517: <div class="appendix">
                   11518: <div class="titlepage"><div><div><h1 class="title">
                   11519: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
                   11520: <div class="toc">
                   11521: <p><b>Table of Contents</b></p>
                   11522: <dl class="toc">
                   11523: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11524: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11525: </dl>
                   11526: </div>
                   11527: <div class="sect1">
                   11528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11529: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
                   11530: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11531: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11532: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11533: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11534: =&gt; [172219 bytes]
                   11535: Connected to ftp.plig.net.
                   11536: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11537: 331 Guest login ok, send your complete e-mail address as password.
                   11538: 230-You are user #5 of 500 simultaneous users allowed.
                   11539: 230-
                   11540: 230-  ___ _             _ _
                   11541: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11542: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11543: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11544: 230-         |_|   |_|     |___|         |___|
                   11545: 230-
                   11546: 230-** Welcome to ftp.plig.org **
                   11547: 230-
                   11548: 230-Please note that all transfers from this FTP site are logged. If you
                   11549: 230-do not like this, please disconnect now.
                   11550: 230-
                   11551: 230-This archive is available via
                   11552: 230-
                   11553: 230-HTTP:  http://ftp.plig.org/
                   11554: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11555: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11556: 230-
                   11557: 230-Please email comments, bug reports and requests for packages to be
                   11558: 230-mirrored to ftp-admin@plig.org.
                   11559: 230-
                   11560: 230-
                   11561: 230 Logged in anonymously.
                   11562: Remote system type is UNIX.
                   11563: Using binary mode to transfer files.
                   11564: 200 Type okay.
                   11565: 250 "/pub" is new cwd.
                   11566: 250-"/pub/figlet" is new cwd.
                   11567: 250-
                   11568: 250-Welcome to the figlet archive at ftp.figlet.org
                   11569: 250-
                   11570: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11571: 250-
                   11572: 250-The official FIGlet web page is:
                   11573: 250-   http://www.figlet.org/
                   11574: 250-
                   11575: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11576: 250-contribute a font or something else, you can email us.
                   11577: 250
                   11578: 250 "/pub/figlet/program" is new cwd.
                   11579: 250 "/pub/figlet/program/unix" is new cwd.
                   11580: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11581: 502 Unimplemented command.
                   11582: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11583: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11584: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11585: 226 Transfer completed.
                   11586: 172219 bytes received in 00:02 (75.99 KB/s)
                   11587: 221 Goodbye.
                   11588: =&gt; Checksum OK for figlet221.tar.gz.
                   11589: ===&gt; Extracting for figlet-2.2.1nb2
                   11590: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11591: ===&gt; Patching for figlet-2.2.1nb2
                   11592: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11593: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11594: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11595: ===&gt; Configuring for figlet-2.2.1nb2
                   11596: ===&gt; Building for figlet-2.2.1nb2
                   11597: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11598: chmod a+x figlet
                   11599: gcc -O2 -o chkfont chkfont.c
                   11600: =&gt; Unwrapping files-to-be-installed.
                   11601: <code class="prompt">#</code>
                   11602: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11603: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11604: ===&gt; Installing for figlet-2.2.1nb2
                   11605: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11606: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11607: mkdir -p /usr/pkg/share/figlet
                   11608: cp figlet /usr/pkg/bin
                   11609: cp chkfont /usr/pkg/bin
                   11610: chmod 555 figlist showfigfonts
                   11611: cp figlist /usr/pkg/bin
                   11612: cp showfigfonts /usr/pkg/bin
                   11613: cp fonts/*.flf /usr/pkg/share/figlet
                   11614: cp fonts/*.flc /usr/pkg/share/figlet
                   11615: cp figlet.6 /usr/pkg/man/man6
                   11616: ===&gt; Registering installation for figlet-2.2.1nb2
                   11617: <code class="prompt">#</code></pre>
                   11618: </div>
                   11619: <div class="sect1">
                   11620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11621: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
                   11622: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11623: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11624: ===&gt; Packaging figlet-2.2.1nb2
                   11625: ===&gt; Building binary package for figlet-2.2.1nb2
                   11626: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11627: Using SrcDir value of /usr/pkg
                   11628: Registering depends:.
                   11629: <code class="prompt">#</code></pre>
                   11630: </div>
                   11631: </div>
                   11632: <div class="appendix">
                   11633: <div class="titlepage"><div><div><h1 class="title">
                   11634: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
                   11635: <div class="toc">
                   11636: <p><b>Table of Contents</b></p>
                   11637: <dl class="toc">
                   11638: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11639: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11640: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11641: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11642: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   11643: <code class="filename">stable</code>,
                   11644: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   11645: source packages</a></span></dt>
                   11646: </dl>
                   11647: </div>
                   11648: <p>As in other big projects, the directory layout of pkgsrc
                   11649:        is quite complex for newbies. This chapter explains where you
                   11650:        find things on the FTP server. The base directory on
                   11651:        <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>.
                   11652:        On other servers it may be different, but inside this directory,
                   11653:        everything should look the same, no matter on which server you
                   11654:        are. This directory contains some subdirectories, which are
                   11655:        explained below.</p>
                   11656: <div class="sect1">
                   11657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11658: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11659: <p>The directory <code class="filename">distfiles</code> contains lots
                   11660:        of archive files from all pkgsrc packages, which are mirrored
                   11661:        here. The subdirectories are called after their package names
                   11662:        and are used when the distributed files have names that don't
                   11663:        explicitly contain a version number or are otherwise too generic
                   11664:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11665: </div>
                   11666: <div class="sect1">
                   11667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11668: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11669: <p>This directory contains things that individual pkgsrc
                   11670:        developers find worth publishing.</p>
                   11671: </div>
                   11672: <div class="sect1">
                   11673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11674: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11675: <p>This directory contains binary packages for the various
                   11676:        platforms that are supported by pkgsrc.
                   11677:        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>
                   11678: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11679: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   11680:        operating system for which the packages have been built. The
                   11681:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   11682:        command, so it may differ from the one you are used to
                   11683:        hear.</p></li>
                   11684: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   11685:        architecture of the platform for which the packages have been
                   11686:        built. It also includes the <code class="varname">ABI</code> (Application
                   11687:        Binary Interface) for platforms that have several of
                   11688:        them.</p></li>
                   11689: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
                   11690:        the operating system. For version numbers that change often (for
                   11691:        example NetBSD-current), the often-changing part should be
                   11692:        replaced with an <code class="literal">x</code>, for example
                   11693:        <code class="literal">4.99.x</code>.</p></li>
                   11694: <li class="listitem"><p><code class="varname">TAG</code> is either
                   11695:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11696:        for a stable branch, or <code class="literal">head</code> for packages
                   11697:        built from the HEAD branch. The latter should only be used when
                   11698:        the packages are updated on a regular basis. Otherwise the date
                   11699:        from checking out pkgsrc should be appended, for example
                   11700:        <code class="literal">head_20071015</code>.</p></li>
                   11701: </ul></div>
                   11702: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11703:        can quickly click through the directories on the
                   11704:        server and find the best binary packages for their machines. Since they
                   11705:        usually know the operating system and the hardware architecture, OPSYS
                   11706:        and ARCH are placed first. After these choices, they can select the
                   11707:        best combination of OSVERSION and TAG together, since it is usually the
                   11708:        case that packages stay compatible between different version of the
                   11709:        operating system.</p>
                   11710: <p>In each of these directories, there is a
                   11711:        whole binary packages collection for a specific platform. It has a directory called
                   11712:        <code class="filename">All</code> which contains all binary packages.
                   11713:        Besides that, there are various category directories that
                   11714:        contain symbolic links to the real binary packages.</p>
                   11715: </div>
                   11716: <div class="sect1">
                   11717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11718: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11719: <p>Here are the reports from bulk builds, for those who want
                   11720:        to fix packages that didn't build on some of the platforms. The
1.322     leot     11721:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   11722: </div>
1.148     asau     11723: <div class="sect1">
1.108     rillig   11724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     11725: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261     leot     11726: <code class="filename">stable</code>,
1.126     jakllsch 11727: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11728: source packages</h2></div></div></div>
1.128     wiz      11729: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11730:        that is the files that define how to create binary packages from
                   11731:        source archives.</p>
1.262     leot     11732: <p>Each of the <code class="filename">current</code>,
                   11733:        <code class="filename">stable</code> and
                   11734:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11735:        directories share the same structure.  They each contain a
                   11736:        <code class="filename">pkgsrc</code> directory and
                   11737:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   11738: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11739:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     11740:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11741:        as the directory, ready to be downloaded as a whole.</p>
                   11742: <p>The <code class="filename">current</code> directory contains files
                   11743:        related to the HEAD branch of the CVS repository.
                   11744:        In this directory there is an additional file called
                   11745:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11746:        all pkgsrc <code class="filename">README</code>s with information about
                   11747:        categories and packages.
                   11748:        </p>
                   11749: <p>The <code class="filename">stable</code> directory is a symlink to
                   11750:        the latest 
                   11751:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11752:        </p>
                   11753: <p>The
                   11754:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11755:        directories contain files related to the 
                   11756:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11757:        stable branch of the CVS repository. In these directories there is
                   11758:        an additional file called
                   11759:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76      rillig   11760:        which contains the state of pkgsrc when it was branched.</p>
                   11761: </div>
1.75      rillig   11762: </div>
1.148     asau     11763: <div class="appendix">
                   11764: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     11765: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267     rillig   11766: <p>
                   11767:        The following list contains all help topics that are available
                   11768:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11769: </p>
1.269     leot     11770: <table border="0" summary="Simple list" class="simplelist">
                   11771: <tr>
                   11772: <td>#!</td>
                   11773: <td>-lintl</td>
                   11774: </tr>
                   11775: <tr>
1.320     wiz      11776: <td>32bit</td>
1.269     leot     11777: <td>64bit</td>
1.320     wiz      11778: </tr>
                   11779: <tr>
1.269     leot     11780: <td>ABI</td>
1.320     wiz      11781: <td>ACCEPTABLE_LICENSES</td>
1.269     leot     11782: </tr>
                   11783: <tr>
                   11784: <td>ACROREAD_FONTPATH</td>
1.320     wiz      11785: <td>ADDITIONAL</td>
1.269     leot     11786: </tr>
                   11787: <tr>
                   11788: <td>AFAIK</td>
1.320     wiz      11789: <td>AIX</td>
1.269     leot     11790: </tr>
                   11791: <tr>
                   11792: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320     wiz      11793: <td>ALL_ENV</td>
1.269     leot     11794: </tr>
                   11795: <tr>
1.338   ! nia      11796: <td>ALSA_PC</td>
1.315     cirnatda 11797: <td>ALTERNATIVES_SRC</td>
1.338   ! nia      11798: </tr>
        !          11799: <tr>
1.337     gutterid 11800: <td>AMANDA_TMP</td>
1.338   ! nia      11801: <td>AMANDA_USER</td>
1.332     rillig   11802: </tr>
                   11803: <tr>
1.337     gutterid 11804: <td>AMANDA_VAR</td>
1.338   ! nia      11805: <td>APACHE_GROUP</td>
1.329     leot     11806: </tr>
                   11807: <tr>
1.337     gutterid 11808: <td>APACHE_MODULE_NAME</td>
1.338   ! nia      11809: <td>APACHE_MODULE_SRC</td>
1.327     wiz      11810: </tr>
                   11811: <tr>
1.337     gutterid 11812: <td>APACHE_MODULE_SRCDIR</td>
1.338   ! nia      11813: <td>APACHE_PKG_PREFIX</td>
1.311     leot     11814: </tr>
                   11815: <tr>
1.337     gutterid 11816: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.338   ! nia      11817: <td>APACHE_SUEXEC_DOCROOT</td>
1.292     leot     11818: </tr>
                   11819: <tr>
1.337     gutterid 11820: <td>APACHE_USER</td>
1.338   ! nia      11821: <td>APPEND_ABI</td>
1.274     rillig   11822: </tr>
                   11823: <tr>
1.337     gutterid 11824: <td>APPEND_ELF</td>
1.338   ! nia      11825: <td>ARLA_CACHE</td>
1.269     leot     11826: </tr>
                   11827: <tr>
1.337     gutterid 11828: <td>AUDIT_PACKAGES_FLAGS</td>
1.338   ! nia      11829: <td>AUTOCONF_REQD</td>
1.269     leot     11830: </tr>
                   11831: <tr>
1.337     gutterid 11832: <td>AUTOMAKE_OVERRIDE</td>
1.338   ! nia      11833: <td>AUTOMAKE_REQD</td>
1.269     leot     11834: </tr>
                   11835: <tr>
1.337     gutterid 11836: <td>AUTO_MKDIRS</td>
1.338   ! nia      11837: <td>BDB185_DEFAULT</td>
1.269     leot     11838: </tr>
                   11839: <tr>
1.337     gutterid 11840: <td>BDBBASE</td>
1.338   ! nia      11841: <td>BDB_ACCEPTED</td>
1.269     leot     11842: </tr>
                   11843: <tr>
1.337     gutterid 11844: <td>BDB_DEFAULT</td>
1.338   ! nia      11845: <td>BDB_LIBS</td>
1.269     leot     11846: </tr>
                   11847: <tr>
1.337     gutterid 11848: <td>BDB_TYPE</td>
1.338   ! nia      11849: <td>BINCIMAP_GROUP</td>
1.269     leot     11850: </tr>
                   11851: <tr>
1.337     gutterid 11852: <td>BINCIMAP_USER</td>
1.338   ! nia      11853: <td>BIND_DIR</td>
1.269     leot     11854: </tr>
                   11855: <tr>
1.337     gutterid 11856: <td>BIND_GROUP</td>
1.338   ! nia      11857: <td>BIND_USER</td>
1.269     leot     11858: </tr>
                   11859: <tr>
1.337     gutterid 11860: <td>BINOWN</td>
1.338   ! nia      11861: <td>BINPKG_SITES</td>
1.269     leot     11862: </tr>
                   11863: <tr>
1.337     gutterid 11864: <td>BIN_INSTALL_FLAGS</td>
1.338   ! nia      11865: <td>BISON_PKGDATADIR</td>
1.269     leot     11866: </tr>
                   11867: <tr>
1.337     gutterid 11868: <td>BLAS</td>
1.338   ! nia      11869: <td>BLAS_ACCEPTED</td>
1.312     gdt      11870: </tr>
                   11871: <tr>
1.337     gutterid 11872: <td>BLAS_C_INTERFACE</td>
1.338   ! nia      11873: <td>BLAS_INCLUDES</td>
1.269     leot     11874: </tr>
                   11875: <tr>
1.337     gutterid 11876: <td>BLAS_INDEX64</td>
1.338   ! nia      11877: <td>BLAS_LIBS</td>
1.269     leot     11878: </tr>
                   11879: <tr>
1.337     gutterid 11880: <td>BLAS_TYPE</td>
1.338   ! nia      11881: <td>BOOTSTRAP_DEPENDS</td>
1.303     bacon    11882: </tr>
                   11883: <tr>
1.337     gutterid 11884: <td>BROKEN</td>
1.338   ! nia      11885: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.320     wiz      11886: </tr>
                   11887: <tr>
1.337     gutterid 11888: <td>BROKEN_ON_PLATFORM</td>
1.338   ! nia      11889: <td>BSDSRCDIR</td>
1.269     leot     11890: </tr>
                   11891: <tr>
1.337     gutterid 11892: <td>BSDXSRCDIR</td>
1.338   ! nia      11893: <td>BSD_MAKE_ENV</td>
1.292     leot     11894: </tr>
                   11895: <tr>
1.337     gutterid 11896: <td>BUILDLINK_AUTO_DIRS</td>
1.338   ! nia      11897: <td>BUILDLINK_AUTO_VARS</td>
1.269     leot     11898: </tr>
                   11899: <tr>
1.337     gutterid 11900: <td>BUILDLINK_CFLAGS</td>
1.338   ! nia      11901: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269     leot     11902: </tr>
                   11903: <tr>
1.329     leot     11904: <td>BUILDLINK_CPPFLAGS</td>
1.338   ! nia      11905: <td>BUILDLINK_DEPMETHOD</td>
1.269     leot     11906: </tr>
                   11907: <tr>
                   11908: <td>BUILDLINK_FILES</td>
1.331     gutterid 11909: <td>BUILDLINK_FILES_CMD</td>
1.320     wiz      11910: </tr>
                   11911: <tr>
                   11912: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.331     gutterid 11913: <td>BUILDLINK_LDFLAGS</td>
1.269     leot     11914: </tr>
                   11915: <tr>
1.320     wiz      11916: <td>BUILDLINK_LIBS</td>
1.331     gutterid 11917: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269     leot     11918: </tr>
                   11919: <tr>
1.320     wiz      11920: <td>BUILDLINK_PKGNAME</td>
1.331     gutterid 11921: <td>BUILDLINK_PREFIX</td>
1.269     leot     11922: </tr>
                   11923: <tr>
1.320     wiz      11924: <td>BUILDLINK_RPATHDIRS</td>
1.331     gutterid 11925: <td>BUILDLINK_TREE</td>
1.269     leot     11926: </tr>
                   11927: <tr>
1.320     wiz      11928: <td>BUILD_DEFS</td>
1.331     gutterid 11929: <td>BUILD_DEFS_EFFECTS</td>
1.269     leot     11930: </tr>
                   11931: <tr>
1.320     wiz      11932: <td>BUILD_DEPENDS</td>
1.331     gutterid 11933: <td>BUILD_DIRS</td>
1.269     leot     11934: </tr>
                   11935: <tr>
1.320     wiz      11936: <td>BUILD_ENV_SHELL</td>
1.331     gutterid 11937: <td>BUILD_MAKE_CMD</td>
1.269     leot     11938: </tr>
                   11939: <tr>
1.320     wiz      11940: <td>BUILD_MAKE_FLAGS</td>
1.331     gutterid 11941: <td>BUILD_TARGET</td>
1.269     leot     11942: </tr>
                   11943: <tr>
1.320     wiz      11944: <td>BUILTIN_FIND_FILES</td>
1.331     gutterid 11945: <td>BUILTIN_FIND_FILES_VAR</td>
1.269     leot     11946: </tr>
                   11947: <tr>
1.320     wiz      11948: <td>BUILTIN_FIND_GREP</td>
1.331     gutterid 11949: <td>BUILTIN_FIND_HEADERS</td>
1.269     leot     11950: </tr>
                   11951: <tr>
1.320     wiz      11952: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.331     gutterid 11953: <td>BUILTIN_FIND_PKGCONFIG</td>
1.269     leot     11954: </tr>
                   11955: <tr>
1.320     wiz      11956: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.331     gutterid 11957: <td>BUILTIN_PKG</td>
1.309     gutterid 11958: </tr>
                   11959: <tr>
1.320     wiz      11960: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.331     gutterid 11961: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269     leot     11962: </tr>
                   11963: <tr>
1.320     wiz      11964: <td>BUILTIN_VERSION_SCRIPT</td>
1.331     gutterid 11965: <td>BUILTIN_X11_TYPE</td>
1.269     leot     11966: </tr>
                   11967: <tr>
1.320     wiz      11968: <td>BUILTIN_X11_VERSION</td>
1.331     gutterid 11969: <td>CACTI_GROUP</td>
1.269     leot     11970: </tr>
                   11971: <tr>
1.320     wiz      11972: <td>CACTI_USER</td>
1.331     gutterid 11973: <td>CANNA_GROUP</td>
1.269     leot     11974: </tr>
                   11975: <tr>
1.320     wiz      11976: <td>CANNA_USER</td>
1.331     gutterid 11977: <td>CAT</td>
1.269     leot     11978: </tr>
                   11979: <tr>
1.320     wiz      11980: <td>CBLAS_LIBS</td>
1.331     gutterid 11981: <td>CCACHE_BASE</td>
1.269     leot     11982: </tr>
                   11983: <tr>
1.303     bacon    11984: <td>CCACHE_DIR</td>
1.331     gutterid 11985: <td>CCACHE_LOGFILE</td>
1.269     leot     11986: </tr>
                   11987: <tr>
1.303     bacon    11988: <td>CC_VERSION</td>
1.331     gutterid 11989: <td>CC_VERSION_STRING</td>
1.269     leot     11990: </tr>
                   11991: <tr>
1.303     bacon    11992: <td>CDRECORD_CONF</td>
1.331     gutterid 11993: <td>CDROM_PKG_URL_DIR</td>
1.269     leot     11994: </tr>
                   11995: <tr>
1.303     bacon    11996: <td>CDROM_PKG_URL_HOST</td>
1.338   ! nia      11997: <td>CHECKOUT_DATE</td>
        !          11998: </tr>
        !          11999: <tr>
1.337     gutterid 12000: <td>CHECK_COMPILER</td>
1.338   ! nia      12001: <td>CHECK_FAKEHOME</td>
1.332     rillig   12002: </tr>
                   12003: <tr>
1.337     gutterid 12004: <td>CHECK_FILES</td>
1.338   ! nia      12005: <td>CHECK_FILES_SKIP</td>
1.329     leot     12006: </tr>
                   12007: <tr>
1.337     gutterid 12008: <td>CHECK_FILES_STRICT</td>
1.338   ! nia      12009: <td>CHECK_HEADERS</td>
1.327     wiz      12010: </tr>
                   12011: <tr>
1.337     gutterid 12012: <td>CHECK_HEADERS_SKIP</td>
1.338   ! nia      12013: <td>CHECK_INTERPRETER</td>
1.320     wiz      12014: </tr>
                   12015: <tr>
1.337     gutterid 12016: <td>CHECK_INTERPRETER_SKIP</td>
1.338   ! nia      12017: <td>CHECK_PERMS</td>
1.311     leot     12018: </tr>
                   12019: <tr>
1.337     gutterid 12020: <td>CHECK_PERMS_AUTOFIX</td>
1.338   ! nia      12021: <td>CHECK_PERMS_SKIP</td>
1.292     leot     12022: </tr>
                   12023: <tr>
1.337     gutterid 12024: <td>CHECK_PIE</td>
1.338   ! nia      12025: <td>CHECK_PIE_SKIP</td>
1.274     rillig   12026: </tr>
                   12027: <tr>
1.337     gutterid 12028: <td>CHECK_PIE_SUPPORTED</td>
1.338   ! nia      12029: <td>CHECK_PORTABILITY</td>
1.331     gutterid 12030: </tr>
                   12031: <tr>
1.337     gutterid 12032: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.338   ! nia      12033: <td>CHECK_PORTABILITY_SKIP</td>
1.269     leot     12034: </tr>
                   12035: <tr>
1.337     gutterid 12036: <td>CHECK_RELRO</td>
1.338   ! nia      12037: <td>CHECK_RELRO_SKIP</td>
1.269     leot     12038: </tr>
                   12039: <tr>
1.337     gutterid 12040: <td>CHECK_RELRO_SUPPORTED</td>
1.338   ! nia      12041: <td>CHECK_SHLIBS</td>
1.269     leot     12042: </tr>
                   12043: <tr>
1.337     gutterid 12044: <td>CHECK_SHLIBS_SKIP</td>
1.338   ! nia      12045: <td>CHECK_SHLIBS_SUPPORTED</td>
1.269     leot     12046: </tr>
                   12047: <tr>
1.337     gutterid 12048: <td>CHECK_SHLIBS_TOXIC</td>
1.338   ! nia      12049: <td>CHECK_SSP</td>
1.269     leot     12050: </tr>
                   12051: <tr>
1.337     gutterid 12052: <td>CHECK_SSP_SKIP</td>
1.338   ! nia      12053: <td>CHECK_SSP_SUPPORTED</td>
1.269     leot     12054: </tr>
                   12055: <tr>
1.337     gutterid 12056: <td>CHECK_STRIPPED</td>
1.338   ! nia      12057: <td>CHECK_STRIPPED_SKIP</td>
1.269     leot     12058: </tr>
                   12059: <tr>
1.337     gutterid 12060: <td>CHECK_WRKREF</td>
1.338   ! nia      12061: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269     leot     12062: </tr>
                   12063: <tr>
1.337     gutterid 12064: <td>CHECK_WRKREF_SKIP</td>
1.338   ! nia      12065: <td>CLAMAV_DBDIR</td>
1.269     leot     12066: </tr>
                   12067: <tr>
1.337     gutterid 12068: <td>CLAMAV_GROUP</td>
1.338   ! nia      12069: <td>CLAMAV_USER</td>
1.269     leot     12070: </tr>
                   12071: <tr>
1.337     gutterid 12072: <td>CLANGBASE</td>
1.338   ! nia      12073: <td>CLEANDEPENDS</td>
1.269     leot     12074: </tr>
                   12075: <tr>
1.337     gutterid 12076: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.338   ! nia      12077: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269     leot     12078: </tr>
                   12079: <tr>
1.337     gutterid 12080: <td>CMAKE_INSTALL_PREFIX</td>
1.338   ! nia      12081: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269     leot     12082: </tr>
                   12083: <tr>
1.337     gutterid 12084: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.338   ! nia      12085: <td>CMAKE_PREFIX_PATH</td>
1.269     leot     12086: </tr>
                   12087: <tr>
1.305     bacon    12088: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.338   ! nia      12089: <td>COMMON_LISP_DOCFILES</td>
        !          12090: </tr>
        !          12091: <tr>
        !          12092: <td>COMMON_LISP_EXAMPLES</td>
        !          12093: <td>COMMON_LISP_EXTRAFILES</td>
        !          12094: </tr>
        !          12095: <tr>
        !          12096: <td>COMMON_LISP_PACKAGES</td>
        !          12097: <td>COMMON_LISP_SYSTEM</td>
1.292     leot     12098: </tr>
                   12099: <tr>
1.305     bacon    12100: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     12101: <td>COMPILER_USE_SYMLINKS</td>
                   12102: </tr>
                   12103: <tr>
1.305     bacon    12104: <td>CONFIGURE_ARGS</td>
1.269     leot     12105: <td>CONFIGURE_DIRS</td>
                   12106: </tr>
                   12107: <tr>
1.305     bacon    12108: <td>CONFIGURE_ENV</td>
1.287     rillig   12109: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     12110: </tr>
                   12111: <tr>
1.305     bacon    12112: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     12113: <td>CONFIGURE_HAS_MANDIR</td>
                   12114: </tr>
                   12115: <tr>
1.305     bacon    12116: <td>CONFIGURE_SCRIPT</td>
1.269     leot     12117: <td>CONFIG_SHELL</td>
                   12118: </tr>
                   12119: <tr>
1.305     bacon    12120: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     12121: <td>CONF_FILES</td>
                   12122: </tr>
                   12123: <tr>
1.305     bacon    12124: <td>CONF_FILES_MODE</td>
1.269     leot     12125: <td>CONF_FILES_PERMS</td>
                   12126: </tr>
                   12127: <tr>
1.305     bacon    12128: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     12129: <td>CONSERVER_DEFAULTPORT</td>
                   12130: </tr>
                   12131: <tr>
1.305     bacon    12132: <td>CP</td>
1.269     leot     12133: <td>CPP</td>
                   12134: </tr>
                   12135: <tr>
1.305     bacon    12136: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     12137: <td>CREATE_WRKDIR_SYMLINK</td>
                   12138: </tr>
                   12139: <tr>
1.305     bacon    12140: <td>CROSSBASE</td>
1.269     leot     12141: <td>CTFCONVERT</td>
                   12142: </tr>
                   12143: <tr>
1.305     bacon    12144: <td>CTF_FILES_SKIP</td>
1.269     leot     12145: <td>CTF_SUPPORTED</td>
                   12146: </tr>
                   12147: <tr>
1.305     bacon    12148: <td>CTYPE</td>
1.269     leot     12149: <td>CUPS_GROUP</td>
                   12150: </tr>
                   12151: <tr>
1.305     bacon    12152: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     12153: <td>CUPS_USER</td>
                   12154: </tr>
                   12155: <tr>
1.305     bacon    12156: <td>CURSES_DEFAULT</td>
1.269     leot     12157: <td>CURSES_TYPE</td>
1.292     leot     12158: </tr>
                   12159: <tr>
1.338   ! nia      12160: <td>CVS_EXTRACTDIR</td>
        !          12161: <td>CVS_MODULE</td>
        !          12162: </tr>
        !          12163: <tr>
        !          12164: <td>CVS_PROJECT</td>
        !          12165: <td>CVS_REPOSITORIES</td>
        !          12166: </tr>
        !          12167: <tr>
        !          12168: <td>CVS_ROOT</td>
        !          12169: <td>CVS_ROOT_GNU</td>
        !          12170: </tr>
        !          12171: <tr>
        !          12172: <td>CVS_ROOT_NONGNU</td>
        !          12173: <td>CVS_ROOT_SOURCEFORGE</td>
        !          12174: </tr>
        !          12175: <tr>
        !          12176: <td>CVS_TAG</td>
1.273     brook    12177: <td>CXX</td>
1.332     rillig   12178: </tr>
                   12179: <tr>
1.338   ! nia      12180: <td>CYRUS_GROUP</td>
1.332     rillig   12181: <td>CYRUS_IDLE</td>
1.329     leot     12182: </tr>
                   12183: <tr>
1.338   ! nia      12184: <td>CYRUS_USER</td>
1.332     rillig   12185: <td>DAEMONTOOLS_GROUP</td>
1.327     wiz      12186: </tr>
                   12187: <tr>
1.338   ! nia      12188: <td>DAEMONTOOLS_LOG_USER</td>
1.332     rillig   12189: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.320     wiz      12190: </tr>
                   12191: <tr>
1.338   ! nia      12192: <td>DARWIN_REQUIRES_FILTER</td>
1.332     rillig   12193: <td>DBUS_GROUP</td>
1.311     leot     12194: </tr>
                   12195: <tr>
1.338   ! nia      12196: <td>DBUS_USER</td>
1.332     rillig   12197: <td>DEFANG_GROUP</td>
1.269     leot     12198: </tr>
                   12199: <tr>
1.338   ! nia      12200: <td>DEFANG_USER</td>
1.332     rillig   12201: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269     leot     12202: </tr>
                   12203: <tr>
1.338   ! nia      12204: <td>DEFAULT_DISTFILES</td>
1.332     rillig   12205: <td>DEFAULT_IRC_SERVER</td>
1.269     leot     12206: </tr>
                   12207: <tr>
1.338   ! nia      12208: <td>DEFAULT_SERIAL_DEVICE</td>
1.332     rillig   12209: <td>DEF_UMASK</td>
1.309     gutterid 12210: </tr>
                   12211: <tr>
1.338   ! nia      12212: <td>DEINSTALLDEPENDS</td>
1.332     rillig   12213: <td>DEINSTALL_SRC</td>
1.269     leot     12214: </tr>
                   12215: <tr>
1.338   ! nia      12216: <td>DEINSTALL_TEMPLATES</td>
1.332     rillig   12217: <td>DELAYED_ERROR_MSG</td>
1.269     leot     12218: </tr>
                   12219: <tr>
1.338   ! nia      12220: <td>DELAYED_WARNING_MSG</td>
1.332     rillig   12221: <td>DEPENDS</td>
1.269     leot     12222: </tr>
                   12223: <tr>
1.338   ! nia      12224: <td>DEPENDS_TARGET</td>
1.332     rillig   12225: <td>DEPENDS_TYPE</td>
1.269     leot     12226: </tr>
                   12227: <tr>
1.338   ! nia      12228: <td>DESTDIR</td>
1.332     rillig   12229: <td>DESTDIR_VARNAME</td>
1.269     leot     12230: </tr>
                   12231: <tr>
1.338   ! nia      12232: <td>DIALER_GROUP</td>
1.332     rillig   12233: <td>DIGEST_REQD</td>
1.269     leot     12234: </tr>
                   12235: <tr>
1.338   ! nia      12236: <td>DISTDIR</td>
1.332     rillig   12237: <td>DISTFILES</td>
1.269     leot     12238: </tr>
                   12239: <tr>
1.338   ! nia      12240: <td>DISTINFO_FILE</td>
1.332     rillig   12241: <td>DISTNAME</td>
1.269     leot     12242: </tr>
                   12243: <tr>
1.338   ! nia      12244: <td>DIST_PATH</td>
1.332     rillig   12245: <td>DIST_SUBDIR</td>
1.269     leot     12246: </tr>
                   12247: <tr>
1.338   ! nia      12248: <td>DJBDNS_AXFR_USER</td>
1.332     rillig   12249: <td>DJBDNS_CACHE_USER</td>
1.269     leot     12250: </tr>
                   12251: <tr>
1.338   ! nia      12252: <td>DJBDNS_DJBDNS_GROUP</td>
1.332     rillig   12253: <td>DJBDNS_LOG_USER</td>
1.269     leot     12254: </tr>
                   12255: <tr>
1.338   ! nia      12256: <td>DJBDNS_RBL_USER</td>
1.332     rillig   12257: <td>DJBDNS_TINY_USER</td>
1.269     leot     12258: </tr>
                   12259: <tr>
1.338   ! nia      12260: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.332     rillig   12261: <td>DL_AUTO_VARS</td>
1.269     leot     12262: </tr>
                   12263: <tr>
1.338   ! nia      12264: <td>DL_CFLAGS</td>
1.332     rillig   12265: <td>DL_LDFLAGS</td>
1.269     leot     12266: </tr>
                   12267: <tr>
1.338   ! nia      12268: <td>DL_LIBS</td>
1.332     rillig   12269: <td>DNS</td>
1.269     leot     12270: </tr>
                   12271: <tr>
1.338   ! nia      12272: <td>DOCOWN</td>
1.332     rillig   12273: <td>DOWNLOADED_DISTFILE</td>
1.269     leot     12274: </tr>
                   12275: <tr>
1.338   ! nia      12276: <td>DQCACHE_GROUP</td>
1.333     nia      12277: <td>DQCACHE_USER</td>
                   12278: </tr>
                   12279: <tr>
1.338   ! nia      12280: <td>DT_LAYOUT</td>
1.332     rillig   12281: <td>DYNAMIC_SITES_CMD</td>
1.269     leot     12282: </tr>
                   12283: <tr>
1.338   ! nia      12284: <td>DYNAMIC_SITES_SCRIPT</td>
1.332     rillig   12285: <td>ECHO</td>
1.269     leot     12286: </tr>
                   12287: <tr>
1.338   ! nia      12288: <td>ECHO_N</td>
1.332     rillig   12289: <td>ELK_GUI</td>
1.269     leot     12290: </tr>
                   12291: <tr>
1.338   ! nia      12292: <td>EMACS_TYPE</td>
1.332     rillig   12293: <td>EMULDIR</td>
1.269     leot     12294: </tr>
                   12295: <tr>
1.338   ! nia      12296: <td>EMULSUBDIR</td>
1.332     rillig   12297: <td>EMULSUBDIRSLASH</td>
1.269     leot     12298: </tr>
                   12299: <tr>
1.338   ! nia      12300: <td>EMUL_ARCH</td>
1.332     rillig   12301: <td>EMUL_DISTRO</td>
1.269     leot     12302: </tr>
                   12303: <tr>
1.338   ! nia      12304: <td>EMUL_EXEC_FMT</td>
1.332     rillig   12305: <td>EMUL_IS_NATIVE</td>
1.269     leot     12306: </tr>
                   12307: <tr>
1.338   ! nia      12308: <td>EMUL_MODULES</td>
1.332     rillig   12309: <td>EMUL_OPSYS</td>
1.269     leot     12310: </tr>
                   12311: <tr>
1.338   ! nia      12312: <td>EMUL_PKG_FMT</td>
1.332     rillig   12313: <td>EMUL_PLATFORM</td>
1.269     leot     12314: </tr>
                   12315: <tr>
1.338   ! nia      12316: <td>EMUL_PLATFORMS</td>
1.332     rillig   12317: <td>EMUL_PREFER</td>
1.269     leot     12318: </tr>
                   12319: <tr>
1.338   ! nia      12320: <td>EMUL_REQD</td>
1.332     rillig   12321: <td>EMUL_TYPE</td>
1.269     leot     12322: </tr>
                   12323: <tr>
1.338   ! nia      12324: <td>ERROR_MSG</td>
1.332     rillig   12325: <td>EXIM_GROUP</td>
1.269     leot     12326: </tr>
                   12327: <tr>
1.338   ! nia      12328: <td>EXIM_USER</td>
1.332     rillig   12329: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269     leot     12330: </tr>
                   12331: <tr>
1.338   ! nia      12332: <td>EXTRACTOR</td>
1.332     rillig   12333: <td>EXTRACT_CMD</td>
1.338   ! nia      12334: </tr>
        !          12335: <tr>
1.337     gutterid 12336: <td>EXTRACT_CMD_DEFAULT</td>
1.338   ! nia      12337: <td>EXTRACT_DIR</td>
1.269     leot     12338: </tr>
                   12339: <tr>
1.337     gutterid 12340: <td>EXTRACT_ELEMENTS</td>
1.338   ! nia      12341: <td>EXTRACT_ENV</td>
1.269     leot     12342: </tr>
                   12343: <tr>
1.337     gutterid 12344: <td>EXTRACT_ONLY</td>
1.338   ! nia      12345: <td>EXTRACT_OPTS</td>
1.269     leot     12346: </tr>
                   12347: <tr>
1.337     gutterid 12348: <td>EXTRACT_SUFX</td>
1.338   ! nia      12349: <td>EXTRACT_USING</td>
1.269     leot     12350: </tr>
                   12351: <tr>
1.337     gutterid 12352: <td>FAIL</td>
1.338   ! nia      12353: <td>FAILOVER_FETCH</td>
1.269     leot     12354: </tr>
                   12355: <tr>
1.337     gutterid 12356: <td>FAIL_MSG</td>
1.338   ! nia      12357: <td>FAKE_NCURSES</td>
1.269     leot     12358: </tr>
                   12359: <tr>
1.337     gutterid 12360: <td>FAM</td>
1.338   ! nia      12361: <td>FAM_ACCEPTED</td>
1.269     leot     12362: </tr>
                   12363: <tr>
1.337     gutterid 12364: <td>FAM_DEFAULT</td>
1.338   ! nia      12365: <td>FAM_SERVER</td>
1.269     leot     12366: </tr>
                   12367: <tr>
1.337     gutterid 12368: <td>FCPATH</td>
1.338   ! nia      12369: <td>FEATURE_CPPFLAGS</td>
1.269     leot     12370: </tr>
                   12371: <tr>
1.337     gutterid 12372: <td>FEATURE_LDFLAGS</td>
1.338   ! nia      12373: <td>FEATURE_LIBS</td>
1.292     leot     12374: </tr>
                   12375: <tr>
1.337     gutterid 12376: <td>FETCH_AFTER_ARGS</td>
1.338   ! nia      12377: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     12378: </tr>
                   12379: <tr>
1.337     gutterid 12380: <td>FETCH_CMD</td>
1.338   ! nia      12381: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     12382: </tr>
                   12383: <tr>
1.337     gutterid 12384: <td>FETCH_PROXY</td>
1.338   ! nia      12385: <td>FETCH_RESUME_ARGS</td>
1.269     leot     12386: </tr>
                   12387: <tr>
1.337     gutterid 12388: <td>FETCH_TIMEOUT</td>
1.338   ! nia      12389: <td>FETCH_USE_IPV4_ONLY</td>
1.269     leot     12390: </tr>
                   12391: <tr>
1.337     gutterid 12392: <td>FETCH_USING</td>
1.338   ! nia      12393: <td>FILES_SUBST</td>
1.269     leot     12394: </tr>
                   12395: <tr>
1.337     gutterid 12396: <td>FILES_SUBST_SED</td>
1.338   ! nia      12397: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     12398: </tr>
                   12399: <tr>
1.338   ! nia      12400: <td>FONTDIR</td>
1.295     rillig   12401: <td>FONTS_DIRS</td>
1.274     rillig   12402: </tr>
                   12403: <tr>
1.305     bacon    12404: <td>FONTS_VERBOSE</td>
1.295     rillig   12405: <td>FOO_HACKS_MK</td>
1.292     leot     12406: </tr>
                   12407: <tr>
1.338   ! nia      12408: <td>FOSSIL_EXTRACTDIR</td>
        !          12409: <td>FOSSIL_REPO</td>
        !          12410: </tr>
        !          12411: <tr>
        !          12412: <td>FOSSIL_REPOSITORIES</td>
        !          12413: <td>FOSSIL_VERSION</td>
        !          12414: </tr>
        !          12415: <tr>
1.305     bacon    12416: <td>FOX_USE_XUNICODE</td>
1.295     rillig   12417: <td>FREEWNN_GROUP</td>
1.269     leot     12418: </tr>
                   12419: <tr>
1.305     bacon    12420: <td>FREEWNN_USER</td>
1.295     rillig   12421: <td>FTP_PKG_URL_DIR</td>
1.269     leot     12422: </tr>
                   12423: <tr>
1.305     bacon    12424: <td>FTP_PKG_URL_HOST</td>
1.295     rillig   12425: <td>GAMEDATAMODE</td>
1.269     leot     12426: </tr>
                   12427: <tr>
1.305     bacon    12428: <td>GAMEDATA_PERMS</td>
1.295     rillig   12429: <td>GAMEDIRMODE</td>
1.269     leot     12430: </tr>
                   12431: <tr>
1.305     bacon    12432: <td>GAMEDIR_PERMS</td>
1.295     rillig   12433: <td>GAMEGRP</td>
1.269     leot     12434: </tr>
                   12435: <tr>
1.305     bacon    12436: <td>GAMEMODE</td>
1.295     rillig   12437: <td>GAMEOWN</td>
1.269     leot     12438: </tr>
                   12439: <tr>
1.305     bacon    12440: <td>GAMES_GROUP</td>
1.295     rillig   12441: <td>GAMES_USER</td>
1.269     leot     12442: </tr>
                   12443: <tr>
1.305     bacon    12444: <td>GCC</td>
1.295     rillig   12445: <td>GCCBASE</td>
1.269     leot     12446: </tr>
                   12447: <tr>
1.305     bacon    12448: <td>GCC_REQD</td>
1.295     rillig   12449: <td>GCC_VERSION_SUFFIX</td>
1.269     leot     12450: </tr>
                   12451: <tr>
1.305     bacon    12452: <td>GEM_BUILD</td>
1.295     rillig   12453: <td>GEM_CLEANBUILD</td>
1.269     leot     12454: </tr>
                   12455: <tr>
1.305     bacon    12456: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295     rillig   12457: <td>GEM_DOCDIR</td>
1.269     leot     12458: </tr>
                   12459: <tr>
1.305     bacon    12460: <td>GEM_EXTSDIR</td>
1.295     rillig   12461: <td>GEM_HOME</td>
1.292     leot     12462: </tr>
                   12463: <tr>
1.305     bacon    12464: <td>GEM_KEEPBUILD</td>
1.295     rillig   12465: <td>GEM_LIBDIR</td>
1.269     leot     12466: </tr>
                   12467: <tr>
1.305     bacon    12468: <td>GEM_NAME</td>
1.295     rillig   12469: <td>GEM_PATH</td>
1.269     leot     12470: </tr>
                   12471: <tr>
1.312     gdt      12472: <td>GEM_PLUGINSDIR</td>
1.305     bacon    12473: <td>GEM_SPECFILE</td>
1.269     leot     12474: </tr>
                   12475: <tr>
1.312     gdt      12476: <td>GENERATE_PLIST</td>
1.316     cirnatda 12477: <td>GHC</td>
1.269     leot     12478: </tr>
                   12479: <tr>
1.316     cirnatda 12480: <td>GHOSTSCRIPT_REQD</td>
1.312     gdt      12481: <td>GITHUB_PROJECT</td>
1.292     leot     12482: </tr>
                   12483: <tr>
1.316     cirnatda 12484: <td>GITHUB_RELEASE</td>
1.315     cirnatda 12485: <td>GITHUB_SUBMODULES</td>
1.311     leot     12486: </tr>
                   12487: <tr>
1.316     cirnatda 12488: <td>GITHUB_TAG</td>
1.313     leot     12489: <td>GITHUB_TYPE</td>
1.269     leot     12490: </tr>
                   12491: <tr>
1.338   ! nia      12492: <td>GITLAB_PROJECT</td>
        !          12493: <td>GITLAB_TAG</td>
        !          12494: </tr>
        !          12495: <tr>
        !          12496: <td>GITLAB_TYPE</td>
        !          12497: <td>GIT_BRANCH</td>
        !          12498: </tr>
        !          12499: <tr>
        !          12500: <td>GIT_ENV</td>
        !          12501: <td>GIT_EXTRACTDIR</td>
        !          12502: </tr>
        !          12503: <tr>
        !          12504: <td>GIT_REPO</td>
        !          12505: <td>GIT_REPOSITORIES</td>
        !          12506: </tr>
        !          12507: <tr>
        !          12508: <td>GIT_REVISION</td>
        !          12509: <td>GIT_TAG</td>
        !          12510: </tr>
        !          12511: <tr>
1.316     cirnatda 12512: <td>GNU</td>
1.313     leot     12513: <td>GNU_CONFIGURE</td>
1.269     leot     12514: </tr>
                   12515: <tr>
1.316     cirnatda 12516: <td>GNU_CONFIGURE_INFODIR</td>
1.313     leot     12517: <td>GNU_CONFIGURE_MANDIR</td>
1.269     leot     12518: </tr>
                   12519: <tr>
1.316     cirnatda 12520: <td>GNU_CONFIGURE_QUIET</td>
1.313     leot     12521: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     12522: </tr>
                   12523: <tr>
1.316     cirnatda 12524: <td>GODEP_REDIRECTS</td>
1.313     leot     12525: <td>GO_BUILD_PATTERN</td>
1.276     leot     12526: </tr>
                   12527: <tr>
1.316     cirnatda 12528: <td>GO_DEPS</td>
1.313     leot     12529: <td>GO_DIST_BASE</td>
1.269     leot     12530: </tr>
                   12531: <tr>
1.324     nia      12532: <td>GO_EXTRA_MOD_DIRS</td>
1.316     cirnatda 12533: <td>GO_MODULE_FILES</td>
1.269     leot     12534: </tr>
                   12535: <tr>
1.324     nia      12536: <td>GO_SRCPATH</td>
1.316     cirnatda 12537: <td>GO_VERSION_DEFAULT</td>
1.269     leot     12538: </tr>
                   12539: <tr>
1.324     nia      12540: <td>GROUP_SPECIFIC_PKGS</td>
1.316     cirnatda 12541: <td>GRUB_NETWORK_CARDS</td>
1.311     leot     12542: </tr>
                   12543: <tr>
1.324     nia      12544: <td>GRUB_PRESET_COMMAND</td>
1.316     cirnatda 12545: <td>GRUB_SCAN_ARGS</td>
1.269     leot     12546: </tr>
                   12547: <tr>
1.324     nia      12548: <td>GZIP</td>
1.338   ! nia      12549: <td>HASKELL_COMPILER</td>
        !          12550: </tr>
        !          12551: <tr>
1.337     gutterid 12552: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.338   ! nia      12553: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.332     rillig   12554: </tr>
                   12555: <tr>
1.337     gutterid 12556: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.338   ! nia      12557: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.335     nia      12558: </tr>
                   12559: <tr>
1.337     gutterid 12560: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.338   ! nia      12561: <td>HAS_CONFIGURE</td>
1.329     leot     12562: </tr>
                   12563: <tr>
1.332     rillig   12564: <td>HEADER_TEMPLATES</td>
1.338   ! nia      12565: <td>HG_REPO</td>
        !          12566: </tr>
        !          12567: <tr>
        !          12568: <td>HG_REPOSITORIES</td>
        !          12569: <td>HG_TAG</td>
1.320     wiz      12570: </tr>
                   12571: <tr>
1.316     cirnatda 12572: <td>HOMEPAGE</td>
1.335     nia      12573: <td>HOST_PKGTOOLS_ARGS</td>
1.269     leot     12574: </tr>
                   12575: <tr>
1.316     cirnatda 12576: <td>HOST_SPECIFIC_PKGS</td>
1.335     nia      12577: <td>HOWL_GROUP</td>
1.305     bacon    12578: </tr>
                   12579: <tr>
1.316     cirnatda 12580: <td>HOWL_USER</td>
1.335     nia      12581: <td>ICCBASE</td>
1.269     leot     12582: </tr>
                   12583: <tr>
1.316     cirnatda 12584: <td>ICECAST_CHROOTDIR</td>
1.335     nia      12585: <td>ICON_THEMES</td>
1.269     leot     12586: </tr>
                   12587: <tr>
1.316     cirnatda 12588: <td>IDOBASE</td>
1.335     nia      12589: <td>IGNORE_CCACHE</td>
1.269     leot     12590: </tr>
                   12591: <tr>
1.316     cirnatda 12592: <td>IGNORE_INFO_DIRS</td>
1.335     nia      12593: <td>IGNORE_INTERACTIVE_FETCH</td>
1.269     leot     12594: </tr>
                   12595: <tr>
1.316     cirnatda 12596: <td>IMAKE</td>
1.335     nia      12597: <td>IMAKEOPTS</td>
1.269     leot     12598: </tr>
                   12599: <tr>
1.316     cirnatda 12600: <td>IMAKE_MAKE</td>
1.335     nia      12601: <td>IMAKE_MANINSTALL</td>
1.269     leot     12602: </tr>
                   12603: <tr>
1.316     cirnatda 12604: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.335     nia      12605: <td>IMDICTDIR</td>
1.269     leot     12606: </tr>
                   12607: <tr>
1.316     cirnatda 12608: <td>INCOMPAT_CURSES</td>
1.335     nia      12609: <td>INFO_DIR</td>
1.269     leot     12610: </tr>
                   12611: <tr>
1.316     cirnatda 12612: <td>INFO_FILES</td>
1.335     nia      12613: <td>INFO_FILES_VERBOSE</td>
1.269     leot     12614: </tr>
                   12615: <tr>
1.316     cirnatda 12616: <td>INFO_MSG</td>
1.335     nia      12617: <td>INIT_SYSTEM</td>
1.287     rillig   12618: </tr>
                   12619: <tr>
1.316     cirnatda 12620: <td>INN_DATA_DIR</td>
1.335     nia      12621: <td>INN_GROUP</td>
1.269     leot     12622: </tr>
                   12623: <tr>
1.316     cirnatda 12624: <td>INN_USER</td>
1.335     nia      12625: <td>INSTALLATION_DIRS</td>
1.269     leot     12626: </tr>
                   12627: <tr>
1.316     cirnatda 12628: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.335     nia      12629: <td>INSTALL_ENV</td>
1.269     leot     12630: </tr>
                   12631: <tr>
1.316     cirnatda 12632: <td>INSTALL_SH_OVERRIDE</td>
1.335     nia      12633: <td>INSTALL_SRC</td>
1.269     leot     12634: </tr>
                   12635: <tr>
1.316     cirnatda 12636: <td>INSTALL_TEMPLATES</td>
1.335     nia      12637: <td>INSTALL_UNSTRIPPED</td>
1.269     leot     12638: </tr>
                   12639: <tr>
1.316     cirnatda 12640: <td>IRCD_HYBRID_IRC_GROUP</td>
1.335     nia      12641: <td>IRCD_HYBRID_IRC_USER</td>
1.269     leot     12642: </tr>
                   12643: <tr>
1.316     cirnatda 12644: <td>IRCD_HYBRID_MAXCONN</td>
1.335     nia      12645: <td>IRCD_HYBRID_NICLEN</td>
1.269     leot     12646: </tr>
                   12647: <tr>
1.316     cirnatda 12648: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.335     nia      12649: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269     leot     12650: </tr>
                   12651: <tr>
1.316     cirnatda 12652: <td>IRCD_HYBRID_TOPICLEN</td>
1.335     nia      12653: <td>IRIX</td>
1.269     leot     12654: </tr>
                   12655: <tr>
1.316     cirnatda 12656: <td>IRRD_USE_PGP</td>
1.335     nia      12657: <td>JABBERD_GROUP</td>
1.269     leot     12658: </tr>
                   12659: <tr>
1.316     cirnatda 12660: <td>JABBERD_LOGDIR</td>
1.335     nia      12661: <td>JABBERD_PIDDIR</td>
1.292     leot     12662: </tr>
                   12663: <tr>
1.316     cirnatda 12664: <td>JABBERD_SPOOLDIR</td>
1.335     nia      12665: <td>JABBERD_USER</td>
1.311     leot     12666: </tr>
                   12667: <tr>
1.338   ! nia      12668: <td>JAVA_APP_PATH</td>
        !          12669: <td>JAVA_APP_TARGETS</td>
        !          12670: </tr>
        !          12671: <tr>
1.333     nia      12672: <td>JAVA_BINPREFIX</td>
1.335     nia      12673: <td>JAVA_CLASSPATH</td>
1.269     leot     12674: </tr>
                   12675: <tr>
1.333     nia      12676: <td>JAVA_HOME</td>
1.335     nia      12677: <td>JAVA_LD_LIBRARY_PATH</td>
1.332     rillig   12678: </tr>
                   12679: <tr>
1.333     nia      12680: <td>JAVA_NAME</td>
1.335     nia      12681: <td>JAVA_UNLIMIT</td>
1.332     rillig   12682: </tr>
                   12683: <tr>
1.333     nia      12684: <td>JAVA_WRAPPERS</td>
1.335     nia      12685: <td>JPEG_ACCEPTED</td>
1.269     leot     12686: </tr>
                   12687: <tr>
1.333     nia      12688: <td>JPEG_DEFAULT</td>
1.335     nia      12689: <td>KERBEROS</td>
1.269     leot     12690: </tr>
                   12691: <tr>
1.333     nia      12692: <td>KERMIT_SUID_UUCP</td>
1.335     nia      12693: <td>KJS_USE_PCRE</td>
1.269     leot     12694: </tr>
                   12695: <tr>
1.333     nia      12696: <td>KNEWS_DOMAIN_FILE</td>
1.335     nia      12697: <td>KNEWS_DOMAIN_NAME</td>
1.269     leot     12698: </tr>
                   12699: <tr>
1.333     nia      12700: <td>KRB5_ACCEPTED</td>
1.335     nia      12701: <td>KRB5_DEFAULT</td>
1.292     leot     12702: </tr>
                   12703: <tr>
1.333     nia      12704: <td>LANGUAGES</td>
1.335     nia      12705: <td>LAPACKE_LIBS</td>
1.271     brook    12706: </tr>
                   12707: <tr>
1.333     nia      12708: <td>LAPACK_LIBS</td>
1.335     nia      12709: <td>LATEX2HTML_ICONPATH</td>
1.269     leot     12710: </tr>
                   12711: <tr>
1.333     nia      12712: <td>LDCONFIG_ADD_CMD</td>
1.335     nia      12713: <td>LDCONFIG_REMOVE_CMD</td>
1.269     leot     12714: </tr>
                   12715: <tr>
1.333     nia      12716: <td>LDD</td>
1.335     nia      12717: <td>LEAFNODE_DATA_DIR</td>
1.269     leot     12718: </tr>
                   12719: <tr>
1.333     nia      12720: <td>LEAFNODE_GROUP</td>
1.335     nia      12721: <td>LEAFNODE_USER</td>
1.269     leot     12722: </tr>
                   12723: <tr>
1.333     nia      12724: <td>LIBDVDCSS_HOMEPAGE</td>
1.335     nia      12725: <td>LIBDVDCSS_MASTER_SITES</td>
1.320     wiz      12726: </tr>
                   12727: <tr>
1.333     nia      12728: <td>LIBRSVG_TYPE</td>
1.335     nia      12729: <td>LIBTOOL</td>
1.270     leot     12730: </tr>
                   12731: <tr>
1.333     nia      12732: <td>LIBTOOLIZE_PLIST</td>
1.335     nia      12733: <td>LIBTOOL_M4_OVERRIDE</td>
1.327     wiz      12734: </tr>
                   12735: <tr>
1.333     nia      12736: <td>LIBUSB_TYPE</td>
1.335     nia      12737: <td>LICENSE</td>
1.269     leot     12738: </tr>
                   12739: <tr>
1.333     nia      12740: <td>LINKER_RPATH_FLAG</td>
1.335     nia      12741: <td>LINK_RPATH_FLAG</td>
1.292     leot     12742: </tr>
                   12743: <tr>
1.338   ! nia      12744: <td>LINUX_BASE_NODEPS</td>
        !          12745: <td>LINUX_BASE_PREFERRED</td>
        !          12746: </tr>
        !          12747: <tr>
        !          12748: <td>LINUX_BASE_REQUIRED</td>
1.335     nia      12749: <td>LINUX_LOCALES</td>
1.338   ! nia      12750: </tr>
        !          12751: <tr>
1.337     gutterid 12752: <td>LOCALBASE</td>
1.338   ! nia      12753: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     12754: </tr>
                   12755: <tr>
1.337     gutterid 12756: <td>LOCALPATCHES</td>
1.338   ! nia      12757: <td>LOVE_DATA</td>
1.329     leot     12758: </tr>
                   12759: <tr>
1.337     gutterid 12760: <td>LOVE_GAME</td>
1.338   ! nia      12761: <td>LOVE_VERSION</td>
1.269     leot     12762: </tr>
                   12763: <tr>
1.337     gutterid 12764: <td>LP32PLATFORMS</td>
1.338   ! nia      12765: <td>LP64PLATFORMS</td>
1.269     leot     12766: </tr>
                   12767: <tr>
1.337     gutterid 12768: <td>LUA_BUSTED_ARGS</td>
1.338   ! nia      12769: <td>LUA_CDIR</td>
1.269     leot     12770: </tr>
                   12771: <tr>
1.337     gutterid 12772: <td>LUA_COMPILER</td>
1.338   ! nia      12773: <td>LUA_DOCDIR</td>
1.336     nia      12774: </tr>
                   12775: <tr>
1.337     gutterid 12776: <td>LUA_EXAMPLESDIR</td>
1.338   ! nia      12777: <td>LUA_INCDIR</td>
1.333     nia      12778: </tr>
                   12779: <tr>
1.337     gutterid 12780: <td>LUA_INTERPRETER</td>
1.338   ! nia      12781: <td>LUA_LDIR</td>
1.333     nia      12782: </tr>
                   12783: <tr>
1.337     gutterid 12784: <td>LUA_LINKER_MAGIC</td>
1.338   ! nia      12785: <td>LUA_PKGPREFIX</td>
1.333     nia      12786: </tr>
                   12787: <tr>
1.337     gutterid 12788: <td>LUA_SELF_CONFLICT</td>
1.338   ! nia      12789: <td>LUA_USE_BUSTED</td>
1.333     nia      12790: </tr>
                   12791: <tr>
1.337     gutterid 12792: <td>LUA_VERSIONS_ACCEPTED</td>
1.338   ! nia      12793: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.333     nia      12794: </tr>
                   12795: <tr>
1.337     gutterid 12796: <td>LUA_VERSION_DEFAULT</td>
1.338   ! nia      12797: <td>LUA_VERSION_REQD</td>
1.333     nia      12798: </tr>
                   12799: <tr>
1.337     gutterid 12800: <td>Lua</td>
1.338   ! nia      12801: <td>MACHINE_PLATFORM</td>
1.333     nia      12802: </tr>
                   12803: <tr>
1.337     gutterid 12804: <td>MAILAGENT_DOMAIN</td>
1.338   ! nia      12805: <td>MAILAGENT_EMAIL</td>
1.269     leot     12806: </tr>
                   12807: <tr>
1.337     gutterid 12808: <td>MAILAGENT_FQDN</td>
1.338   ! nia      12809: <td>MAILAGENT_ORGANIZATION</td>
1.320     wiz      12810: </tr>
                   12811: <tr>
1.332     rillig   12812: <td>MAJORDOMO_HOMEDIR</td>
1.338   ! nia      12813: <td>MAJOR_OS_VERSION</td>
1.269     leot     12814: </tr>
                   12815: <tr>
1.324     nia      12816: <td>MAKEINFO_ARGS</td>
1.336     nia      12817: <td>MAKE_DIRS</td>
1.327     wiz      12818: </tr>
                   12819: <tr>
                   12820: <td>MAKE_DIRS_PERMS</td>
1.336     nia      12821: <td>MAKE_ENV</td>
1.269     leot     12822: </tr>
                   12823: <tr>
1.327     wiz      12824: <td>MAKE_FILE</td>
1.336     nia      12825: <td>MAKE_FLAGS</td>
1.269     leot     12826: </tr>
                   12827: <tr>
1.327     wiz      12828: <td>MAKE_JOBS</td>
1.336     nia      12829: <td>MAKE_JOBS_SAFE</td>
1.269     leot     12830: </tr>
                   12831: <tr>
1.327     wiz      12832: <td>MAKE_PROGRAM</td>
1.336     nia      12833: <td>MANCOMPRESSED_IF_MANZ</td>
1.303     bacon    12834: </tr>
                   12835: <tr>
1.327     wiz      12836: <td>MANINSTALL</td>
1.336     nia      12837: <td>MANZ</td>
1.269     leot     12838: </tr>
                   12839: <tr>
1.327     wiz      12840: <td>MASTER_SITES</td>
1.336     nia      12841: <td>MASTER_SITE_BACKUP</td>
1.269     leot     12842: </tr>
                   12843: <tr>
1.327     wiz      12844: <td>MASTER_SITE_LOCAL</td>
1.336     nia      12845: <td>MASTER_SITE_MOZILLA</td>
1.269     leot     12846: </tr>
                   12847: <tr>
1.327     wiz      12848: <td>MASTER_SITE_OVERRIDE</td>
1.336     nia      12849: <td>MASTER_SITE_PERL_CPAN</td>
1.269     leot     12850: </tr>
                   12851: <tr>
1.327     wiz      12852: <td>MASTER_SORT</td>
1.336     nia      12853: <td>MASTER_SORT_RANDOM</td>
1.269     leot     12854: </tr>
                   12855: <tr>
1.327     wiz      12856: <td>MASTER_SORT_REGEX</td>
1.336     nia      12857: <td>MECAB_CHARSET</td>
1.269     leot     12858: </tr>
                   12859: <tr>
1.327     wiz      12860: <td>MEDIATOMB_GROUP</td>
1.336     nia      12861: <td>MEDIATOMB_USER</td>
1.269     leot     12862: </tr>
                   12863: <tr>
1.327     wiz      12864: <td>MIPSPROBASE</td>
1.336     nia      12865: <td>MIREDO_GROUP</td>
1.269     leot     12866: </tr>
                   12867: <tr>
1.327     wiz      12868: <td>MIREDO_USER</td>
1.336     nia      12869: <td>MISSING_FEATURES</td>
1.269     leot     12870: </tr>
                   12871: <tr>
1.327     wiz      12872: <td>MKDIR</td>
1.336     nia      12873: <td>MKPIE_SUPPORTED</td>
1.269     leot     12874: </tr>
                   12875: <tr>
1.327     wiz      12876: <td>MLDONKEY_GROUP</td>
1.336     nia      12877: <td>MLDONKEY_HOME</td>
1.322     leot     12878: </tr>
                   12879: <tr>
1.327     wiz      12880: <td>MLDONKEY_USER</td>
1.336     nia      12881: <td>MONOTONE_GROUP</td>
1.269     leot     12882: </tr>
                   12883: <tr>
1.327     wiz      12884: <td>MONOTONE_USER</td>
1.336     nia      12885: <td>MOTIFBASE</td>
1.269     leot     12886: </tr>
                   12887: <tr>
1.327     wiz      12888: <td>MOTIF_TYPE</td>
1.336     nia      12889: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     12890: </tr>
                   12891: <tr>
1.327     wiz      12892: <td>MPI_TYPE</td>
1.336     nia      12893: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     12894: </tr>
                   12895: <tr>
1.327     wiz      12896: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.336     nia      12897: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.311     leot     12898: </tr>
                   12899: <tr>
1.338   ! nia      12900: <td>MUST</td>
1.336     nia      12901: <td>MV</td>
1.338   ! nia      12902: </tr>
        !          12903: <tr>
1.337     gutterid 12904: <td>MYSQL_CHARSET</td>
1.338   ! nia      12905: <td>MYSQL_DATADIR</td>
1.329     leot     12906: </tr>
                   12907: <tr>
1.337     gutterid 12908: <td>MYSQL_EXTRA_CHARSET</td>
1.338   ! nia      12909: <td>MYSQL_GROUP</td>
1.269     leot     12910: </tr>
                   12911: <tr>
1.337     gutterid 12912: <td>MYSQL_USER</td>
1.338   ! nia      12913: <td>MYSQL_VERSION</td>
1.320     wiz      12914: </tr>
                   12915: <tr>
1.337     gutterid 12916: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.338   ! nia      12917: <td>MYSQL_VERSIONS_ALL</td>
1.269     leot     12918: </tr>
                   12919: <tr>
1.337     gutterid 12920: <td>MYSQL_VERSION_DEFAULT</td>
1.338   ! nia      12921: <td>NAGIOSCMD_GROUP</td>
1.269     leot     12922: </tr>
                   12923: <tr>
1.337     gutterid 12924: <td>NAGIOSDIR</td>
1.338   ! nia      12925: <td>NAGIOS_GROUP</td>
1.269     leot     12926: </tr>
                   12927: <tr>
1.337     gutterid 12928: <td>NAGIOS_USER</td>
1.338   ! nia      12929: <td>NATIVE_APPEND_ABI</td>
1.309     gutterid 12930: </tr>
                   12931: <tr>
1.337     gutterid 12932: <td>NATIVE_APPEND_ELF</td>
1.338   ! nia      12933: <td>NATIVE_EXEC_FMT</td>
1.269     leot     12934: </tr>
                   12935: <tr>
1.337     gutterid 12936: <td>NATIVE_MACHINE_PLATFORM</td>
1.338   ! nia      12937: <td>NATIVE_OBJECT_FMT</td>
1.269     leot     12938: </tr>
                   12939: <tr>
1.337     gutterid 12940: <td>NBPAX_PROGRAM_PREFIX</td>
1.338   ! nia      12941: <td>NETBSD_LOGIN_NAME</td>
1.269     leot     12942: </tr>
                   12943: <tr>
1.337     gutterid 12944: <td>NMH_EDITOR</td>
1.338   ! nia      12945: <td>NMH_MTA</td>
1.269     leot     12946: </tr>
                   12947: <tr>
1.337     gutterid 12948: <td>NMH_PAGER</td>
1.338   ! nia      12949: <td>NODE_VERSIONS_ACCEPTED</td>
1.269     leot     12950: </tr>
                   12951: <tr>
1.337     gutterid 12952: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.338   ! nia      12953: <td>NODE_VERSION_DEFAULT</td>
1.269     leot     12954: </tr>
                   12955: <tr>
1.337     gutterid 12956: <td>NODE_VERSION_REQD</td>
1.338   ! nia      12957: <td>NOLOGIN</td>
1.333     nia      12958: </tr>
                   12959: <tr>
1.337     gutterid 12960: <td>NOTE</td>
1.338   ! nia      12961: <td>NOT_FOR_PLATFORM</td>
1.333     nia      12962: </tr>
                   12963: <tr>
1.337     gutterid 12964: <td>NOT_PAX_ASLR_SAFE</td>
1.338   ! nia      12965: <td>NOT_PAX_MPROTECT_SAFE</td>
1.293     rillig   12966: </tr>
                   12967: <tr>
1.337     gutterid 12968: <td>NO_BUILD</td>
1.338   ! nia      12969: <td>NO_CHECKSUM</td>
1.269     leot     12970: </tr>
                   12971: <tr>
1.337     gutterid 12972: <td>NO_CONFIGURE</td>
1.338   ! nia      12973: <td>NO_SKIP</td>
1.269     leot     12974: </tr>
                   12975: <tr>
1.337     gutterid 12976: <td>NS_PREFERRED</td>
1.338   ! nia      12977: <td>NULLMAILER_GROUP</td>
1.269     leot     12978: </tr>
                   12979: <tr>
1.337     gutterid 12980: <td>NULLMAILER_USER</td>
1.338   ! nia      12981: <td>OASIS</td>
1.269     leot     12982: </tr>
                   12983: <tr>
1.337     gutterid 12984: <td>OASIS_BUILD_ARGS</td>
1.338   ! nia      12985: <td>OBJHOSTNAME</td>
1.269     leot     12986: </tr>
                   12987: <tr>
1.337     gutterid 12988: <td>OBJMACHINE</td>
1.338   ! nia      12989: <td>OCAML_FINDLIB_DIRS</td>
1.269     leot     12990: </tr>
                   12991: <tr>
1.337     gutterid 12992: <td>OCAML_FINDLIB_REGISTER</td>
1.338   ! nia      12993: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269     leot     12994: </tr>
                   12995: <tr>
1.337     gutterid 12996: <td>OCAML_SITELIBDIR</td>
1.338   ! nia      12997: <td>OCAML_TOPKG_DOCDIR</td>
1.269     leot     12998: </tr>
                   12999: <tr>
1.337     gutterid 13000: <td>OCAML_USE_DUNE</td>
1.338   ! nia      13001: <td>OCAML_USE_FINDLIB</td>
1.269     leot     13002: </tr>
                   13003: <tr>
1.337     gutterid 13004: <td>OCAML_USE_OASIS</td>
1.338   ! nia      13005: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269     leot     13006: </tr>
                   13007: <tr>
1.337     gutterid 13008: <td>OCAML_USE_OPAM</td>
1.338   ! nia      13009: <td>OCAML_USE_OPT_COMPILER</td>
1.269     leot     13010: </tr>
                   13011: <tr>
1.337     gutterid 13012: <td>OCAML_USE_TOPKG</td>
1.338   ! nia      13013: <td>OMF</td>
1.269     leot     13014: </tr>
                   13015: <tr>
1.337     gutterid 13016: <td>ONLY_FOR_COMPILER</td>
1.338   ! nia      13017: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     13018: </tr>
                   13019: <tr>
1.337     gutterid 13020: <td>OPENSSH_CHROOT</td>
1.338   ! nia      13021: <td>OPENSSH_GROUP</td>
1.269     leot     13022: </tr>
                   13023: <tr>
1.337     gutterid 13024: <td>OPENSSH_USER</td>
1.338   ! nia      13025: <td>OPSYS</td>
1.269     leot     13026: </tr>
                   13027: <tr>
1.337     gutterid 13028: <td>OPSYS_EMULDIR</td>
1.338   ! nia      13029: <td>OPSYS_VERSION</td>
1.269     leot     13030: </tr>
                   13031: <tr>
1.337     gutterid 13032: <td>OS</td>
1.338   ! nia      13033: <td>OSS_TYPE</td>
1.269     leot     13034: </tr>
                   13035: <tr>
1.337     gutterid 13036: <td>OSX</td>
1.338   ! nia      13037: <td>OSX_TOLERATE_SDK_SKEW</td>
        !          13038: </tr>
        !          13039: <tr>
        !          13040: <td>OS_HAVE_ALSA</td>
        !          13041: <td>OS_HAVE_RCD</td>
1.269     leot     13042: </tr>
                   13043: <tr>
1.337     gutterid 13044: <td>OS_VARIANT</td>
1.338   ! nia      13045: <td>OS_VERSION</td>
1.327     wiz      13046: </tr>
                   13047: <tr>
1.337     gutterid 13048: <td>OTF_FONTS_DIR</td>
1.338   ! nia      13049: <td>OVERRIDE_DIRDEPTH</td>
1.329     leot     13050: </tr>
                   13051: <tr>
1.337     gutterid 13052: <td>OVERRIDE_GEMSPEC</td>
1.338   ! nia      13053: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269     leot     13054: </tr>
                   13055: <tr>
1.338   ! nia      13056: <td>OVERRIDE_ROCKSPEC</td>
1.336     nia      13057: <td>OWN_DIRS</td>
1.320     wiz      13058: </tr>
                   13059: <tr>
1.335     nia      13060: <td>OWN_DIRS_PERMS</td>
1.336     nia      13061: <td>P4GROUP</td>
1.269     leot     13062: </tr>
                   13063: <tr>
1.335     nia      13064: <td>P4PORT</td>
1.336     nia      13065: <td>P4ROOT</td>
1.269     leot     13066: </tr>
                   13067: <tr>
1.335     nia      13068: <td>P4USER</td>
1.336     nia      13069: <td>PACKAGES</td>
1.269     leot     13070: </tr>
                   13071: <tr>
1.335     nia      13072: <td>PALMOS_DEFAULT_SDK</td>
1.336     nia      13073: <td>PAMBASE</td>
1.269     leot     13074: </tr>
                   13075: <tr>
1.335     nia      13076: <td>PAM_DEFAULT</td>
1.336     nia      13077: <td>PAPERSIZE</td>
1.269     leot     13078: </tr>
                   13079: <tr>
1.335     nia      13080: <td>PASSIVE_FETCH</td>
1.336     nia      13081: <td>PATCHDIR</td>
1.269     leot     13082: </tr>
                   13083: <tr>
1.335     nia      13084: <td>PATCHFILES</td>
1.336     nia      13085: <td>PATCH_ARGS</td>
1.324     nia      13086: </tr>
                   13087: <tr>
1.335     nia      13088: <td>PATCH_DEBUG</td>
1.336     nia      13089: <td>PATCH_DIST_ARGS</td>
1.269     leot     13090: </tr>
                   13091: <tr>
1.335     nia      13092: <td>PATCH_DIST_CAT</td>
1.336     nia      13093: <td>PATCH_DIST_STRIP</td>
1.269     leot     13094: </tr>
                   13095: <tr>
1.335     nia      13096: <td>PATCH_FUZZ_FACTOR</td>
1.336     nia      13097: <td>PATCH_STRIP</td>
1.284     rillig   13098: </tr>
                   13099: <tr>
1.335     nia      13100: <td>PATH</td>
1.336     nia      13101: <td>PCCBASE</td>
1.269     leot     13102: </tr>
                   13103: <tr>
1.338   ! nia      13104: <td>PEAR</td>
        !          13105: <td>PEAR_CHANNEL</td>
        !          13106: </tr>
        !          13107: <tr>
        !          13108: <td>PEAR_CHANNEL_ALIAS</td>
        !          13109: <td>PEAR_CHANNEL_VERSION</td>
        !          13110: </tr>
        !          13111: <tr>
1.335     nia      13112: <td>PEAR_CMD</td>
1.336     nia      13113: <td>PEAR_LIB</td>
1.332     rillig   13114: </tr>
                   13115: <tr>
1.335     nia      13116: <td>PEAR_PACKAGE_XML</td>
1.336     nia      13117: <td>PERL5</td>
1.320     wiz      13118: </tr>
                   13119: <tr>
1.335     nia      13120: <td>PERL5_CONFIGURE</td>
1.336     nia      13121: <td>PERL5_CONFIGURE_DIRS</td>
1.292     leot     13122: </tr>
                   13123: <tr>
1.335     nia      13124: <td>PERL5_LDFLAGS</td>
1.336     nia      13125: <td>PERL5_LICENSE</td>
1.274     rillig   13126: </tr>
                   13127: <tr>
1.335     nia      13128: <td>PERL5_MODULE_TYPE</td>
1.336     nia      13129: <td>PERL5_PACKLIST</td>
1.274     rillig   13130: </tr>
                   13131: <tr>
1.335     nia      13132: <td>PERL5_PACKLIST_DIR</td>
1.336     nia      13133: <td>PERL5_PERLBASE</td>
1.269     leot     13134: </tr>
                   13135: <tr>
1.335     nia      13136: <td>PERL5_SITEBASE</td>
1.336     nia      13137: <td>PERL5_USE_PACKLIST</td>
1.269     leot     13138: </tr>
                   13139: <tr>
1.335     nia      13140: <td>PERL5_VENDORBASE</td>
1.336     nia      13141: <td>PFCTL</td>
1.269     leot     13142: </tr>
                   13143: <tr>
1.335     nia      13144: <td>PFVAR_H</td>
1.336     nia      13145: <td>PF_VERSION</td>
1.269     leot     13146: </tr>
                   13147: <tr>
1.335     nia      13148: <td>PGGROUP</td>
1.336     nia      13149: <td>PGHOME</td>
1.269     leot     13150: </tr>
                   13151: <tr>
1.335     nia      13152: <td>PGPKGSRCDIR</td>
1.336     nia      13153: <td>PGSQL_TYPE</td>
1.269     leot     13154: </tr>
                   13155: <tr>
1.335     nia      13156: <td>PGSQL_VERSION</td>
1.336     nia      13157: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     13158: </tr>
                   13159: <tr>
1.335     nia      13160: <td>PGSQL_VERSION_DEFAULT</td>
1.336     nia      13161: <td>PGUSER</td>
1.269     leot     13162: </tr>
                   13163: <tr>
1.335     nia      13164: <td>PG_LIB_EXT</td>
1.336     nia      13165: <td>PHP</td>
1.269     leot     13166: </tr>
                   13167: <tr>
1.335     nia      13168: <td>PHPCOMMON_MK</td>
1.336     nia      13169: <td>PHPPKGSRCDIR</td>
1.269     leot     13170: </tr>
                   13171: <tr>
1.335     nia      13172: <td>PHP_BASE_VERS</td>
1.336     nia      13173: <td>PHP_CHECK_INSTALLED</td>
1.269     leot     13174: </tr>
                   13175: <tr>
1.335     nia      13176: <td>PHP_EXTENSION_DIR</td>
1.336     nia      13177: <td>PHP_INITIAL_TEENY</td>
1.269     leot     13178: </tr>
                   13179: <tr>
1.335     nia      13180: <td>PHP_PKG_PREFIX</td>
1.336     nia      13181: <td>PHP_VERSION</td>
1.269     leot     13182: </tr>
                   13183: <tr>
1.335     nia      13184: <td>PHP_VERSIONS_ACCEPTED</td>
1.336     nia      13185: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13186: </tr>
                   13187: <tr>
1.335     nia      13188: <td>PHP_VERSION_DEFAULT</td>
1.336     nia      13189: <td>PHP_VERSION_REQD</td>
1.269     leot     13190: </tr>
                   13191: <tr>
1.335     nia      13192: <td>PILRC_USE_GTK</td>
1.336     nia      13193: <td>PKGCONFIG_BASE</td>
1.269     leot     13194: </tr>
                   13195: <tr>
1.335     nia      13196: <td>PKGCONFIG_FILE</td>
1.336     nia      13197: <td>PKGCONFIG_OVERRIDE</td>
1.269     leot     13198: </tr>
                   13199: <tr>
1.335     nia      13200: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.336     nia      13201: <td>PKGDIR</td>
1.269     leot     13202: </tr>
                   13203: <tr>
1.335     nia      13204: <td>PKGGNUDIR</td>
1.336     nia      13205: <td>PKGINFODIR</td>
1.269     leot     13206: </tr>
                   13207: <tr>
1.335     nia      13208: <td>PKGLOCALEDIR</td>
1.336     nia      13209: <td>PKGMANDIR</td>
1.269     leot     13210: </tr>
                   13211: <tr>
1.335     nia      13212: <td>PKGNAME</td>
1.336     nia      13213: <td>PKGNAME_REQD</td>
1.269     leot     13214: </tr>
                   13215: <tr>
1.335     nia      13216: <td>PKGPATH</td>
1.336     nia      13217: <td>PKGREVISION</td>
1.269     leot     13218: </tr>
                   13219: <tr>
1.335     nia      13220: <td>PKGSRC_BLAS_TYPES</td>
1.336     nia      13221: <td>PKGSRC_CHANGES</td>
1.269     leot     13222: </tr>
                   13223: <tr>
1.335     nia      13224: <td>PKGSRC_COMPILER</td>
1.336     nia      13225: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269     leot     13226: </tr>
                   13227: <tr>
1.335     nia      13228: <td>PKGSRC_LOCKTYPE</td>
1.336     nia      13229: <td>PKGSRC_MAKE_ENV</td>
1.292     leot     13230: </tr>
                   13231: <tr>
1.335     nia      13232: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.336     nia      13233: <td>PKGSRC_MKPIE</td>
1.269     leot     13234: </tr>
                   13235: <tr>
1.335     nia      13236: <td>PKGSRC_MKREPRO</td>
1.336     nia      13237: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.274     rillig   13238: </tr>
                   13239: <tr>
1.335     nia      13240: <td>PKGSRC_RUN_TEST</td>
1.336     nia      13241: <td>PKGSRC_SETENV</td>
1.269     leot     13242: </tr>
                   13243: <tr>
1.335     nia      13244: <td>PKGSRC_SLEEPSECS</td>
1.336     nia      13245: <td>PKGSRC_TODO</td>
1.269     leot     13246: </tr>
                   13247: <tr>
1.335     nia      13248: <td>PKGSRC_USE_CTF</td>
1.336     nia      13249: <td>PKGSRC_USE_FORTIFY</td>
1.269     leot     13250: </tr>
                   13251: <tr>
1.335     nia      13252: <td>PKGSRC_USE_RELRO</td>
1.336     nia      13253: <td>PKGSRC_USE_SSP</td>
1.269     leot     13254: </tr>
                   13255: <tr>
1.335     nia      13256: <td>PKGSRC_USE_STACK_CHECK</td>
1.336     nia      13257: <td>PKGTASKS_DATAFILE</td>
1.269     leot     13258: </tr>
                   13259: <tr>
1.335     nia      13260: <td>PKGTOOLS_ARGS</td>
1.336     nia      13261: <td>PKGTOOLS_ENV</td>
1.269     leot     13262: </tr>
                   13263: <tr>
1.335     nia      13264: <td>PKG_ALTERNATIVES</td>
1.336     nia      13265: <td>PKG_APACHE</td>
1.269     leot     13266: </tr>
                   13267: <tr>
1.335     nia      13268: <td>PKG_APACHE_ACCEPTED</td>
1.336     nia      13269: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     13270: </tr>
                   13271: <tr>
1.335     nia      13272: <td>PKG_BEST_EXISTS</td>
1.336     nia      13273: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     13274: </tr>
                   13275: <tr>
1.335     nia      13276: <td>PKG_COMPRESSION</td>
1.336     nia      13277: <td>PKG_CONFIG</td>
1.269     leot     13278: </tr>
                   13279: <tr>
1.335     nia      13280: <td>PKG_CONFIG_PERMS</td>
1.336     nia      13281: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     13282: </tr>
                   13283: <tr>
1.335     nia      13284: <td>PKG_DB_TMPDIR</td>
1.336     nia      13285: <td>PKG_DEBUG_LEVEL</td>
1.269     leot     13286: </tr>
                   13287: <tr>
1.335     nia      13288: <td>PKG_DEFAULT_OPTIONS</td>
1.336     nia      13289: <td>PKG_DESTDIR_SUPPORT</td>
1.269     leot     13290: </tr>
                   13291: <tr>
1.335     nia      13292: <td>PKG_DEVELOPER</td>
1.336     nia      13293: <td>PKG_DISABLED_OPTIONS</td>
1.269     leot     13294: </tr>
                   13295: <tr>
1.335     nia      13296: <td>PKG_FATAL_ERRORS</td>
1.336     nia      13297: <td>PKG_FC</td>
1.269     leot     13298: </tr>
                   13299: <tr>
1.335     nia      13300: <td>PKG_FILELIST_CMD</td>
1.336     nia      13301: <td>PKG_GECOS</td>
1.269     leot     13302: </tr>
                   13303: <tr>
1.335     nia      13304: <td>PKG_GID</td>
1.336     nia      13305: <td>PKG_GROUPS</td>
1.269     leot     13306: </tr>
                   13307: <tr>
1.335     nia      13308: <td>PKG_GROUPS_VARS</td>
1.336     nia      13309: <td>PKG_HOME</td>
1.269     leot     13310: </tr>
                   13311: <tr>
1.335     nia      13312: <td>PKG_INIT_SCRIPTS</td>
1.336     nia      13313: <td>PKG_JAVA_HOME</td>
1.269     leot     13314: </tr>
                   13315: <tr>
1.335     nia      13316: <td>PKG_JVM</td>
1.336     nia      13317: <td>PKG_JVMS_ACCEPTED</td>
1.269     leot     13318: </tr>
                   13319: <tr>
1.335     nia      13320: <td>PKG_JVM_DEFAULT</td>
1.336     nia      13321: <td>PKG_LEGACY_OPTIONS</td>
1.269     leot     13322: </tr>
                   13323: <tr>
1.335     nia      13324: <td>PKG_LIBTOOL</td>
1.336     nia      13325: <td>PKG_OPTIONS</td>
1.269     leot     13326: </tr>
                   13327: <tr>
1.335     nia      13328: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.336     nia      13329: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     13330: </tr>
                   13331: <tr>
1.335     nia      13332: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.336     nia      13333: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     13334: </tr>
                   13335: <tr>
1.335     nia      13336: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.336     nia      13337: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     13338: </tr>
                   13339: <tr>
1.335     nia      13340: <td>PKG_OPTIONS_VAR</td>
1.336     nia      13341: <td>PKG_PHP</td>
1.269     leot     13342: </tr>
                   13343: <tr>
1.335     nia      13344: <td>PKG_PHP_MAJOR_VERS</td>
1.336     nia      13345: <td>PKG_PHP_VERSION</td>
1.269     leot     13346: </tr>
                   13347: <tr>
1.335     nia      13348: <td>PKG_RCD_SCRIPTS</td>
1.336     nia      13349: <td>PKG_REFCOUNT_DBDIR</td>
1.269     leot     13350: </tr>
                   13351: <tr>
1.335     nia      13352: <td>PKG_REGISTER_SHELLS</td>
1.336     nia      13353: <td>PKG_RESUME_TRANSFERS</td>
1.269     leot     13354: </tr>
                   13355: <tr>
1.335     nia      13356: <td>PKG_SHELL</td>
1.336     nia      13357: <td>PKG_SUGGESTED_OPTIONS</td>
1.269     leot     13358: </tr>
                   13359: <tr>
1.335     nia      13360: <td>PKG_SUPPORTED_OPTIONS</td>
1.336     nia      13361: <td>PKG_SYSCONFBASE</td>
1.269     leot     13362: </tr>
                   13363: <tr>
1.335     nia      13364: <td>PKG_SYSCONFBASEDIR</td>
1.336     nia      13365: <td>PKG_SYSCONFDIR</td>
1.269     leot     13366: </tr>
                   13367: <tr>
1.335     nia      13368: <td>PKG_SYSCONFDIR_PERMS</td>
1.336     nia      13369: <td>PKG_SYSCONFSUBDIR</td>
1.269     leot     13370: </tr>
                   13371: <tr>
1.335     nia      13372: <td>PKG_SYSCONFVAR</td>
1.336     nia      13373: <td>PKG_TOOLS_BIN</td>
1.269     leot     13374: </tr>
                   13375: <tr>
1.335     nia      13376: <td>PKG_UID</td>
1.336     nia      13377: <td>PKG_UPDATE_FONTS_DB</td>
1.269     leot     13378: </tr>
                   13379: <tr>
1.335     nia      13380: <td>PKG_USERS</td>
1.336     nia      13381: <td>PKG_USERS_VARS</td>
1.269     leot     13382: </tr>
                   13383: <tr>
1.335     nia      13384: <td>PKG_VERBOSE</td>
1.336     nia      13385: <td>PLEASE</td>
1.269     leot     13386: </tr>
                   13387: <tr>
1.335     nia      13388: <td>PLIST</td>
1.336     nia      13389: <td>PLIST_AWK</td>
1.269     leot     13390: </tr>
                   13391: <tr>
1.335     nia      13392: <td>PLIST_AWK_ENV</td>
1.336     nia      13393: <td>PLIST_SRC</td>
1.269     leot     13394: </tr>
                   13395: <tr>
1.335     nia      13396: <td>PLIST_SUBST</td>
1.336     nia      13397: <td>PLIST_TYPE</td>
1.269     leot     13398: </tr>
                   13399: <tr>
1.335     nia      13400: <td>PLIST_VARS</td>
1.336     nia      13401: <td>POPTOP_USE_MPPE</td>
1.269     leot     13402: </tr>
                   13403: <tr>
1.335     nia      13404: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.336     nia      13405: <td>POST_FETCH_HOOK</td>
1.269     leot     13406: </tr>
                   13407: <tr>
1.335     nia      13408: <td>PREFER</td>
1.336     nia      13409: <td>PREFER_NATIVE</td>
1.269     leot     13410: </tr>
                   13411: <tr>
1.335     nia      13412: <td>PREFER_NATIVE_PTHREADS</td>
1.336     nia      13413: <td>PREFER_PKGSRC</td>
1.269     leot     13414: </tr>
                   13415: <tr>
1.335     nia      13416: <td>PREFIX</td>
1.336     nia      13417: <td>PREPEND_PATH</td>
1.269     leot     13418: </tr>
                   13419: <tr>
1.335     nia      13420: <td>PRE_ROOT_CMD</td>
1.336     nia      13421: <td>PRIVILEGED_STAGES</td>
1.269     leot     13422: </tr>
                   13423: <tr>
1.335     nia      13424: <td>PS</td>
1.336     nia      13425: <td>PTHREAD_AUTO_VARS</td>
1.269     leot     13426: </tr>
                   13427: <tr>
1.335     nia      13428: <td>PTHREAD_CFLAGS</td>
1.336     nia      13429: <td>PTHREAD_LDFLAGS</td>
1.269     leot     13430: </tr>
                   13431: <tr>
1.335     nia      13432: <td>PTHREAD_LIBS</td>
1.336     nia      13433: <td>PTHREAD_OPTS</td>
1.269     leot     13434: </tr>
                   13435: <tr>
1.335     nia      13436: <td>PTHREAD_TYPE</td>
1.336     nia      13437: <td>PVM_SSH</td>
1.269     leot     13438: </tr>
                   13439: <tr>
1.335     nia      13440: <td>PYPKGPREFIX</td>
1.336     nia      13441: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269     leot     13442: </tr>
                   13443: <tr>
1.335     nia      13444: <td>PYTHON_SELF_CONFLICT</td>
1.336     nia      13445: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269     leot     13446: </tr>
                   13447: <tr>
1.335     nia      13448: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.336     nia      13449: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13450: </tr>
                   13451: <tr>
1.335     nia      13452: <td>PYTHON_VERSION_DEFAULT</td>
1.336     nia      13453: <td>PYTHON_VERSION_REQD</td>
1.269     leot     13454: </tr>
                   13455: <tr>
1.335     nia      13456: <td>PYVERSSUFFIX</td>
1.336     nia      13457: <td>QMAILDIR</td>
1.269     leot     13458: </tr>
                   13459: <tr>
1.335     nia      13460: <td>QMAIL_ALIAS_USER</td>
1.336     nia      13461: <td>QMAIL_DAEMON_USER</td>
1.269     leot     13462: </tr>
                   13463: <tr>
1.335     nia      13464: <td>QMAIL_LOG_USER</td>
1.336     nia      13465: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     13466: </tr>
                   13467: <tr>
1.335     nia      13468: <td>QMAIL_PASSWD_USER</td>
1.336     nia      13469: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     13470: </tr>
                   13471: <tr>
1.335     nia      13472: <td>QMAIL_QUEUE_DIR</td>
1.336     nia      13473: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     13474: </tr>
                   13475: <tr>
1.335     nia      13476: <td>QMAIL_QUEUE_USER</td>
1.336     nia      13477: <td>QMAIL_REMOTE_USER</td>
1.269     leot     13478: </tr>
                   13479: <tr>
1.335     nia      13480: <td>QMAIL_ROOT_USER</td>
1.336     nia      13481: <td>QMAIL_SEND_USER</td>
1.269     leot     13482: </tr>
                   13483: <tr>
1.335     nia      13484: <td>QORE_LATEST_MODULE_API</td>
1.336     nia      13485: <td>QORE_MODULE_API</td>
1.269     leot     13486: </tr>
                   13487: <tr>
1.335     nia      13488: <td>QORE_MODULE_DIR</td>
1.336     nia      13489: <td>QORE_USER_MODULE_DIR</td>
1.333     nia      13490: </tr>
                   13491: <tr>
1.335     nia      13492: <td>QORE_VERSION</td>
1.336     nia      13493: <td>QPOPPER_FAC</td>
1.333     nia      13494: </tr>
                   13495: <tr>
1.335     nia      13496: <td>QPOPPER_SPOOL_DIR</td>
1.336     nia      13497: <td>QPOPPER_USER</td>
1.333     nia      13498: </tr>
                   13499: <tr>
1.335     nia      13500: <td>RAKE_NAME</td>
1.336     nia      13501: <td>RASMOL_DEPTH</td>
1.269     leot     13502: </tr>
                   13503: <tr>
1.338   ! nia      13504: <td>RCD_DIR</td>
        !          13505: <td>RCD_ORDER</td>
        !          13506: </tr>
        !          13507: <tr>
1.335     nia      13508: <td>RCD_SCRIPTS</td>
1.336     nia      13509: <td>RCD_SCRIPTS_DIR</td>
1.329     leot     13510: </tr>
                   13511: <tr>
1.335     nia      13512: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.336     nia      13513: <td>RCD_SCRIPTS_MODE</td>
1.332     rillig   13514: </tr>
                   13515: <tr>
1.335     nia      13516: <td>RCD_SCRIPTS_SHELL</td>
1.336     nia      13517: <td>RCD_SCRIPT_SRC</td>
1.320     wiz      13518: </tr>
                   13519: <tr>
1.338   ! nia      13520: <td>RCD_SUBR</td>
1.336     nia      13521: <td>RDOC</td>
1.338   ! nia      13522: </tr>
        !          13523: <tr>
1.337     gutterid 13524: <td>READLINE_DEFAULT</td>
1.338   ! nia      13525: <td>READLINE_TYPE</td>
1.292     leot     13526: </tr>
                   13527: <tr>
1.337     gutterid 13528: <td>REAL_ROOT_GROUP</td>
1.338   ! nia      13529: <td>REAL_ROOT_USER</td>
1.329     leot     13530: </tr>
                   13531: <tr>
1.337     gutterid 13532: <td>RECURSIVE_MAKE</td>
1.338   ! nia      13533: <td>RELAY_CTRL_DIR</td>
1.327     wiz      13534: </tr>
                   13535: <tr>
1.337     gutterid 13536: <td>RELRO_SUPPORTED</td>
1.338   ! nia      13537: <td>REPLACE_AWK</td>
1.269     leot     13538: </tr>
                   13539: <tr>
1.337     gutterid 13540: <td>REPLACE_BASH</td>
1.338   ! nia      13541: <td>REPLACE_CSH</td>
1.320     wiz      13542: </tr>
                   13543: <tr>
1.337     gutterid 13544: <td>REPLACE_KSH</td>
1.338   ! nia      13545: <td>REPLACE_LUA</td>
1.311     leot     13546: </tr>
                   13547: <tr>
1.337     gutterid 13548: <td>REPLACE_NODEJS</td>
1.338   ! nia      13549: <td>REPLACE_OCTAVE</td>
1.269     leot     13550: </tr>
                   13551: <tr>
1.337     gutterid 13552: <td>REPLACE_PERL</td>
1.338   ! nia      13553: <td>REPLACE_PERL6</td>
1.333     nia      13554: </tr>
                   13555: <tr>
1.337     gutterid 13556: <td>REPLACE_PHP</td>
1.338   ! nia      13557: <td>REPLACE_PYTHON</td>
1.269     leot     13558: </tr>
                   13559: <tr>
1.337     gutterid 13560: <td>REPLACE_QORE</td>
1.338   ! nia      13561: <td>REPLACE_R</td>
1.331     gutterid 13562: </tr>
                   13563: <tr>
1.337     gutterid 13564: <td>REPLACE_RUBY</td>
1.338   ! nia      13565: <td>REPLACE_RUBY_DIRS</td>
1.269     leot     13566: </tr>
                   13567: <tr>
1.337     gutterid 13568: <td>REPLACE_RUBY_PAT</td>
1.338   ! nia      13569: <td>REPLACE_SH</td>
1.333     nia      13570: </tr>
                   13571: <tr>
1.337     gutterid 13572: <td>REPLACE_TEXLUA</td>
1.338   ! nia      13573: <td>REPLACE_WISH</td>
1.269     leot     13574: </tr>
                   13575: <tr>
1.337     gutterid 13576: <td>REQD_DIRS</td>
1.338   ! nia      13577: <td>REQD_DIRS_PERMS</td>
1.269     leot     13578: </tr>
                   13579: <tr>
1.337     gutterid 13580: <td>REQD_FILES</td>
1.338   ! nia      13581: <td>REQD_FILES_MODE</td>
1.269     leot     13582: </tr>
                   13583: <tr>
1.337     gutterid 13584: <td>REQD_FILES_PERMS</td>
1.338   ! nia      13585: <td>RESOLV_AUTO_VARS</td>
1.269     leot     13586: </tr>
                   13587: <tr>
1.337     gutterid 13588: <td>RESOLV_LDFLAGS</td>
1.338   ! nia      13589: <td>RESOLV_LIBS</td>
1.281     leot     13590: </tr>
                   13591: <tr>
1.335     nia      13592: <td>RM</td>
1.338   ! nia      13593: <td>ROCKSPEC_NAME</td>
1.269     leot     13594: </tr>
                   13595: <tr>
1.338   ! nia      13596: <td>ROCKSPEC_SPECFILE</td>
1.336     nia      13597: <td>ROOT_CMD</td>
1.320     wiz      13598: </tr>
                   13599: <tr>
1.338   ! nia      13600: <td>ROOT_GROUP</td>
1.336     nia      13601: <td>ROOT_USER</td>
1.332     rillig   13602: </tr>
                   13603: <tr>
1.338   ! nia      13604: <td>RPCGEN</td>
1.336     nia      13605: <td>RPM</td>
1.329     leot     13606: </tr>
                   13607: <tr>
1.338   ! nia      13608: <td>RPM2PKG_PLIST</td>
1.336     nia      13609: <td>RPM2PKG_PREFIX</td>
1.327     wiz      13610: </tr>
                   13611: <tr>
1.338   ! nia      13612: <td>RPM2PKG_STAGE</td>
1.336     nia      13613: <td>RPM2PKG_STRIP</td>
1.269     leot     13614: </tr>
                   13615: <tr>
1.338   ! nia      13616: <td>RPM2PKG_SUBPREFIX</td>
1.336     nia      13617: <td>RPMFILES</td>
1.311     leot     13618: </tr>
                   13619: <tr>
1.338   ! nia      13620: <td>RPMIGNOREPATH</td>
1.336     nia      13621: <td>RPM_DB_PREFIX</td>
1.269     leot     13622: </tr>
                   13623: <tr>
1.338   ! nia      13624: <td>RSSH_CVS_PATH</td>
1.336     nia      13625: <td>RSSH_RDIST_PATH</td>
1.269     leot     13626: </tr>
                   13627: <tr>
1.338   ! nia      13628: <td>RSSH_RSYNC_PATH</td>
1.336     nia      13629: <td>RSSH_SCP_PATH</td>
1.269     leot     13630: </tr>
                   13631: <tr>
1.338   ! nia      13632: <td>RSSH_SFTP_SERVER_PATH</td>
1.336     nia      13633: <td>RUBY</td>
1.269     leot     13634: </tr>
                   13635: <tr>
1.338   ! nia      13636: <td>RUBYGEM</td>
1.336     nia      13637: <td>RUBYGEM_NAME</td>
1.269     leot     13638: </tr>
                   13639: <tr>
1.338   ! nia      13640: <td>RUBYGEM_OPTIONS</td>
1.336     nia      13641: <td>RUBYGEM_VERBOSE</td>
1.269     leot     13642: </tr>
                   13643: <tr>
1.338   ! nia      13644: <td>RUBY_ABI_VERSION</td>
1.336     nia      13645: <td>RUBY_ARCH</td>
1.269     leot     13646: </tr>
                   13647: <tr>
1.338   ! nia      13648: <td>RUBY_ARCHINC</td>
1.336     nia      13649: <td>RUBY_ARCHLIB</td>
1.269     leot     13650: </tr>
                   13651: <tr>
1.338   ! nia      13652: <td>RUBY_BASE</td>
1.336     nia      13653: <td>RUBY_BASERIDIR</td>
1.269     leot     13654: </tr>
                   13655: <tr>
1.338   ! nia      13656: <td>RUBY_BUILD_DOCUMENT</td>
1.336     nia      13657: <td>RUBY_DLEXT</td>
1.269     leot     13658: </tr>
                   13659: <tr>
1.338   ! nia      13660: <td>RUBY_DOC</td>
1.336     nia      13661: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     13662: </tr>
                   13663: <tr>
1.338   ! nia      13664: <td>RUBY_EG</td>
1.336     nia      13665: <td>RUBY_ENCODING_ARG</td>
1.269     leot     13666: </tr>
                   13667: <tr>
1.338   ! nia      13668: <td>RUBY_EXTCONF</td>
1.336     nia      13669: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     13670: </tr>
                   13671: <tr>
1.338   ! nia      13672: <td>RUBY_EXTCONF_DEBUG</td>
1.336     nia      13673: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     13674: </tr>
                   13675: <tr>
1.338   ! nia      13676: <td>RUBY_GEM_ARCH</td>
1.336     nia      13677: <td>RUBY_GEM_BASE</td>
1.269     leot     13678: </tr>
                   13679: <tr>
1.338   ! nia      13680: <td>RUBY_INC</td>
1.336     nia      13681: <td>RUBY_LIB</td>
1.338   ! nia      13682: </tr>
        !          13683: <tr>
1.337     gutterid 13684: <td>RUBY_LIB_BASE</td>
1.338   ! nia      13685: <td>RUBY_NAME</td>
1.269     leot     13686: </tr>
                   13687: <tr>
1.337     gutterid 13688: <td>RUBY_NOVERSION</td>
1.338   ! nia      13689: <td>RUBY_PKGPREFIX</td>
1.269     leot     13690: </tr>
                   13691: <tr>
1.337     gutterid 13692: <td>RUBY_RAILS</td>
1.338   ! nia      13693: <td>RUBY_RAILS52_VERSION</td>
1.269     leot     13694: </tr>
                   13695: <tr>
1.337     gutterid 13696: <td>RUBY_RAILS60_VERSION</td>
1.338   ! nia      13697: <td>RUBY_RAILS61_VERSION</td>
1.269     leot     13698: </tr>
                   13699: <tr>
1.337     gutterid 13700: <td>RUBY_RAILS70_VERSION</td>
1.338   ! nia      13701: <td>RUBY_RAILS_ACCEPTED</td>
1.269     leot     13702: </tr>
                   13703: <tr>
1.337     gutterid 13704: <td>RUBY_RAILS_DEFAULT</td>
1.338   ! nia      13705: <td>RUBY_RAILS_REQD</td>
1.269     leot     13706: </tr>
                   13707: <tr>
1.337     gutterid 13708: <td>RUBY_RAILS_STRICT_DEP</td>
1.338   ! nia      13709: <td>RUBY_RIDIR</td>
1.269     leot     13710: </tr>
                   13711: <tr>
1.337     gutterid 13712: <td>RUBY_SETUP</td>
1.338   ! nia      13713: <td>RUBY_SHLIB</td>
1.269     leot     13714: </tr>
                   13715: <tr>
1.337     gutterid 13716: <td>RUBY_SHLIBALIAS</td>
1.338   ! nia      13717: <td>RUBY_SHLIBVER</td>
1.312     gdt      13718: </tr>
                   13719: <tr>
1.337     gutterid 13720: <td>RUBY_SIMPLE_INSTALL</td>
1.338   ! nia      13721: <td>RUBY_SITEARCHLIB</td>
1.289     leot     13722: </tr>
                   13723: <tr>
1.337     gutterid 13724: <td>RUBY_SITELIB</td>
1.338   ! nia      13725: <td>RUBY_SITELIB_BASE</td>
1.269     leot     13726: </tr>
                   13727: <tr>
1.337     gutterid 13728: <td>RUBY_SITERIDIR</td>
1.338   ! nia      13729: <td>RUBY_SLEXT</td>
1.269     leot     13730: </tr>
                   13731: <tr>
1.337     gutterid 13732: <td>RUBY_SRCDIR</td>
1.338   ! nia      13733: <td>RUBY_STATICLIB</td>
1.269     leot     13734: </tr>
                   13735: <tr>
1.337     gutterid 13736: <td>RUBY_SUFFIX</td>
1.338   ! nia      13737: <td>RUBY_SYSRIDIR</td>
1.269     leot     13738: </tr>
                   13739: <tr>
1.337     gutterid 13740: <td>RUBY_USE_PTHREAD</td>
1.338   ! nia      13741: <td>RUBY_VENDORARCHLIB</td>
1.269     leot     13742: </tr>
                   13743: <tr>
1.337     gutterid 13744: <td>RUBY_VENDORLIB</td>
1.338   ! nia      13745: <td>RUBY_VENDORLIB_BASE</td>
1.269     leot     13746: </tr>
                   13747: <tr>
1.337     gutterid 13748: <td>RUBY_VER</td>
1.338   ! nia      13749: <td>RUBY_VERSION</td>
1.269     leot     13750: </tr>
                   13751: <tr>
1.337     gutterid 13752: <td>RUBY_VERSIONS_ACCEPTED</td>
1.338   ! nia      13753: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13754: </tr>
                   13755: <tr>
1.337     gutterid 13756: <td>RUBY_VERSION_DEFAULT</td>
1.338   ! nia      13757: <td>RUBY_VERSION_REQD</td>
1.269     leot     13758: </tr>
                   13759: <tr>
1.337     gutterid 13760: <td>RUBY_VER_DIR</td>
1.338   ! nia      13761: <td>RUN</td>
1.269     leot     13762: </tr>
                   13763: <tr>
1.337     gutterid 13764: <td>RUN_LDCONFIG</td>
1.338   ! nia      13765: <td>RUST_TYPE</td>
1.269     leot     13766: </tr>
                   13767: <tr>
1.337     gutterid 13768: <td>SCO</td>
1.338   ! nia      13769: <td>SCREWS_GROUP</td>
1.269     leot     13770: </tr>
                   13771: <tr>
1.333     nia      13772: <td>SCREWS_USER</td>
1.338   ! nia      13773: <td>SCRIPTS_ENV</td>
1.269     leot     13774: </tr>
                   13775: <tr>
1.333     nia      13776: <td>SCROLLKEEPER_DATADIR</td>
1.338   ! nia      13777: <td>SCROLLKEEPER_REBUILDDB</td>
1.269     leot     13778: </tr>
                   13779: <tr>
1.333     nia      13780: <td>SCROLLKEEPER_UPDATEDB</td>
1.338   ! nia      13781: <td>SDIST_PAWD</td>
1.269     leot     13782: </tr>
                   13783: <tr>
1.336     nia      13784: <td>SDL12_TYPE</td>
1.338   ! nia      13785: <td>SERIAL_DEVICES</td>
1.336     nia      13786: </tr>
                   13787: <tr>
1.335     nia      13788: <td>SETGIDGAME</td>
1.338   ! nia      13789: <td>SETGID_GAMES_PERMS</td>
1.269     leot     13790: </tr>
                   13791: <tr>
1.335     nia      13792: <td>SETUID_ROOT_PERMS</td>
1.338   ! nia      13793: <td>SH</td>
1.269     leot     13794: </tr>
                   13795: <tr>
1.335     nia      13796: <td>SHLIB</td>
1.338   ! nia      13797: <td>SHORTNAME</td>
1.269     leot     13798: </tr>
                   13799: <tr>
1.335     nia      13800: <td>SIGN_PACKAGES</td>
1.336     nia      13801: <td>SILC_CLIENT_WITH_PERL</td>
1.269     leot     13802: </tr>
                   13803: <tr>
1.335     nia      13804: <td>SITE_SPECIFIC_PKGS</td>
1.336     nia      13805: <td>SKIP_DEPENDS</td>
1.292     leot     13806: </tr>
                   13807: <tr>
1.335     nia      13808: <td>SMF_INSTANCES</td>
1.336     nia      13809: <td>SMF_MANIFEST</td>
1.269     leot     13810: </tr>
                   13811: <tr>
1.335     nia      13812: <td>SMF_METHODS</td>
1.336     nia      13813: <td>SMF_METHOD_SHELL</td>
1.332     rillig   13814: </tr>
                   13815: <tr>
1.335     nia      13816: <td>SMF_METHOD_SRC</td>
1.336     nia      13817: <td>SMF_NAME</td>
1.269     leot     13818: </tr>
                   13819: <tr>
1.335     nia      13820: <td>SMF_PREFIX</td>
1.336     nia      13821: <td>SMF_SRCDIR</td>
1.274     rillig   13822: </tr>
                   13823: <tr>
1.335     nia      13824: <td>SNIPROXY_GROUP</td>
1.336     nia      13825: <td>SNIPROXY_USER</td>
1.269     leot     13826: </tr>
                   13827: <tr>
1.335     nia      13828: <td>SOURCE_BUFFSIZE</td>
1.336     nia      13829: <td>SPECIAL_PERMS</td>
1.269     leot     13830: </tr>
                   13831: <tr>
1.335     nia      13832: <td>SPECIFIC_PKGS</td>
1.336     nia      13833: <td>SSH_SUID</td>
1.269     leot     13834: </tr>
                   13835: <tr>
1.335     nia      13836: <td>SSP_SUPPORTED</td>
1.336     nia      13837: <td>SSYNC_PAWD</td>
1.269     leot     13838: </tr>
                   13839: <tr>
1.335     nia      13840: <td>STEP_MSG</td>
1.336     nia      13841: <td>STRIP</td>
1.269     leot     13842: </tr>
                   13843: <tr>
1.335     nia      13844: <td>STRIP_DBG</td>
1.336     nia      13845: <td>STRIP_DEBUG</td>
1.269     leot     13846: </tr>
                   13847: <tr>
1.335     nia      13848: <td>STRIP_DEBUG_SUPPORTED</td>
1.336     nia      13849: <td>STRIP_FILES_SKIP</td>
1.269     leot     13850: </tr>
                   13851: <tr>
1.335     nia      13852: <td>SU</td>
1.336     nia      13853: <td>SUBDIR</td>
1.269     leot     13854: </tr>
                   13855: <tr>
1.335     nia      13856: <td>SUBST</td>
1.336     nia      13857: <td>SUBST_CLASSES</td>
1.269     leot     13858: </tr>
                   13859: <tr>
1.335     nia      13860: <td>SUBST_FILES</td>
1.336     nia      13861: <td>SUBST_FILTER_CMD</td>
1.269     leot     13862: </tr>
                   13863: <tr>
1.335     nia      13864: <td>SUBST_MESSAGE</td>
1.336     nia      13865: <td>SUBST_NOOP_OK</td>
1.269     leot     13866: </tr>
                   13867: <tr>
1.335     nia      13868: <td>SUBST_SED</td>
1.336     nia      13869: <td>SUBST_SHOW_DIFF</td>
1.289     leot     13870: </tr>
                   13871: <tr>
1.335     nia      13872: <td>SUBST_SKIP_TEXT_CHECK</td>
1.336     nia      13873: <td>SUBST_STAGE</td>
1.269     leot     13874: </tr>
                   13875: <tr>
1.335     nia      13876: <td>SUBST_VARS</td>
1.336     nia      13877: <td>SUNWSPROBASE</td>
1.269     leot     13878: </tr>
                   13879: <tr>
1.335     nia      13880: <td>SUSE_PREFER</td>
1.336     nia      13881: <td>SU_CMD</td>
1.269     leot     13882: </tr>
                   13883: <tr>
1.338   ! nia      13884: <td>SVN_EXTRACTDIR</td>
        !          13885: <td>SVN_REPO</td>
        !          13886: </tr>
        !          13887: <tr>
        !          13888: <td>SVN_REPOSITORIES</td>
        !          13889: <td>SVN_REVISION</td>
        !          13890: </tr>
        !          13891: <tr>
1.337     gutterid 13892: <td>SYSCONFBASE</td>
                   13893: <td>TARGET_ARCH</td>
1.332     rillig   13894: </tr>
                   13895: <tr>
1.336     nia      13896: <td>TBL</td>
1.337     gutterid 13897: <td>TERMCAP_TYPE</td>
1.327     wiz      13898: </tr>
                   13899: <tr>
1.336     nia      13900: <td>TERMINFO_DEFAULT</td>
1.337     gutterid 13901: <td>TERMINFO_TYPE</td>
1.332     rillig   13902: </tr>
                   13903: <tr>
1.336     nia      13904: <td>TEST</td>
1.337     gutterid 13905: <td>TEST_DEPENDS</td>
1.320     wiz      13906: </tr>
                   13907: <tr>
1.336     nia      13908: <td>TEST_DIRS</td>
1.337     gutterid 13909: <td>TEST_ENV</td>
1.303     bacon    13910: </tr>
                   13911: <tr>
1.336     nia      13912: <td>TEST_ENV_SHELL</td>
1.337     gutterid 13913: <td>TEST_MAKE_CMD</td>
1.274     rillig   13914: </tr>
                   13915: <tr>
1.336     nia      13916: <td>TEST_MAKE_FLAGS</td>
1.337     gutterid 13917: <td>TEST_TARGET</td>
1.269     leot     13918: </tr>
                   13919: <tr>
1.336     nia      13920: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.337     gutterid 13921: <td>TEXLIVE_REV</td>
1.269     leot     13922: </tr>
                   13923: <tr>
1.336     nia      13924: <td>TEXLIVE_UNVERSIONED</td>
1.337     gutterid 13925: <td>TEXMFSITE</td>
1.269     leot     13926: </tr>
                   13927: <tr>
1.336     nia      13928: <td>TEX_FORMATS</td>
1.337     gutterid 13929: <td>TEX_HYPHEN_DAT</td>
1.269     leot     13930: </tr>
                   13931: <tr>
1.336     nia      13932: <td>TEX_HYPHEN_DEF</td>
1.337     gutterid 13933: <td>TEX_TEXMF_DIRS</td>
1.269     leot     13934: </tr>
                   13935: <tr>
1.336     nia      13936: <td>THTTPD_LOG_FACILITY</td>
1.337     gutterid 13937: <td>TINYDYN_USER</td>
1.269     leot     13938: </tr>
                   13939: <tr>
1.336     nia      13940: <td>TLSWRAPPER_CHROOT</td>
1.337     gutterid 13941: <td>TO</td>
1.269     leot     13942: </tr>
                   13943: <tr>
1.336     nia      13944: <td>TOOLS_ALIASES</td>
1.337     gutterid 13945: <td>TOOLS_ALWAYS_WRAP</td>
1.269     leot     13946: </tr>
                   13947: <tr>
1.336     nia      13948: <td>TOOLS_ARGS</td>
1.337     gutterid 13949: <td>TOOLS_BROKEN</td>
1.269     leot     13950: </tr>
                   13951: <tr>
1.336     nia      13952: <td>TOOLS_CMD</td>
1.337     gutterid 13953: <td>TOOLS_CMDLINE_SED</td>
1.269     leot     13954: </tr>
                   13955: <tr>
1.336     nia      13956: <td>TOOLS_CREATE</td>
1.337     gutterid 13957: <td>TOOLS_CROSS_DESTDIR</td>
1.269     leot     13958: </tr>
                   13959: <tr>
1.335     nia      13960: <td>TOOLS_DIR</td>
1.336     nia      13961: <td>TOOLS_FAIL</td>
1.269     leot     13962: </tr>
                   13963: <tr>
1.335     nia      13964: <td>TOOLS_GNU_MISSING</td>
1.336     nia      13965: <td>TOOLS_LDCONFIG</td>
1.269     leot     13966: </tr>
                   13967: <tr>
1.335     nia      13968: <td>TOOLS_NOOP</td>
1.336     nia      13969: <td>TOOLS_PATH</td>
1.269     leot     13970: </tr>
                   13971: <tr>
1.335     nia      13972: <td>TOOLS_SCRIPT</td>
1.337     gutterid 13973: <td>TOOLS_USE_CROSS_COMPILE</td>
1.269     leot     13974: </tr>
                   13975: <tr>
1.337     gutterid 13976: <td>TOOL_DEPENDS</td>
1.338   ! nia      13977: <td>TTF_FONTDIR</td>
        !          13978: </tr>
        !          13979: <tr>
1.336     nia      13980: <td>TTF_FONTS_DIR</td>
1.338   ! nia      13981: <td>TYPE</td>
1.269     leot     13982: </tr>
                   13983: <tr>
1.336     nia      13984: <td>UAC_REQD_EXECS</td>
1.338   ! nia      13985: <td>UCSPI_SSL_GROUP</td>
1.329     leot     13986: </tr>
                   13987: <tr>
1.336     nia      13988: <td>UCSPI_SSL_USER</td>
1.338   ! nia      13989: <td>UNLIMIT_RESOURCES</td>
1.327     wiz      13990: </tr>
                   13991: <tr>
1.336     nia      13992: <td>UNPRIVILEGED</td>
1.338   ! nia      13993: <td>UNPRIVILEGED_GROUP</td>
1.269     leot     13994: </tr>
                   13995: <tr>
1.336     nia      13996: <td>UNPRIVILEGED_GROUPS</td>
1.338   ! nia      13997: <td>UNPRIVILEGED_USER</td>
1.269     leot     13998: </tr>
                   13999: <tr>
1.336     nia      14000: <td>UNWRAP_FILES</td>
1.338   ! nia      14001: <td>UNWRAP_PATTERNS</td>
1.269     leot     14002: </tr>
                   14003: <tr>
1.336     nia      14004: <td>UPDATE_GEMSPEC</td>
1.338   ! nia      14005: <td>UPDATE_TARGET</td>
1.269     leot     14006: </tr>
                   14007: <tr>
1.336     nia      14008: <td>URI</td>
1.338   ! nia      14009: <td>USERGROUP_PHASE</td>
1.269     leot     14010: </tr>
                   14011: <tr>
1.336     nia      14012: <td>USERPPP_GROUP</td>
1.338   ! nia      14013: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     14014: </tr>
                   14015: <tr>
1.336     nia      14016: <td>USE_ABI_DEPENDS</td>
1.338   ! nia      14017: <td>USE_APR</td>
1.269     leot     14018: </tr>
                   14019: <tr>
1.336     nia      14020: <td>USE_BSD_MAKEFILE</td>
1.338   ! nia      14021: <td>USE_BUILTIN</td>
1.269     leot     14022: </tr>
                   14023: <tr>
1.336     nia      14024: <td>USE_CROSS_COMPILE</td>
1.338   ! nia      14025: <td>USE_CURSES</td>
1.269     leot     14026: </tr>
                   14027: <tr>
1.336     nia      14028: <td>USE_CWRAPPERS</td>
1.338   ! nia      14029: <td>USE_DB185</td>
1.320     wiz      14030: </tr>
                   14031: <tr>
1.336     nia      14032: <td>USE_FEATURES</td>
1.338   ! nia      14033: <td>USE_GAMESGROUP</td>
1.269     leot     14034: </tr>
                   14035: <tr>
1.336     nia      14036: <td>USE_GCC_RUNTIME</td>
1.338   ! nia      14037: <td>USE_IMAKE</td>
1.269     leot     14038: </tr>
                   14039: <tr>
1.336     nia      14040: <td>USE_JAVA</td>
1.338   ! nia      14041: <td>USE_JAVA2</td>
1.269     leot     14042: </tr>
                   14043: <tr>
1.336     nia      14044: <td>USE_LANGUAGES</td>
1.338   ! nia      14045: <td>USE_LIBTOOL</td>
1.269     leot     14046: </tr>
                   14047: <tr>
1.336     nia      14048: <td>USE_NATIVE_GCC</td>
1.338   ! nia      14049: <td>USE_NETBSD_REPO</td>
1.269     leot     14050: </tr>
                   14051: <tr>
1.336     nia      14052: <td>USE_PKGSRC_GCC</td>
1.338   ! nia      14053: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     14054: </tr>
                   14055: <tr>
1.336     nia      14056: <td>USE_PKGTASKS</td>
1.338   ! nia      14057: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     14058: </tr>
                   14059: <tr>
1.336     nia      14060: <td>USE_RUBY_EXTCONF</td>
1.338   ! nia      14061: <td>USE_RUBY_INSTALL</td>
1.269     leot     14062: </tr>
                   14063: <tr>
1.336     nia      14064: <td>USE_RUBY_SETUP</td>
1.338   ! nia      14065: <td>USE_RUBY_SETUP_PKG</td>
1.269     leot     14066: </tr>
                   14067: <tr>
1.336     nia      14068: <td>USE_TOOLS</td>
1.338   ! nia      14069: <td>UUCP_GROUP</td>
1.269     leot     14070: </tr>
                   14071: <tr>
1.336     nia      14072: <td>UUCP_USER</td>
1.338   ! nia      14073: <td>VARBASE</td>
1.269     leot     14074: </tr>
                   14075: <tr>
1.336     nia      14076: <td>VARNAME</td>
1.338   ! nia      14077: <td>VIM_EXTRA_OPTS</td>
1.269     leot     14078: </tr>
                   14079: <tr>
1.336     nia      14080: <td>WARNING_MSG</td>
1.338   ! nia      14081: <td>WCALC_CGIDIR</td>
1.269     leot     14082: </tr>
                   14083: <tr>
1.336     nia      14084: <td>WCALC_CGIPATH</td>
1.338   ! nia      14085: <td>WCALC_HTMLDIR</td>
1.269     leot     14086: </tr>
                   14087: <tr>
1.336     nia      14088: <td>WCALC_HTMLPATH</td>
1.338   ! nia      14089: <td>WDM_MANAGERS</td>
1.269     leot     14090: </tr>
                   14091: <tr>
1.336     nia      14092: <td>WRAPPER_CC</td>
1.338   ! nia      14093: <td>WRAPPER_REORDER_CMDS</td>
1.269     leot     14094: </tr>
                   14095: <tr>
1.336     nia      14096: <td>WRKDIR</td>
1.338   ! nia      14097: <td>WRKDIR_BASENAME</td>
1.269     leot     14098: </tr>
                   14099: <tr>
1.336     nia      14100: <td>WRKDIR_LOCKTYPE</td>
1.338   ! nia      14101: <td>WRKLOG</td>
1.269     leot     14102: </tr>
                   14103: <tr>
1.336     nia      14104: <td>WRKOBJDIR</td>
1.338   ! nia      14105: <td>WRKSRC</td>
1.269     leot     14106: </tr>
                   14107: <tr>
1.336     nia      14108: <td>X10_PORT</td>
1.338   ! nia      14109: <td>X11</td>
1.303     bacon    14110: </tr>
                   14111: <tr>
1.336     nia      14112: <td>X11BASE</td>
1.338   ! nia      14113: <td>X11_PKGSRCDIR</td>
1.269     leot     14114: </tr>
                   14115: <tr>
1.336     nia      14116: <td>X11_TYPE</td>
1.338   ! nia      14117: <td>X509_CERTIFICATE</td>
1.269     leot     14118: </tr>
                   14119: <tr>
1.336     nia      14120: <td>X509_KEY</td>
1.338   ! nia      14121: <td>XAW_TYPE</td>
1.269     leot     14122: </tr>
                   14123: <tr>
1.336     nia      14124: <td>XLOCK_DEFAULT_MODE</td>
1.338   ! nia      14125: <td>XMKMF</td>
1.269     leot     14126: </tr>
                   14127: <tr>
1.336     nia      14128: <td>XMKMF_FLAGS</td>
1.338   ! nia      14129: <td>XXX</td>
1.269     leot     14130: </tr>
                   14131: <tr>
1.338   ! nia      14132: <td>XXXX</td>
1.337     gutterid 14133: <td>YES</td>
1.269     leot     14134: </tr>
                   14135: <tr>
1.336     nia      14136: <td>ZSH_STATIC</td>
1.337     gutterid 14137: <td>__stdc__</td>
1.274     rillig   14138: </tr>
                   14139: <tr>
1.336     nia      14140: <td>_vargroups</td>
1.337     gutterid 14141: <td>accept</td>
1.332     rillig   14142: </tr>
                   14143: <tr>
1.336     nia      14144: <td>acquire-localbase-lock</td>
1.337     gutterid 14145: <td>acquire-lock</td>
1.269     leot     14146: </tr>
                   14147: <tr>
1.336     nia      14148: <td>add</td>
1.337     gutterid 14149: <td>administrator</td>
1.316     cirnatda 14150: </tr>
                   14151: <tr>
1.336     nia      14152: <td>alloca</td>
1.337     gutterid 14153: <td>alternatives</td>
1.289     leot     14154: </tr>
                   14155: <tr>
1.336     nia      14156: <td>aslr</td>
1.337     gutterid 14157: <td>asprintf</td>
1.269     leot     14158: </tr>
                   14159: <tr>
1.336     nia      14160: <td>atlas</td>
1.337     gutterid 14161: <td>autoconf</td>
1.269     leot     14162: </tr>
                   14163: <tr>
1.336     nia      14164: <td>automake</td>
1.337     gutterid 14165: <td>autoreconf</td>
1.289     leot     14166: </tr>
                   14167: <tr>
1.336     nia      14168: <td>awk</td>
1.337     gutterid 14169: <td>bash</td>
1.269     leot     14170: </tr>
                   14171: <tr>
1.336     nia      14172: <td>big-endian</td>
1.337     gutterid 14173: <td>bin-install</td>
1.269     leot     14174: </tr>
                   14175: <tr>
1.336     nia      14176: <td>bind</td>
1.337     gutterid 14177: <td>binpkg-list</td>
1.269     leot     14178: </tr>
                   14179: <tr>
1.336     nia      14180: <td>blas</td>
1.337     gutterid 14181: <td>bootstrap-depends</td>
1.271     brook    14182: </tr>
                   14183: <tr>
1.336     nia      14184: <td>broken</td>
1.337     gutterid 14185: <td>broken_on_platform</td>
1.269     leot     14186: </tr>
                   14187: <tr>
1.336     nia      14188: <td>bsd</td>
1.337     gutterid 14189: <td>bsd.prog.mk</td>
1.292     leot     14190: </tr>
                   14191: <tr>
1.336     nia      14192: <td>build</td>
1.337     gutterid 14193: <td>build-env</td>
1.274     rillig   14194: </tr>
                   14195: <tr>
1.336     nia      14196: <td>buildlink-directories</td>
1.337     gutterid 14197: <td>buildlink-oss-soundcard-h</td>
1.269     leot     14198: </tr>
                   14199: <tr>
1.336     nia      14200: <td>c</td>
1.337     gutterid 14201: <td>c++</td>
1.289     leot     14202: </tr>
                   14203: <tr>
1.336     nia      14204: <td>ccache</td>
1.337     gutterid 14205: <td>cce</td>
1.269     leot     14206: </tr>
                   14207: <tr>
1.336     nia      14208: <td>cdefs</td>
1.337     gutterid 14209: <td>ceil</td>
1.269     leot     14210: </tr>
                   14211: <tr>
1.336     nia      14212: <td>changes</td>
1.337     gutterid 14213: <td>changes-entry</td>
1.269     leot     14214: </tr>
                   14215: <tr>
1.336     nia      14216: <td>changes-entry-noupdate</td>
1.337     gutterid 14217: <td>check</td>
1.269     leot     14218: </tr>
                   14219: <tr>
1.336     nia      14220: <td>check-clean</td>
1.337     gutterid 14221: <td>check-files</td>
1.289     leot     14222: </tr>
                   14223: <tr>
1.336     nia      14224: <td>check-files-clean</td>
1.337     gutterid 14225: <td>check-vulnerable</td>
1.269     leot     14226: </tr>
                   14227: <tr>
1.336     nia      14228: <td>checksum</td>
1.337     gutterid 14229: <td>checksum-phase</td>
1.269     leot     14230: </tr>
                   14231: <tr>
1.336     nia      14232: <td>clean</td>
1.337     gutterid 14233: <td>clean-depends</td>
1.269     leot     14234: </tr>
                   14235: <tr>
1.336     nia      14236: <td>cleandir</td>
1.337     gutterid 14237: <td>commit</td>
1.269     leot     14238: </tr>
                   14239: <tr>
1.336     nia      14240: <td>commit-changes-entry</td>
1.337     gutterid 14241: <td>compact</td>
1.269     leot     14242: </tr>
                   14243: <tr>
1.336     nia      14244: <td>compiler</td>
1.337     gutterid 14245: <td>conf</td>
1.269     leot     14246: </tr>
                   14247: <tr>
1.336     nia      14248: <td>config.guess</td>
1.337     gutterid 14249: <td>config.sub</td>
1.269     leot     14250: </tr>
                   14251: <tr>
1.336     nia      14252: <td>configuration</td>
1.337     gutterid 14253: <td>configure</td>
1.269     leot     14254: </tr>
                   14255: <tr>
1.336     nia      14256: <td>configure-env</td>
1.337     gutterid 14257: <td>configure-help</td>
1.269     leot     14258: </tr>
                   14259: <tr>
1.336     nia      14260: <td>configure_args</td>
1.337     gutterid 14261: <td>connect</td>
1.269     leot     14262: </tr>
                   14263: <tr>
1.336     nia      14264: <td>cos</td>
1.337     gutterid 14265: <td>cputime</td>
1.269     leot     14266: </tr>
                   14267: <tr>
1.336     nia      14268: <td>create-usergroup</td>
1.337     gutterid 14269: <td>csh</td>
1.269     leot     14270: </tr>
                   14271: <tr>
1.336     nia      14272: <td>ctf</td>
1.338   ! nia      14273: <td>cvs</td>
        !          14274: </tr>
        !          14275: <tr>
1.336     nia      14276: <td>debug</td>
1.338   ! nia      14277: <td>declaration</td>
1.289     leot     14278: </tr>
                   14279: <tr>
1.336     nia      14280: <td>declare</td>
1.338   ! nia      14281: <td>defined</td>
1.329     leot     14282: </tr>
                   14283: <tr>
1.336     nia      14284: <td>depend</td>
1.338   ! nia      14285: <td>dependencies</td>
1.320     wiz      14286: </tr>
                   14287: <tr>
1.336     nia      14288: <td>depends</td>
1.338   ! nia      14289: <td>depends-checksum</td>
1.269     leot     14290: </tr>
                   14291: <tr>
1.336     nia      14292: <td>depends-fetch</td>
1.338   ! nia      14293: <td>deps</td>
1.311     leot     14294: </tr>
                   14295: <tr>
1.336     nia      14296: <td>describe</td>
1.338   ! nia      14297: <td>destdir</td>
1.269     leot     14298: </tr>
                   14299: <tr>
1.336     nia      14300: <td>disable</td>
1.338   ! nia      14301: <td>distclean</td>
1.269     leot     14302: </tr>
                   14303: <tr>
1.336     nia      14304: <td>distinfo</td>
1.338   ! nia      14305: <td>dl</td>
1.269     leot     14306: </tr>
                   14307: <tr>
1.336     nia      14308: <td>dlopen</td>
1.338   ! nia      14309: <td>do-buildlink</td>
1.269     leot     14310: </tr>
                   14311: <tr>
1.336     nia      14312: <td>do-clean</td>
1.338   ! nia      14313: <td>do-configure</td>
1.269     leot     14314: </tr>
                   14315: <tr>
1.336     nia      14316: <td>do-configure-post-hook</td>
1.338   ! nia      14317: <td>do-extract</td>
1.277     rillig   14318: </tr>
                   14319: <tr>
1.336     nia      14320: <td>do-fetch</td>
1.338   ! nia      14321: <td>do-install</td>
1.269     leot     14322: </tr>
                   14323: <tr>
1.336     nia      14324: <td>emul</td>
1.338   ! nia      14325: <td>emul-distinfo</td>
1.332     rillig   14326: </tr>
                   14327: <tr>
1.336     nia      14328: <td>emul-fetch</td>
1.338   ! nia      14329: <td>emulation</td>
1.269     leot     14330: </tr>
                   14331: <tr>
1.336     nia      14332: <td>emulator</td>
1.338   ! nia      14333: <td>enable</td>
1.289     leot     14334: </tr>
                   14335: <tr>
1.336     nia      14336: <td>endian</td>
1.338   ! nia      14337: <td>endif</td>
1.269     leot     14338: </tr>
                   14339: <tr>
1.336     nia      14340: <td>enomem</td>
1.337     gutterid 14341: <td>ensurepip</td>
1.329     leot     14342: </tr>
                   14343: <tr>
1.327     wiz      14344: <td>err</td>
1.337     gutterid 14345: <td>errx</td>
1.269     leot     14346: </tr>
                   14347: <tr>
1.327     wiz      14348: <td>etc</td>
1.337     gutterid 14349: <td>exp</td>
1.320     wiz      14350: </tr>
                   14351: <tr>
1.327     wiz      14352: <td>extract-rpm</td>
1.337     gutterid 14353: <td>fabs</td>
1.311     leot     14354: </tr>
                   14355: <tr>
1.327     wiz      14356: <td>feature</td>
1.337     gutterid 14357: <td>features</td>
1.269     leot     14358: </tr>
                   14359: <tr>
1.327     wiz      14360: <td>fetch</td>
1.337     gutterid 14361: <td>fetch-list</td>
1.269     leot     14362: </tr>
                   14363: <tr>
1.327     wiz      14364: <td>follows</td>
1.337     gutterid 14365: <td>forbids</td>
1.289     leot     14366: </tr>
                   14367: <tr>
1.327     wiz      14368: <td>form</td>
1.337     gutterid 14369: <td>format</td>
1.269     leot     14370: </tr>
                   14371: <tr>
1.327     wiz      14372: <td>fortify</td>
1.335     nia      14373: <td>fortify_source</td>
1.332     rillig   14374: </tr>
                   14375: <tr>
1.338   ! nia      14376: <td>fossil</td>
1.335     nia      14377: <td>friend</td>
1.338   ! nia      14378: </tr>
        !          14379: <tr>
1.332     rillig   14380: <td>fts</td>
1.338   ! nia      14381: <td>fts_close</td>
1.269     leot     14382: </tr>
                   14383: <tr>
1.332     rillig   14384: <td>fts_open</td>
1.338   ! nia      14385: <td>fts_read</td>
1.269     leot     14386: </tr>
                   14387: <tr>
1.332     rillig   14388: <td>fts_set</td>
1.338   ! nia      14389: <td>gcc</td>
1.269     leot     14390: </tr>
                   14391: <tr>
1.332     rillig   14392: <td>gethostbyaddr</td>
1.338   ! nia      14393: <td>gethostbyname</td>
1.269     leot     14394: </tr>
                   14395: <tr>
1.332     rillig   14396: <td>gethostbyname2</td>
1.338   ! nia      14397: <td>getopt_long</td>
1.289     leot     14398: </tr>
                   14399: <tr>
1.332     rillig   14400: <td>getprogname</td>
1.338   ! nia      14401: <td>getservbyname</td>
1.269     leot     14402: </tr>
                   14403: <tr>
1.332     rillig   14404: <td>getservbyport</td>
1.338   ! nia      14405: <td>getservent</td>
1.269     leot     14406: </tr>
                   14407: <tr>
1.332     rillig   14408: <td>gettext</td>
1.338   ! nia      14409: <td>git</td>
1.289     leot     14410: </tr>
                   14411: <tr>
1.324     nia      14412: <td>github</td>
1.338   ! nia      14413: <td>gitlab</td>
        !          14414: </tr>
        !          14415: <tr>
1.324     nia      14416: <td>glob</td>
1.338   ! nia      14417: <td>gnu</td>
1.332     rillig   14418: </tr>
                   14419: <tr>
                   14420: <td>gnu_configure_strict</td>
1.338   ! nia      14421: <td>go</td>
1.269     leot     14422: </tr>
                   14423: <tr>
1.332     rillig   14424: <td>go-deps</td>
1.338   ! nia      14425: <td>golang</td>
1.274     rillig   14426: </tr>
                   14427: <tr>
1.332     rillig   14428: <td>guess-license</td>
1.338   ! nia      14429: <td>hashbang</td>
1.269     leot     14430: </tr>
                   14431: <tr>
1.332     rillig   14432: <td>heimdal</td>
1.338   ! nia      14433: <td>help</td>
1.269     leot     14434: </tr>
                   14435: <tr>
1.338   ! nia      14436: <td>hg</td>
1.337     gutterid 14437: <td>imake</td>
1.329     leot     14438: </tr>
                   14439: <tr>
1.327     wiz      14440: <td>increment</td>
1.337     gutterid 14441: <td>indirect</td>
1.269     leot     14442: </tr>
                   14443: <tr>
1.335     nia      14444: <td>inet_aton</td>
1.327     wiz      14445: <td>interp</td>
1.320     wiz      14446: </tr>
                   14447: <tr>
1.335     nia      14448: <td>interpreter</td>
1.327     wiz      14449: <td>intl</td>
1.311     leot     14450: </tr>
                   14451: <tr>
1.335     nia      14452: <td>ip4</td>
1.327     wiz      14453: <td>ip6</td>
1.269     leot     14454: </tr>
                   14455: <tr>
1.335     nia      14456: <td>ipv4</td>
1.327     wiz      14457: <td>ipv6</td>
1.269     leot     14458: </tr>
                   14459: <tr>
1.335     nia      14460: <td>iso</td>
1.327     wiz      14461: <td>kerberos</td>
1.269     leot     14462: </tr>
                   14463: <tr>
1.335     nia      14464: <td>krb</td>
1.327     wiz      14465: <td>krb5</td>
1.269     leot     14466: </tr>
                   14467: <tr>
1.335     nia      14468: <td>ksh</td>
1.327     wiz      14469: <td>lapack</td>
1.303     bacon    14470: </tr>
                   14471: <tr>
1.335     nia      14472: <td>latex</td>
1.327     wiz      14473: <td>libintl_bindtextdomain</td>
1.303     bacon    14474: </tr>
                   14475: <tr>
1.335     nia      14476: <td>libintl_gettext</td>
1.327     wiz      14477: <td>libintl_textdomain</td>
1.269     leot     14478: </tr>
                   14479: <tr>
1.335     nia      14480: <td>libnbcompat</td>
1.327     wiz      14481: <td>libs</td>
1.292     leot     14482: </tr>
                   14483: <tr>
1.335     nia      14484: <td>libtool</td>
1.327     wiz      14485: <td>licence</td>
1.269     leot     14486: </tr>
                   14487: <tr>
1.335     nia      14488: <td>license</td>
1.327     wiz      14489: <td>lintl</td>
1.289     leot     14490: </tr>
                   14491: <tr>
1.335     nia      14492: <td>little-endian</td>
1.327     wiz      14493: <td>lock</td>
1.274     rillig   14494: </tr>
                   14495: <tr>
1.335     nia      14496: <td>locking</td>
1.333     nia      14497: <td>lua</td>
1.271     brook    14498: </tr>
                   14499: <tr>
1.335     nia      14500: <td>lvalue</td>
1.330     wiz      14501: <td>make</td>
1.269     leot     14502: </tr>
                   14503: <tr>
1.335     nia      14504: <td>makesum</td>
1.330     wiz      14505: <td>memory</td>
1.269     leot     14506: </tr>
                   14507: <tr>
1.338   ! nia      14508: <td>mercurial</td>
1.330     wiz      14509: <td>meta</td>
1.269     leot     14510: </tr>
                   14511: <tr>
1.338   ! nia      14512: <td>meta-package</td>
1.330     wiz      14513: <td>meta_package</td>
1.269     leot     14514: </tr>
                   14515: <tr>
1.338   ! nia      14516: <td>mit-krb5</td>
1.330     wiz      14517: <td>mk.conf</td>
1.292     leot     14518: </tr>
                   14519: <tr>
1.338   ! nia      14520: <td>mkl</td>
1.330     wiz      14521: <td>mount</td>
1.274     rillig   14522: </tr>
                   14523: <tr>
1.338   ! nia      14524: <td>mprotect</td>
1.330     wiz      14525: <td>mremap</td>
1.269     leot     14526: </tr>
                   14527: <tr>
1.338   ! nia      14528: <td>nb</td>
1.330     wiz      14529: <td>nbcompat</td>
1.269     leot     14530: </tr>
                   14531: <tr>
1.338   ! nia      14532: <td>netlib</td>
1.333     nia      14533: <td>node</td>
                   14534: </tr>
                   14535: <tr>
1.338   ! nia      14536: <td>node.js</td>
1.333     nia      14537: <td>nodejs</td>
                   14538: </tr>
                   14539: <tr>
1.338   ! nia      14540: <td>obstack</td>
1.332     rillig   14541: <td>obstack_ptr_grow</td>
1.320     wiz      14542: </tr>
                   14543: <tr>
1.338   ! nia      14544: <td>occurs</td>
1.332     rillig   14545: <td>only</td>
1.269     leot     14546: </tr>
                   14547: <tr>
1.338   ! nia      14548: <td>openblas</td>
1.332     rillig   14549: <td>options</td>
1.269     leot     14550: </tr>
                   14551: <tr>
1.338   ! nia      14552: <td>options.mk</td>
1.332     rillig   14553: <td>order</td>
1.269     leot     14554: </tr>
                   14555: <tr>
1.338   ! nia      14556: <td>override</td>
1.332     rillig   14557: <td>override-intltool</td>
1.271     brook    14558: </tr>
                   14559: <tr>
1.338   ! nia      14560: <td>override-message-intltool</td>
1.332     rillig   14561: <td>package</td>
1.269     leot     14562: </tr>
                   14563: <tr>
1.338   ! nia      14564: <td>parallel</td>
1.332     rillig   14565: <td>path</td>
1.269     leot     14566: </tr>
                   14567: <tr>
1.338   ! nia      14568: <td>pax</td>
1.332     rillig   14569: <td>paxctl</td>
1.269     leot     14570: </tr>
                   14571: <tr>
1.338   ! nia      14572: <td>pbulk-index</td>
1.332     rillig   14573: <td>pc</td>
1.269     leot     14574: </tr>
                   14575: <tr>
1.338   ! nia      14576: <td>perl</td>
1.332     rillig   14577: <td>perl5</td>
1.269     leot     14578: </tr>
                   14579: <tr>
1.338   ! nia      14580: <td>perms</td>
1.332     rillig   14581: <td>php</td>
1.269     leot     14582: </tr>
                   14583: <tr>
1.338   ! nia      14584: <td>pkg-build-options</td>
1.332     rillig   14585: <td>pkg-config</td>
1.269     leot     14586: </tr>
                   14587: <tr>
1.338   ! nia      14588: <td>pkg_build_options</td>
1.332     rillig   14589: <td>platform</td>
1.269     leot     14590: </tr>
                   14591: <tr>
1.338   ! nia      14592: <td>plist</td>
1.332     rillig   14593: <td>post-extract</td>
1.269     leot     14594: </tr>
                   14595: <tr>
1.338   ! nia      14596: <td>post-fetch</td>
1.332     rillig   14597: <td>post-wrapper</td>
1.269     leot     14598: </tr>
                   14599: <tr>
1.338   ! nia      14600: <td>pre-build-checks-hook</td>
1.332     rillig   14601: <td>pre-configure</td>
1.269     leot     14602: </tr>
                   14603: <tr>
1.338   ! nia      14604: <td>pre-configure-checks-hook</td>
1.332     rillig   14605: <td>pre-extract</td>
1.289     leot     14606: </tr>
                   14607: <tr>
1.338   ! nia      14608: <td>pre-fetch</td>
1.332     rillig   14609: <td>print-go-deps</td>
1.269     leot     14610: </tr>
                   14611: <tr>
1.338   ! nia      14612: <td>print-plist</td>
1.332     rillig   14613: <td>print-summary-data</td>
1.269     leot     14614: </tr>
                   14615: <tr>
1.338   ! nia      14616: <td>privileged-install-hook</td>
1.332     rillig   14617: <td>pypi</td>
1.269     leot     14618: </tr>
                   14619: <tr>
1.338   ! nia      14620: <td>python</td>
1.332     rillig   14621: <td>r</td>
1.269     leot     14622: </tr>
                   14623: <tr>
1.338   ! nia      14624: <td>readme-all</td>
1.337     gutterid 14625: <td>recursive</td>
1.269     leot     14626: </tr>
                   14627: <tr>
1.338   ! nia      14628: <td>recv</td>
1.335     nia      14629: <td>recvfrom</td>
1.289     leot     14630: </tr>
                   14631: <tr>
1.338   ! nia      14632: <td>regcomp</td>
1.335     nia      14633: <td>release-localbase-lock</td>
1.289     leot     14634: </tr>
                   14635: <tr>
1.338   ! nia      14636: <td>release-lock</td>
1.335     nia      14637: <td>relro</td>
1.269     leot     14638: </tr>
                   14639: <tr>
1.338   ! nia      14640: <td>rename</td>
1.335     nia      14641: <td>reorder</td>
1.269     leot     14642: </tr>
                   14643: <tr>
1.338   ! nia      14644: <td>replace</td>
1.335     nia      14645: <td>replace_interpreter</td>
1.269     leot     14646: </tr>
                   14647: <tr>
1.338   ! nia      14648: <td>reproducible</td>
1.335     nia      14649: <td>resolv</td>
1.269     leot     14650: </tr>
                   14651: <tr>
1.338   ! nia      14652: <td>root</td>
1.335     nia      14653: <td>ruby</td>
1.289     leot     14654: </tr>
                   14655: <tr>
1.338   ! nia      14656: <td>send</td>
1.335     nia      14657: <td>sendfile</td>
1.269     leot     14658: </tr>
                   14659: <tr>
1.338   ! nia      14660: <td>sendto</td>
1.335     nia      14661: <td>setenv</td>
1.269     leot     14662: </tr>
                   14663: <tr>
1.338   ! nia      14664: <td>setgid</td>
1.335     nia      14665: <td>setprogname</td>
1.269     leot     14666: </tr>
                   14667: <tr>
1.338   ! nia      14668: <td>setuid</td>
1.335     nia      14669: <td>sh</td>
1.269     leot     14670: </tr>
                   14671: <tr>
1.338   ! nia      14672: <td>shebang</td>
1.335     nia      14673: <td>show</td>
1.296     rillig   14674: </tr>
                   14675: <tr>
1.338   ! nia      14676: <td>show-all</td>
1.335     nia      14677: <td>show-build-defs</td>
1.269     leot     14678: </tr>
                   14679: <tr>
1.338   ! nia      14680: <td>show-depends</td>
1.337     gutterid 14681: <td>show-depends-dirs</td>
                   14682: </tr>
                   14683: <tr>
                   14684: <td>show-depends-pkgpaths</td>
1.338   ! nia      14685: <td>show-depends-recursive</td>
        !          14686: </tr>
        !          14687: <tr>
1.335     nia      14688: <td>show-deps</td>
1.338   ! nia      14689: <td>show-distfiles</td>
1.269     leot     14690: </tr>
                   14691: <tr>
1.335     nia      14692: <td>show-downlevel</td>
1.338   ! nia      14693: <td>show-subdir-var</td>
1.269     leot     14694: </tr>
                   14695: <tr>
1.335     nia      14696: <td>show-tools</td>
1.338   ! nia      14697: <td>show-var</td>
1.269     leot     14698: </tr>
                   14699: <tr>
1.335     nia      14700: <td>show-vars</td>
1.338   ! nia      14701: <td>snprintf</td>
1.269     leot     14702: </tr>
                   14703: <tr>
1.335     nia      14704: <td>socket</td>
1.338   ! nia      14705: <td>ssp</td>
1.289     leot     14706: </tr>
                   14707: <tr>
1.335     nia      14708: <td>st_mode</td>
1.338   ! nia      14709: <td>stage-install</td>
1.269     leot     14710: </tr>
                   14711: <tr>
1.335     nia      14712: <td>strcasestr</td>
1.338   ! nia      14713: <td>strict</td>
1.269     leot     14714: </tr>
                   14715: <tr>
1.335     nia      14716: <td>strip</td>
1.338   ! nia      14717: <td>strndup</td>
1.277     rillig   14718: </tr>
                   14719: <tr>
1.335     nia      14720: <td>strnlen</td>
1.338   ! nia      14721: <td>strsep</td>
1.269     leot     14722: </tr>
                   14723: <tr>
1.335     nia      14724: <td>subst</td>
1.338   ! nia      14725: <td>substitutions</td>
1.329     leot     14726: </tr>
                   14727: <tr>
1.338   ! nia      14728: <td>subversion</td>
1.326     gutterid 14729: <td>sun</td>
1.327     wiz      14730: </tr>
                   14731: <tr>
1.335     nia      14732: <td>sunpro</td>
1.327     wiz      14733: <td>sunwspro</td>
1.311     leot     14734: </tr>
                   14735: <tr>
1.338   ! nia      14736: <td>svn</td>
1.276     leot     14737: <td>symlink</td>
1.338   ! nia      14738: </tr>
        !          14739: <tr>
1.337     gutterid 14740: <td>test</td>
1.338   ! nia      14741: <td>test-env</td>
1.269     leot     14742: </tr>
                   14743: <tr>
1.337     gutterid 14744: <td>tex</td>
1.338   ! nia      14745: <td>texlive</td>
1.269     leot     14746: </tr>
                   14747: <tr>
1.337     gutterid 14748: <td>tmp</td>
1.338   ! nia      14749: <td>tool</td>
1.269     leot     14750: </tr>
                   14751: <tr>
1.337     gutterid 14752: <td>tools</td>
1.338   ! nia      14753: <td>tools-libtool-m4-override</td>
1.269     leot     14754: </tr>
                   14755: <tr>
1.338   ! nia      14756: <td>transitive</td>
1.337     gutterid 14757: <td>type</td>
1.269     leot     14758: </tr>
                   14759: <tr>
1.289     leot     14760: <td>ulimit</td>
1.337     gutterid 14761: <td>undefined</td>
1.269     leot     14762: </tr>
                   14763: <tr>
1.289     leot     14764: <td>undo-replace</td>
1.337     gutterid 14765: <td>unlimit</td>
1.269     leot     14766: </tr>
                   14767: <tr>
1.289     leot     14768: <td>unprivileged</td>
1.337     gutterid 14769: <td>unprivileged-install-hook</td>
1.269     leot     14770: </tr>
                   14771: <tr>
1.289     leot     14772: <td>unstripped</td>
1.337     gutterid 14773: <td>update</td>
1.269     leot     14774: </tr>
                   14775: <tr>
1.289     leot     14776: <td>upload</td>
1.337     gutterid 14777: <td>upload-distfiles</td>
1.269     leot     14778: </tr>
                   14779: <tr>
1.270     leot     14780: <td>use_tools</td>
1.337     gutterid 14781: <td>user</td>
1.269     leot     14782: </tr>
                   14783: <tr>
1.270     leot     14784: <td>utimes</td>
1.337     gutterid 14785: <td>vasprintf</td>
1.269     leot     14786: </tr>
                   14787: <tr>
1.270     leot     14788: <td>verbose</td>
1.337     gutterid 14789: <td>vsnprintf</td>
1.269     leot     14790: </tr>
                   14791: <tr>
1.270     leot     14792: <td>warn</td>
1.337     gutterid 14793: <td>warning</td>
1.269     leot     14794: </tr>
                   14795: <tr>
1.270     leot     14796: <td>warnings</td>
1.337     gutterid 14797: <td>warnx</td>
1.269     leot     14798: </tr>
                   14799: <tr>
1.289     leot     14800: <td>wattr_off</td>
1.337     gutterid 14801: <td>wattr_on</td>
1.269     leot     14802: </tr>
                   14803: <tr>
1.289     leot     14804: <td>work</td>
1.337     gutterid 14805: <td>wrapper</td>
1.269     leot     14806: </tr>
                   14807: <tr>
1.289     leot     14808: <td>wrkdir</td>
1.337     gutterid 14809: <td> </td>
1.269     leot     14810: </tr>
                   14811: </table>
1.267     rillig   14812: </div>
                   14813: <div class="appendix">
                   14814: <div class="titlepage"><div><div><h1 class="title">
1.322     leot     14815: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   14816: <div class="toc">
                   14817: <p><b>Table of Contents</b></p>
1.210     leot     14818: <dl class="toc">
1.322     leot     14819: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   14820: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig   14821: </dl>
                   14822: </div>
1.79      rillig   14823: <p>This section contains information on editing the pkgsrc
                   14824:        guide itself.</p>
1.148     asau     14825: <div class="sect1">
1.75      rillig   14826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     14827: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79      rillig   14828: <p>The pkgsrc guide's source code is stored in
                   14829:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   14830:        are created from it:</p>
1.148     asau     14831: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      14832: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   14833: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     14834: <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>
                   14835: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   14836:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     14837: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   14838:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   14839: </ul></div>
                   14840: </div>
1.148     asau     14841: <div class="sect1">
1.75      rillig   14842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322     leot     14843: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79      rillig   14844: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      14845: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    14846: <li class="step"><p>Make sure you have checked out the htdocs repository
                   14847:        into a sibling directory of your pkgsrc directory.  You will need
                   14848:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     14849: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      14850:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   14851:        documentation) installed. These are automatically installed when
1.322     leot     14852:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     14853: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   14854:        right directory. All further steps will take place
                   14855:        here.</p></li>
1.148     asau     14856: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   14857:        <code class="filename">files/</code>.</p></li>
1.148     asau     14858: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   14859:        guide for valid XML and to build the final output files. If you
                   14860:        get any errors at this stage, you can just edit the files, as
                   14861:        there are only symbolic links in the working directory, pointing
                   14862:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     14863: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   14864:        commit)</strong></span></p></li>
1.148     asau     14865: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   14866:        regenerate the output files with the proper RCS
                   14867:        Ids.</p></li>
1.148     asau     14868: <li class="step">
1.110     hubertf  14869: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   14870:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   14871:        <code class="filename">htdocs</code>.</p>
1.148     asau     14872: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   14873: <h3 class="title">Note</h3>
                   14874: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  14875:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   14876:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   14877:        directory.</p>
                   14878: </div>
                   14879: </li>
1.79      rillig   14880: </ol></div>
1.75      rillig   14881: </div>
                   14882: </div>
                   14883: </div></body>
1.1       grant    14884: </html>

CVSweb <webmaster@jp.NetBSD.org>