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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.385     leot        4: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
1.75      rillig      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.387     wiz        33: <div><p class="copyright">Copyright © 1994-2026 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.46 2026/01/01 08:41:23 wiz Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia        88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                     92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig     94: </dl></dd>
1.267     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     96: <dd><dl>
1.267     rillig     97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig    100: </dl></dd>
                    101: </dl></dd>
1.267     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    103: <dd><dl>
1.267     rillig    104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig    106: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                    107: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                    108: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                    109: <dd><dl>
                    110: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    112: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       113: </dl></dd>
1.355     rillig    114: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                    115: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig    116: </dl></dd>
1.267     rillig    117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    118: <dd><dl>
1.267     rillig    119: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    120: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    121: </dl></dd>
1.267     rillig    122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    123: builds)</a></span></dt>
1.75      rillig    124: <dd><dl>
1.267     rillig    125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    127: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.390     wiz       128: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
                    129: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
                    130: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
                    131: <dd><dl>
                    132: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
                    140: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
                    141: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.293     rillig    142: </dl></dd>
1.390     wiz       143: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
                    144: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    145: </dl></dd>
                    146: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    147: <dd><dl>
                    148: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    149: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    150: </dl></dd>
                    151: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    152: <dd><dl>
                    153: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    154: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    155: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    156: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    157: <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>
                    158: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    160: <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>
                    161: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot      162: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
                    163: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336     nia       165: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    166: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    168: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    169: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
1.385     leot      170: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75      rillig    171: </dl></dd>
                    172: </dl></dd>
                    173: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    174: <dd><dl>
1.267     rillig    175: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    176: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    177: <dd><dl>
1.299     rillig    178: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    179: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    180: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    181: <dd><dl>
1.299     rillig    182: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    186: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    187: </dl></dd>
1.299     rillig    188: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    189: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    190: <dd><dl>
                    191: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    194: </dl></dd>
                    195: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    196: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    197: </dl></dd>
1.299     rillig    198: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    199: <dd><dl>
1.299     rillig    200: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    203: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    204: <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    205: <dd><dl>
1.299     rillig    206: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    207: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    208: </dl></dd>
1.299     rillig    209: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    219: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    220: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    221: </dl></dd>
                    222: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    223: <dd><dl>
                    224: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    225: <dd><dl>
1.334     nia       226: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                    227: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                    228: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig    229: </dl></dd>
1.299     rillig    230: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    231: <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    232: </dl></dd>
1.299     rillig    233: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    234: <dd><dl>
1.299     rillig    235: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    236: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    237: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    238: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    239: <dd><dl>
1.299     rillig    240: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    241: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    242: <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>
                    243: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid  244: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig    245: </dl></dd>
                    246: </dl></dd>
1.299     rillig    247: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    248: <dd><dl>
1.299     rillig    249: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    250: <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>
                    251: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    252: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    253: </dl></dd>
1.299     rillig    254: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    255: <dd><dl>
1.299     rillig    256: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    257: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    258: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    259: </dl></dd>
                    260: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    261: <dd><dl>
                    262: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    263: <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    264: <dd><dl>
1.299     rillig    265: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    266: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       267:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    268:       and
                    269:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    270:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    271: </dl></dd>
1.299     rillig    272: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig    273: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig    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>
1.353     dholland  298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                    300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig    301: </dl></dd>
                    302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    303: <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>
                    304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    308: <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    309: </dl></dd>
                    310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    311: <dd><dl>
                    312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    313: <dd><dl>
                    314: <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>
                    315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    325: </dl></dd>
                    326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    327: <dd><dl>
                    328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    329: <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>
                    330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    331: </dl></dd>
                    332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia       337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz       338: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig    339: </dl></dd>
                    340: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    341: <dd><dl>
                    342: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    343: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz       344: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia       345: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                    346: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                    347: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                    348: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig    349: </dl></dd>
                    350: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    351: <dd><dl>
                    352: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    353: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    354: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot      355: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.287     rillig    356: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    357: </dl></dd>
                    358: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    359: <dd><dl>
                    360: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    361: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    362: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    364: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia       365: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz       366: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                    367: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                    368: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                    369: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                    370: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                    371: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                    372: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                    373: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                    374: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                    375: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz       376:     emulation</a></span></dt>
1.369     wiz       377: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                    378: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig    379: </dl></dd>
1.267     rillig    380: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    381: </dl></dd>
1.299     rillig    382: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    383: <dd><dl>
                    384: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    385: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    386: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    387: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    388: </dl></dd>
1.267     rillig    389: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    390: <dd><dl>
1.267     rillig    391: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    392: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    393: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    394: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    395: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    396: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    397: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    398: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    399: </dl></dd>
1.382     wiz       400: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                    401: <dd><dl>
                    402: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                    403: <dd><dl>
                    404: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                    405: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                    406: </dl></dd>
                    407: </dl></dd>
                    408: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig    409: </dl></dd>
                    410: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    411: <dd><dl>
1.382     wiz       412: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    413: <dd><dl>
1.382     wiz       414: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    415: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    416: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig    417: <dd><dl>
1.382     wiz       418: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    419: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig    420: </dl></dd>
1.382     wiz       421: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    422: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    423: <dd><dl>
1.382     wiz       424: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    425: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    426: </dl></dd>
1.382     wiz       427: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig    428: <dd><dl>
1.382     wiz       429: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    430: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    431: </dl></dd>
                    432: </dl></dd>
1.382     wiz       433: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig    434: <dd><dl>
1.382     wiz       435: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    436: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig    437: <dd><dl>
1.382     wiz       438: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    439: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig    440: </dl></dd>
                    441: </dl></dd>
1.382     wiz       442: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    443: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    444: </dl></dd>
                    445: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    448: <dd><dl>
                    449: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    450: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    451: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    452: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    453: </dl></dd>
                    454: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    455: </dl></dd>
1.322     leot      456: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75      rillig    457: <dd><dl>
1.322     leot      458: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                    459: <dd><dl>
                    460: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                    461: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                    462: </dl></dd>
                    463: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                    464: <dd><dl>
                    465: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                    466: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                    467: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                    468: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                    469: </dl></dd>
                    470: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                    471: <dd><dl>
                    472: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                    473: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                    474: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                    475: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                    476: </dl></dd>
                    477: </dl></dd>
                    478: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
                    479: <dd><dl>
                    480: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                    481: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75      rillig    482: </dl></dd>
1.322     leot      483: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76      rillig    484: <dd><dl>
1.322     leot      485: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    486: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    487: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    488: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    489: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261     leot      490: <code class="filename">stable</code>,
1.128     wiz       491: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    492: source packages</a></span></dt>
                    493: </dl></dd>
1.322     leot      494: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
                    495: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    496: <dd><dl>
1.322     leot      497: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                    498: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig    499: </dl></dd>
                    500: </dl>
                    501: </div>
1.82      rillig    502: <div class="list-of-tables">
                    503: <p><b>List of Tables</b></p>
                    504: <dl>
                    505: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    506: </dt>
1.299     rillig    507: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      508: </dt>
1.299     rillig    509: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      510: </dt>
1.82      rillig    511: </dl>
                    512: </div>
1.148     asau      513: <div class="chapter">
                    514: <div class="titlepage"><div><div><h1 class="title">
1.385     leot      515: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    516: <div class="toc">
                    517: <p><b>Table of Contents</b></p>
1.210     leot      518: <dl class="toc">
1.75      rillig    519: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    520: <dd><dl>
                    521: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    522: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    523: </dl></dd>
1.75      rillig    524: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    525: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       526: <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    527: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    528: </dl>
                    529: </div>
1.148     asau      530: <div class="sect1">
1.75      rillig    531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      532: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    533: <p>There is a lot of software freely available for Unix-based
                    534: systems, which is usually available in form of the source code. Before
                    535: such software can be used, it needs to be configured to the local
                    536: system, compiled and installed, and this is exactly what The NetBSD
                    537: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    538: to handle binary packages, so that not every user has to build the
                    539: packages for himself, which is a time-costly task.</p>
1.75      rillig    540: <p>pkgsrc currently contains several thousand packages,
                    541:       including:</p>
1.148     asau      542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot      543: <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    544:          web server</p></li>
1.322     leot      545: <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    546:          web browser</p></li>
1.322     leot      547: <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    548:          Desktop Environment</p></li>
1.322     leot      549: <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    550:          Desktop Environment</p></li>
                    551: </ul></div>
1.385     leot      552: <p>… just to name a few.</p>
1.75      rillig    553: <p>pkgsrc has built-in support for handling varying dependencies,
                    554:       such as pthreads and X11, and extended features such as IPv6 support on
                    555:       a range of platforms.</p>
1.148     asau      556: <div class="sect2">
1.82      rillig    557: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      558: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
1.82      rillig    559: <p>
                    560: pkgsrc provides the following key features:
                    561: </p>
1.148     asau      562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       563: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    564:   and installation of binary packages. The source and latest
                    565:   patches are retrieved from a master or mirror download site, checksum
                    566:   verified, then built on your system. Support for binary-only
                    567:   distributions is available for both native platforms and NetBSD
                    568:   emulated platforms.</p></li>
1.128     wiz       569: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    570:   including binaries, libraries, man pages and other
                    571:   documentation.</p></li>
1.214     sevan     572: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    573:   performing updates, to ensure required packages are installed. The
                    574:   configuration files of various packages are handled automatically during
                    575:   updates, so local changes are preserved.</p></li>
1.128     wiz       576: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    577:   consists of highly portable code. This allows the greatest speed of
1.132     spz       578:   development when porting to a new platform. This portability also
1.82      rillig    579:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    580:   platforms</em></span>.</p></li>
1.128     wiz       581: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    582:   international encryption requirements and build-time options for a
                    583:   large number of packages are all set in a simple, central
                    584:   configuration file.</p></li>
1.128     wiz       585: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    586:   freely available under a BSD license, so you may extend and adapt
                    587:   pkgsrc to your needs. Support for local packages and patches is
                    588:   available right out of the box, so you can configure it specifically
                    589:   for your environment.</p></li>
                    590: </ul></div>
1.91      rillig    591: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      592: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.385     leot      593: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126     jakllsch  594: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    595: them and to complain about them rather than to just install the package
                    596: and hope that it works. There are numerous checks in pkgsrc that try to
1.322     leot      597: 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    598: of shell scripts), and post-installation checks (installed files,
                    599: references to shared libraries, script interpreters).</p></li>
1.385     leot      600: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126     jakllsch  601: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    602: pkgsrc has been ported to many operating systems. Care is taken that
                    603: packages behave the same on all platforms.</p></li>
                    604: </ul></div>
1.82      rillig    605: </div>
1.148     asau      606: <div class="sect2">
1.82      rillig    607: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      608: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
1.82      rillig    609: <p>pkgsrc consists of both a source distribution and a binary
                    610: distribution for these operating systems. After retrieving the required
                    611: source or binaries, you can be up and running with pkgsrc in just
                    612: minutes!</p>
1.75      rillig    613: <p>pkgsrc was derived from FreeBSD's ports system, and
                    614:       initially developed for NetBSD only. Since then, pkgsrc has
                    615:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    616: <div class="table">
1.385     leot      617: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       618: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    619: <colgroup>
                    620: <col>
                    621: <col>
1.202     sevan     622: <col>
1.82      rillig    623: </colgroup>
                    624: <thead><tr>
                    625: <th>Platform</th>
                    626: <th>Date Support Added</th>
1.202     sevan     627: <th>Notes</th>
1.82      rillig    628: </tr></thead>
                    629: <tbody>
                    630: <tr>
1.289     leot      631: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    632: <td align="center">Aug 1997</td>
1.385     leot      633: <td class="auto-generated"> </td>
1.82      rillig    634: </tr>
                    635: <tr>
1.110     hubertf   636: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    637: <td align="center">Mar 1999</td>
1.264     sevan     638: <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    639: </tr>
                    640: <tr>
1.289     leot      641: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    642: <td align="center">Jun 1999</td>
1.264     sevan     643: <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    644: </tr>
                    645: <tr>
                    646: <td>
1.230     sevan     647:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    648:         </td>
                    649: <td align="center">Oct 2001</td>
1.305     bacon     650: <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    651: </tr>
                    652: <tr>
1.289     leot      653: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    654: <td align="center">Nov 2002</td>
1.264     sevan     655: <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    656: </tr>
                    657: <tr>
1.289     leot      658: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    659: <td align="center">Nov 2002</td>
1.264     sevan     660: <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    661: </tr>
                    662: <tr>
1.289     leot      663: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    664: <td align="center">Dec 2002</td>
1.202     sevan     665: <td>
1.264     sevan     666:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202     sevan     667:        </td>
1.82      rillig    668: </tr>
                    669: <tr>
                    670: <td>BSD/OS</td>
                    671: <td align="center">Dec 2003</td>
1.381     dholland  672: <td align="center">Removed from pkgsrc Mar 2025</td>
1.82      rillig    673: </tr>
                    674: <tr>
1.289     leot      675: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    676: <td align="center">Dec 2003</td>
1.264     sevan     677: <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    678: </tr>
                    679: <tr>
                    680: <td>
1.289     leot      681:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    682:           (Microsoft Windows Services for Unix)
                    683:         </td>
                    684: <td align="center">Mar 2004</td>
1.383     wiz       685: <td align="center">Removed from pkgsrc Apr 2025</td>
1.82      rillig    686: </tr>
                    687: <tr>
1.289     leot      688: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    689: <td align="center">Oct 2004</td>
1.385     leot      690: <td class="auto-generated"> </td>
1.82      rillig    691: </tr>
                    692: <tr>
1.110     hubertf   693: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    694: <td align="center">Nov 2004</td>
1.264     sevan     695: <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    696: </tr>
1.98      wiz       697: <tr>
1.289     leot      698: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       699: <td align="center">Apr 2007</td>
1.264     sevan     700: <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       701: </tr>
1.128     wiz       702: <tr>
1.289     leot      703: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       704: <td align="center">Sep 2010</td>
1.264     sevan     705: <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       706: </tr>
1.151     obache    707: <tr>
1.289     leot      708: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  709: <td align="center">Jan 2011</td>
1.381     dholland  710: <td align="center">Removed from pkgsrc Mar 2025</td>
1.151     obache    711: </tr>
                    712: <tr>
1.289     leot      713: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    714: <td align="center">Nov 2011</td>
1.264     sevan     715: <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    716: </tr>
                    717: <tr>
1.289     leot      718: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    719: <td align="center">Mar 2013</td>
1.264     sevan     720: <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    721: </tr>
1.166     jnemeth   722: <tr>
1.289     leot      723: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   724: <td align="center">Jul 2013</td>
1.380     maya      725: <td>Removed from pkgsrc Mar 2025</td>
1.166     jnemeth   726: </tr>
1.214     sevan     727: <tr>
1.289     leot      728: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     729: <td align="center">Jun 2014</td>
1.344     gutterid  730: <td>Removed from pkgsrc Sep 2022</td>
1.214     sevan     731: </tr>
1.82      rillig    732: </tbody>
1.91      rillig    733: </table></div>
1.82      rillig    734: </div>
1.91      rillig    735: <br class="table-break">
1.82      rillig    736: </div>
1.75      rillig    737: </div>
1.148     asau      738: <div class="sect1">
1.75      rillig    739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      740: <a name="overview"></a>1.2. Overview</h2></div></div></div>
1.75      rillig    741: <p>This document is divided into three parts. The first,
1.385     leot      742:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    743:        describes how one can use one of the packages in the Package
                    744:        Collection, either by installing a precompiled binary package,
1.93      rillig    745:        or by building one's own copy using the NetBSD package system.
1.385     leot      746:        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    747:        package so it can be easily built by other NetBSD users without
                    748:        knowing about the package's building details. The third part,
1.385     leot      749:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    750:        is intended for those who want to understand how pkgsrc is
                    751:        implemented.</p>
                    752: <p>This document is available in various formats:
1.110     hubertf   753:        <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    754: </div>
1.148     asau      755: <div class="sect1">
1.75      rillig    756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      757: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    758: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
                    759:       <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75      rillig    760:       terminology used within this document.</p>
1.148     asau      761: <div class="variablelist"><dl class="variablelist">
1.75      rillig    762: <dt><span class="term">Package</span></dt>
                    763: <dd><p>A set of files and building instructions
                    764:            that describe what's necessary
                    765:            to build a certain piece of software using
                    766:             pkgsrc. Packages are traditionally stored under
1.236     wiz       767:            <code class="filename">/usr/pkgsrc</code>,
                    768:            but may be stored in any location,
                    769:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    770: <dt><span class="term">The NetBSD package system</span></dt>
1.385     leot      771: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>.  It
1.87      wiz       772:          is part of the NetBSD operating system and can be bootstrapped
                    773:          to run on non-NetBSD operating systems as well.  It handles
                    774:          building (compiling), installing, and removing of
                    775:          packages.</p></dd>
1.75      rillig    776: <dt><span class="term">Distfile</span></dt>
                    777: <dd><p>This term describes the file or files that are
                    778:            provided by the author of the piece of software to
                    779:            distribute his work. All the changes necessary to build on
                    780:            NetBSD are reflected in the corresponding package. Usually
                    781:            the distfile is in the form of a compressed tar-archive,
                    782:            but other types are possible, too. Distfiles are usually
                    783:            stored below
1.76      rillig    784:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    785: <dt><span class="term">Port</span></dt>
                    786: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    787:            for what we call a package.
1.385     leot      788:            In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75      rillig    789:            architecture.</p></dd>
                    790: <dt><span class="term">Precompiled/binary package</span></dt>
                    791: <dd>
                    792: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    793:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    794:            file so it can be installed on machines of the same
                    795:            machine architecture without the need to
                    796:            recompile. Packages are usually generated in
1.76      rillig    797:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       798:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.385     leot      799: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75      rillig    800:            especially in the context of precompiled packages.</p>
                    801: </dd>
                    802: <dt><span class="term">Program</span></dt>
1.88      wiz       803: <dd><p>The piece of software to be installed which will be
                    804:          constructed from all the files in the distfile by the
                    805:          actions defined in the corresponding package.</p></dd>
1.75      rillig    806: </dl></div>
1.148     asau      807: <div class="sect2">
1.75      rillig    808: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      809: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      810: <div class="variablelist"><dl class="variablelist">
1.75      rillig    811: <dt><span class="term">pkgsrc users</span></dt>
                    812: <dd>
                    813: <p>The
                    814:        pkgsrc users are people who use the packages provided by pkgsrc.
                    815:        Typically they are system administrators. The people using the
1.385     leot      816:        software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
                    817:        users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    818: <p>There are two kinds of pkgsrc users: Some only want to
                    819:        install pre-built binary packages. Others build the pkgsrc
                    820:        packages from source, either for installing them directly or for
1.385     leot      821:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75      rillig    822:        documentation.</p>
                    823: </dd>
                    824: <dt><span class="term">package maintainers</span></dt>
                    825: <dd><p>A
1.385     leot      826:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75      rillig    827: <dt><span class="term">infrastructure developers</span></dt>
                    828: <dd><p>These people are involved in all those files
1.76      rillig    829:        that live in the <code class="filename">mk/</code> directory and below.
1.385     leot      830:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75      rillig    831:        too.</p></dd>
                    832: </dl></div>
                    833: </div>
                    834: </div>
1.148     asau      835: <div class="sect1">
1.75      rillig    836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      837: <a name="typography"></a>1.4. Typography</h2></div></div></div>
1.75      rillig    838: <p>When giving examples for commands, shell prompts are used to
                    839:       show if the command should/can be issued as root, or if
1.385     leot      840:       <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226     sevan     841:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    842:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344     gutterid  843:       Bourne shell and derivatives.</p>
1.75      rillig    844: </div>
                    845: </div>
1.148     asau      846: <div class="part">
1.75      rillig    847: <div class="titlepage"><div><div><h1 class="title">
1.385     leot      848: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
1.75      rillig    849: <div class="toc">
                    850: <p><b>Table of Contents</b></p>
1.210     leot      851: <dl class="toc">
1.267     rillig    852: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    853: <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    854: <dd><dl>
1.267     rillig    855: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    856: <dd><dl>
1.267     rillig    857: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    858: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    859: </dl></dd>
1.267     rillig    860: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    861: <dd><dl>
1.267     rillig    862: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    863: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    864: </dl></dd>
                    865: </dl></dd>
1.267     rillig    866: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    867: <dd><dl>
1.267     rillig    868: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    869: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    870: </dl></dd>
1.267     rillig    871: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    872: <dd><dl>
1.267     rillig    873: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    874: <dd><dl>
1.267     rillig    875: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    876: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia       877: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    878: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    879: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    880: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    881: <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>
                    882: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig    883: </dl></dd>
1.267     rillig    884: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    885: <dd><dl>
1.267     rillig    886: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    887: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    888: <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    889: </dl></dd>
                    890: </dl></dd>
1.267     rillig    891: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    892: <dd><dl>
1.267     rillig    893: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    894: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig    895: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                    896: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                    897: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                    898: <dd><dl>
                    899: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                    900: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    901: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       902: </dl></dd>
1.355     rillig    903: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                    904: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig    905: </dl></dd>
1.267     rillig    906: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    907: <dd><dl>
1.267     rillig    908: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    909: <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    910: </dl></dd>
1.267     rillig    911: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    912: builds)</a></span></dt>
1.75      rillig    913: <dd><dl>
1.267     rillig    914: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    915: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    916: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.390     wiz       917: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
                    918: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
                    919: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
                    920: <dd><dl>
                    921: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
                    922: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                    923: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
                    924: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
                    925: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
                    926: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
                    927: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
                    928: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
                    929: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
                    930: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.293     rillig    931: </dl></dd>
1.390     wiz       932: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
                    933: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    934: </dl></dd>
                    935: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    936: <dd><dl>
                    937: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    938: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    939: </dl></dd>
                    940: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    941: <dd><dl>
                    942: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    943: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    944: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    945: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    946: <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>
                    947: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    948: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    949: <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>
                    950: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot      951: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
                    952: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                    953: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336     nia       954: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    955: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    956: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    957: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    958: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
1.385     leot      959: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75      rillig    960: </dl></dd>
                    961: </dl>
                    962: </div>
1.148     asau      963: <div class="chapter">
1.75      rillig    964: <div class="titlepage"><div><div><h2 class="title">
1.385     leot      965: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
1.267     rillig    966: <p>
                    967:        To get help when using pkgsrc, the definitive source is this
                    968:        document, the pkgsrc guide. If you don't find anything here,
                    969:        there are alternatives:
                    970: </p>
                    971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    972: <li class="listitem">
                    973: <p>
                    974:        The built-in pkgsrc help, which is available after bootstrapping
1.385     leot      975:        pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.267     rillig    976:        help for any topic, such as a variable name like
                    977:        <code class="varname">BUILD_DEFS</code>, a make target like
                    978:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    979:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.385     leot      980: <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    981: </li>
                    982: <li class="listitem"><p>
1.278     rillig    983:        To see the value of a single variable, run <span class="command"><strong>bmake
                    984:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    985: </p></li>
                    986: <li class="listitem"><p>
                    987:        To see the values of the most common variables, run
                    988:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    989:        topic. To see the variables for a single topic, run
                    990:        <span class="command"><strong>bmake
                    991:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    992:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    993: </p></li>
                    994: <li class="listitem"><p>
1.267     rillig    995:        The pkgsrc-users mailing list, to which
                    996:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    997:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    998:        questions</a>.</p></li>
                    999: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland 1000:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig   1001:        or by using a specialized chat program such as
                   1002:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   1003:        Pick any user name and join the channel #pkgsrc.</p></li>
                   1004: </ul></div>
                   1005: </div>
                   1006: <div class="chapter">
                   1007: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1008: <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   1009: <div class="toc">
                   1010: <p><b>Table of Contents</b></p>
1.210     leot     1011: <dl class="toc">
1.267     rillig   1012: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig   1013: <dd><dl>
1.267     rillig   1014: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                   1015: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig   1016: </dl></dd>
1.267     rillig   1017: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig   1018: <dd><dl>
1.267     rillig   1019: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                   1020: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig   1021: </dl></dd>
                   1022: </dl>
                   1023: </div>
1.91      rillig   1024: <p>Before you download and extract the files, you need to decide
                   1025: where you want to extract them. When using pkgsrc as root user, pkgsrc
                   1026: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                   1027: free to install the sources and binary packages wherever you want in
                   1028: your filesystem, provided that the pathname does not contain white-space
                   1029: or other characters that are interpreted specially by the shell and some
                   1030: other programs. A safe bet is to use only letters, digits, underscores
                   1031: and dashes.</p>
1.148     asau     1032: <div class="sect1">
1.75      rillig   1033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1034: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1035: <p>Before you download any pkgsrc files, you should decide
                   1036:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1037:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1038:        quarterly basis from the current branch and only gets modified
                   1039:        for security updates. The names of the stable branches are built
                   1040:        from the year and the quarter, for example
1.385     leot     1041:        <code class="literal">2025Q4</code>.</p>
1.75      rillig   1042: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1043:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1044:        Both ways are described here.</p>
1.157     asau     1045: <p>Note that tar archive contains CVS working copy.
                   1046:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1047: <div class="sect2">
1.75      rillig   1048: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1049: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1050: <p>The primary download location for all pkgsrc files is
1.264     sevan    1051:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1052:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1053:        (it points to the same location).
                   1054:        There are a number of subdirectories for different purposes,
1.385     leot     1055:        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     1056: <p>The tar archive for the current branch is in the directory
1.264     sevan    1057:        <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    1058:        It is autogenerated weekly.</p>
1.157     asau     1059: <p>To save download time we provide bzip2- and
                   1060:        xz-compressed archives which are published at
1.264     sevan    1061:        <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     1062:        and
1.264     sevan    1063:        <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     1064:        respectively.
                   1065:        </p>
                   1066: <p>You can fetch the same files using FTP.</p>
1.385     leot     1067: <p>The tar file for the stable branch 2025Q4 is in the
                   1068:        directory <code class="filename">pkgsrc-2025Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1069: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1070: <pre class="screen">
1.385     leot     1071: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1072: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1073:        or your web browser.</p>
1.112     weinem   1074: <p>Then, extract it with:</p>
1.188     snj      1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1077:        in <code class="filename">/usr/</code> and all the package source will be 
                   1078:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1079: <p>To download pkgsrc-current, run:</p>
                   1080: <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   1081: </div>
1.148     asau     1082: <div class="sect2">
1.75      rillig   1083: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1084: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1085: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.385     leot     1086: <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-2025Q4 -P pkgsrc</code></strong>
1.128     wiz      1087: </pre>
                   1088: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1089:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1090:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1091: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1092: <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    1093: </pre>
1.289     leot     1094: <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      1095: <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      1096: <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      1097: </pre>
                   1098: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1099:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1100:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1101: <pre class="programlisting">
                   1102: # set CVS remote shell command
                   1103: CVS_RSH=ssh
                   1104: export CVS_RSH
                   1105: </pre>
                   1106: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1107:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1108:        in your home directory and saving the following lines to it.
                   1109:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1110:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1111: <pre class="programlisting">
                   1112: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1113: cvs -q
1.101     rillig   1114: checkout -P
1.103     wiz      1115: update -dP
                   1116: diff -upN
1.101     rillig   1117: rdiff -u
1.128     wiz      1118: release -d
1.101     rillig   1119: </pre>
1.75      rillig   1120: </div>
                   1121: </div>
1.148     asau     1122: <div class="sect1">
1.75      rillig   1123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1124: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1125: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1126:        (which also works if you have first installed it via a tar
                   1127:        file). It saves bandwidth and hard disk activity, compared to
                   1128:        downloading the tar file again.</p>
1.148     asau     1129: <div class="sect2">
1.75      rillig   1130: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1131: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1132: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1133: <h3 class="title">Warning</h3>
1.77      rillig   1134: <p>When updating from a tar file, you first need to
                   1135:        completely remove the old pkgsrc directory. Otherwise those
                   1136:        files that have been removed from pkgsrc in the mean time will
                   1137:        not be removed on your local disk, resulting in inconsistencies.
                   1138:        When removing the old files, any changes that you have done to
                   1139:        the pkgsrc files will be lost after updating. Therefore updating
                   1140:        via CVS is strongly recommended.</p>
1.75      rillig   1141: </div>
1.82      rillig   1142: <p>Note that by default the distfiles and the binary packages
                   1143:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1144:        before updating. You can also configure pkgsrc to store distfiles
                   1145:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1146:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.385     leot     1147:        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   1148: <p>To update pkgsrc from a tar file, download the tar file as
                   1149:        explained above. Then, make sure that you have not made any
                   1150:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1151:        directory and extract the new tar file. Done.</p>
                   1152: </div>
1.148     asau     1153: <div class="sect2">
1.75      rillig   1154: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1155: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1156: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1157: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1158: </pre>
                   1159: <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>
                   1160: <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>
                   1161: </pre>
1.148     asau     1162: <div class="sect3">
1.75      rillig   1163: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     1164: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1165: <p>When updating pkgsrc, the CVS program keeps track of the
                   1166:        branch you selected. But if you, for whatever reason, want to
                   1167:        switch from the stable branch to the current one, you can do it
1.385     leot     1168:        by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
                   1169:        <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75      rillig   1170:        back to the stable branch, add the
1.385     leot     1171:        <span class="quote">“<span class="quote">-rpkgsrc-2025Q4</span>”</span> option.</p>
1.75      rillig   1172: </div>
1.148     asau     1173: <div class="sect3">
1.75      rillig   1174: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     1175: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1176: <p>When you update pkgsrc, the CVS program will only touch
                   1177:        those files that are registered in the CVS repository. That
                   1178:        means that any packages that you created on your own will stay
                   1179:        unmodified. If you change files that are managed by CVS, later
                   1180:        updates will try to merge your changes with those that have been
                   1181:        done by others. See the CVS manual, chapter
1.385     leot     1182:        <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75      rillig   1183: </div>
                   1184: </div>
                   1185: </div>
                   1186: </div>
1.148     asau     1187: <div class="chapter">
1.75      rillig   1188: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1189: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1190: <div class="toc">
                   1191: <p><b>Table of Contents</b></p>
1.210     leot     1192: <dl class="toc">
1.267     rillig   1193: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1194: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1195: </dl>
                   1196: </div>
1.148     asau     1197: <div class="sect1">
1.75      rillig   1198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1199: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1200: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.82      rillig   1201: </div>
1.148     asau     1202: <div class="sect1">
1.82      rillig   1203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1204: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1205: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1206:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1207:     to privileged one all programs are installed under one particular user
1.149     asau     1208:     and cannot utilise privileged operations (packages don't create
                   1209:     special users and all special file permissions like setuid are ignored).
                   1210:     </p>
1.82      rillig   1211: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1212: <pre class="screen">
1.167     asau     1213: <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   1214: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1215: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1216:     </pre>
1.385     leot     1217: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1.149     asau     1218: <p>By default, in privileged mode pkgsrc uses
                   1219:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1220:     where programs will be installed in,
1.230     sevan    1221:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1222:     directory where pkgsrc will do its internal bookkeeping,
                   1223:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1224:     where packages install their persistent data.
                   1225:     In unprivileged mode pkgsrc uses
                   1226:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1227:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1228:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1229:     </p>
                   1230: <p>You can change default layout using command-line arguments.
1.385     leot     1231:     Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1.149     asau     1232:     </p>
1.148     asau     1233: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1234: <h3 class="title">Note</h3>
1.110     hubertf  1235: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1236:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1237:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.385     leot     1238:       instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75      rillig   1239: </div>
1.149     asau     1240: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1241: <h3 class="title">Note</h3>
                   1242: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1243:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1244:       corresponding to the installation you're working with to build
                   1245:       and install packages.
                   1246:       </p>
                   1247: </div>
1.75      rillig   1248: </div>
                   1249: </div>
1.148     asau     1250: <div class="chapter">
1.75      rillig   1251: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1252: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1253: <div class="toc">
                   1254: <p><b>Table of Contents</b></p>
1.210     leot     1255: <dl class="toc">
1.267     rillig   1256: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1257: <dd><dl>
1.267     rillig   1258: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1259: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia      1260: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1261: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1262: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1263: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1264: <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>
                   1265: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267     rillig   1266: </dl></dd>
                   1267: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1268: <dd><dl>
                   1269: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1270: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1271: <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   1272: </dl></dd>
                   1273: </dl>
                   1274: </div>
                   1275: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1276: is to only install the package tools and to use binary packages
1.385     leot     1277: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
                   1278: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88      wiz      1279: of pkgsrc, too. Then you are able to build your own packages,
                   1280: and you can still use binary packages from someone else.</p>
1.148     asau     1281: <div class="sect1">
1.75      rillig   1282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1283: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317     nia      1284: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1285:   site and mirrors, there are collections of binary packages,
1.109     rillig   1286:   ready to be installed. These binary packages have been built using the
                   1287:   default settings for the directories, that is:</p>
1.148     asau     1288: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1289: <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>
                   1290: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1291: <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   1292: </ul></div>
                   1293: <p>If you cannot use these directories for whatever reasons (maybe
                   1294:   because you're not root), you cannot use these binary packages, but
1.385     leot     1295:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.148     asau     1296: <div class="sect2">
1.75      rillig   1297: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1298: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1299: <p>To install binary packages, you first need to know from where
                   1300:     to get them. The first place where you should look is on the main
1.317     nia      1301:     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   1302: <p>This directory contains binary packages for multiple
1.341     gutterid 1303:     platforms. First, select your operating system. Then, select your
                   1304:     hardware architecture, and in the third step, the OS version and
1.385     leot     1305:     the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.341     gutterid 1306: <p>In this directory, you may find a file called
1.109     rillig   1307:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1308:     management tools. If the file is missing, it is likely that your
                   1309:     operating system already provides those tools. Download the file and
                   1310:     extract it in the <code class="filename">/</code> directory. It will create
                   1311:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1312:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1313: </div>
1.148     asau     1314: <div class="sect2">
1.75      rillig   1315: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1316: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1317: <p>In the directory from the last section, there is a
1.196     wiz      1318:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1319:     binary packages that are available for the platform, excluding those
1.317     nia      1320:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1321: <p>To install packages directly from an FTP or HTTP server, run
                   1322:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1323:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1324: <pre class="screen">
1.317     nia      1325: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1326: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1327: <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   1328: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317     nia      1329: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1330: </pre>
                   1331: <p>Instead of URLs, you can also use local paths, for example if
                   1332:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1333:     repository. If you want to install packages from multiple sources,
                   1334:     you can separate them by a semicolon in
                   1335:     <code class="varname">PKG_PATH</code>.</p>
                   1336: <p>After these preparations, installing a package is very
                   1337:     easy:</p>
                   1338: <pre class="screen">
1.317     nia      1339: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1340: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1341: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1342: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1343: </pre>
                   1344: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1345:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1346: <p>Any prerequisite packages needed to run the
1.88      wiz      1347:     package in question will be installed, too, assuming they are
1.317     nia      1348:     present in the repository.</p>
1.75      rillig   1349: <p>After you've installed packages, be sure to have
1.88      wiz      1350:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1351:     <code class="varname">PATH</code> so you can actually start the just
                   1352:     installed program.</p>
1.75      rillig   1353: </div>
1.148     asau     1354: <div class="sect2">
1.75      rillig   1355: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1356: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1.317     nia      1357: <p>To update binary packages, it is recommended that you use
                   1358:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1359:     package repository to your locally installed packages and safely
                   1360:     replace any older packages.</p>
                   1361: <p>Note that pkgsrc is released as quarterly branches.
                   1362:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1363:     need to adjust the repository in
                   1364:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1365: </div>
                   1366: <div class="sect2">
                   1367: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1368: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1369: <p>To deinstall a package, it does not matter whether it was
1.317     nia      1370:     installed from source code or from a binary package. Neither the
                   1371:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1372:     command need to know.</p>
                   1373: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1374:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317     nia      1375:     name can be given with or without version number.</p>
1.82      rillig   1376: </div>
1.148     asau     1377: <div class="sect2">
1.82      rillig   1378: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1379: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1380: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317     nia      1381:     installed packages or binary package files.
                   1382:     As with other management tools, it works with packages installed
                   1383:     from source or binaries.</p>
1.82      rillig   1384: </div>
1.148     asau     1385: <div class="sect2">
1.82      rillig   1386: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1387: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1388: <p>
1.279     leot     1389:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317     nia      1390:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1391:       included in pkgsrc.  The list is available from the NetBSD
1.317     nia      1392:       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>.
                   1393:     </p>
                   1394: <p>
                   1395:       Please note that not every "vulnerability" with a CVE assignment is
                   1396:       exploitable in every configuration.
                   1397:       Some bugs are marked as active simply because an fix was not
                   1398:       marked as such.
                   1399:       Operating system specific hardening and mitigation features may also
                   1400:       reduce the impact of bugs.
1.88      wiz      1401:     </p>
1.82      rillig   1402: <p>
1.125     wiz      1403:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1404:       this list can be downloaded
                   1405:       automatically, and a security audit of all packages installed on a system
                   1406:       can take place.
                   1407:     </p>
1.82      rillig   1408: <p>
1.125     wiz      1409:       There are two components to auditing.  The first
                   1410:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1411:       is for downloading
1.88      wiz      1412:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1413:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1414:       installed packages are vulnerable.  If a package is vulnerable, you
                   1415:       will see output similar to the following:
                   1416:     </p>
1.82      rillig   1417: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1418:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1419: <p>
1.125     wiz      1420:       You may wish to have the
1.317     nia      1421:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1422:       file downloaded daily so that
                   1423:       it remains current.  This may be done by adding an appropriate entry
1.378     leot     1424:       to the root users <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1425:       </p>
                   1426: <pre class="screen">
1.233     sevan    1427: # Download vulnerabilities file
1.230     sevan    1428: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1429: # Audit the installed packages and email results to root
                   1430: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1431:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1432:       </pre>
                   1433: <p>
1.230     sevan    1434:       will update the vulnerability list every day at 3AM, followed by an audit
                   1435:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1436: 
1.230     sevan    1437:       On NetBSD this may be accomplished instead by adding the following
                   1438:       line to <code class="filename">/etc/daily.conf</code>:
                   1439:       </p>
                   1440: <pre class="screen">
                   1441: fetch_pkg_vulnerabilities=YES
                   1442:       </pre>
                   1443: <p>
                   1444:       to fetch the vulnerability list from the daily security script. The system
                   1445:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1446:       desired (not required), by adding the following line to
1.230     sevan    1447: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1448:       </p>
                   1449: <pre class="screen">
1.230     sevan    1450: check_pkg_vulnerabilities=YES
1.125     wiz      1451:       </pre>
                   1452: <p>
1.378     leot     1453:       see <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1454:     </p>
1.82      rillig   1455: </div>
1.148     asau     1456: <div class="sect2">
1.82      rillig   1457: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1458: <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   1459: <p>
1.322     leot     1460:       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.385     leot     1461:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317     nia      1462:       argument to check if any packages are stale, e.g.
1.88      wiz      1463:     </p>
                   1464: <pre class="screen">
                   1465: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1466: ...
1.88      wiz      1467: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1468:     </pre>
1.82      rillig   1469: </div>
1.148     asau     1470: <div class="sect2">
1.82      rillig   1471: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1472: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1473: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1474:     administrative functions on the package system.</p>
1.82      rillig   1475: </div>
1.75      rillig   1476: </div>
1.148     asau     1477: <div class="sect1">
1.75      rillig   1478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1479: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1480: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1481:   directory now contains a set of packages, organized into
                   1482:   categories. You can browse the online index of packages, or run
1.110     hubertf  1483:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1484:   directory to build local <code class="filename">README.html</code> files for
1.322     leot     1485:   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      1486: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1487:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1488:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1489:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1490:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1491:   system (inside a chroot is an exception). </p>
                   1492: <p>The rest of this chapter assumes that the package is already
1.385     leot     1493:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88      wiz      1494:   instructions how to create your own packages.</p>
1.148     asau     1495: <div class="sect2">
1.75      rillig   1496: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1497: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1498: <p>To build packages from source, you need a working C
1.88      wiz      1499:     compiler. On NetBSD, you need to install the
1.385     leot     1500:     <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88      wiz      1501:     sets. If you want to build X11-related packages, the
1.385     leot     1502:     <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88      wiz      1503:     sets are required, too.</p>
1.75      rillig   1504: </div>
1.148     asau     1505: <div class="sect2">
1.75      rillig   1506: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1507: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1508: <p>The first step for building a package is downloading the
1.88      wiz      1509:     distfiles (i.e. the unmodified source). If they have not yet been
                   1510:     downloaded, pkgsrc will fetch them automatically.</p>
                   1511: <p>If you have all files that you need in the
                   1512:     <code class="filename">distfiles</code> directory,
                   1513:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1514:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1515:     </p>
1.82      rillig   1516: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1517: <p>
1.110     hubertf  1518:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1519: <p>By default a list of distribution sites will be randomly
                   1520:     intermixed to prevent huge load on servers which holding popular
                   1521:     packages (for example, SourceForge.net mirrors). Thus, every
                   1522:     time when you need to fetch yet another distfile all the mirrors
                   1523:     will be tried in new (random) order. You can turn this feature
                   1524:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1525:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1526: <p>You can overwrite some of the major distribution sites to
                   1527:     fit to sites that are close to your own.  By setting one or two
                   1528:     variables you can modify the order in which the master sites are
                   1529:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1530:     delimited list of domain suffixes.
                   1531:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1532:     contains a whitespace delimited list of regular expressions.  It
                   1533:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1534:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1535:     some examples.  This may save some of your bandwidth and
                   1536:     time.</p>
1.75      rillig   1537: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1538:     if you want to keep the settings, by editing the
1.110     hubertf  1539:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1540:     and adding the definitions there.</p>
1.82      rillig   1541: <p>
1.88      wiz      1542:       If a package depends on many other packages (such as
1.322     leot     1543:       <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      1544:       alternate between periods of
                   1545:       downloading source, and compiling. To ensure you have all the source
                   1546:       downloaded initially you can run the command:
                   1547:       </p>
1.82      rillig   1548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1549: <p>
1.88      wiz      1550:       which will output and run a set of shell commands to fetch the
                   1551:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1552:       also choose to download the files manually.
                   1553:     </p>
1.75      rillig   1554: </div>
1.148     asau     1555: <div class="sect2">
1.75      rillig   1556: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1557: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1558: <p>
1.88      wiz      1559:       Once the software has downloaded, any patches will be applied, then it
                   1560:       will be compiled for you. This may take some time depending on your
                   1561:       computer, and how many other packages the software depends on and their
                   1562:       compile time.
                   1563:     </p>
1.148     asau     1564: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1565: <h3 class="title">Note</h3>
                   1566: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1567:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.385     leot     1568:     <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75      rillig   1569: </div>
1.87      wiz      1570: <p>For example, type</p>
1.88      wiz      1571: <pre class="screen">
                   1572: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1573: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1574:     </pre>
1.75      rillig   1575: <p>at the shell prompt to build the various components of the
1.88      wiz      1576:     package.</p>
1.82      rillig   1577: <p>The next stage is to actually install the newly compiled
1.88      wiz      1578:     program onto your system. Do this by entering:
1.82      rillig   1579: 
1.88      wiz      1580:     </p>
1.82      rillig   1581: <pre class="screen">
1.88      wiz      1582: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1583:     </pre>
1.82      rillig   1584: <p>
                   1585: 
1.88      wiz      1586:     while you are still in the directory for whatever package you
                   1587:     are installing.</p>
1.82      rillig   1588: <p>Installing the package on your system may require you to
1.88      wiz      1589:     be root.  However, pkgsrc has a
                   1590:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1591:     to only become root for the actual installation step.</p>
1.82      rillig   1592: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1593:     You can now enter:
1.82      rillig   1594: 
1.88      wiz      1595:     </p>
1.82      rillig   1596: <pre class="screen">
1.88      wiz      1597: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1598:     </pre>
1.82      rillig   1599: <p>
                   1600: 
1.88      wiz      1601:     to remove the compiled files in the work directory, as you shouldn't need
                   1602:     them any more. If other packages were also added to your system
                   1603:     (dependencies) to allow your program to compile, you can tidy these up
                   1604:     also with the command:</p>
1.82      rillig   1605: <pre class="screen">
1.88      wiz      1606: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1607:     </pre>
1.75      rillig   1608: <p>Taking the figlet utility as an example, we can install it on our
1.385     leot     1609:     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      1610: <p>The program is installed under the default root of the
                   1611:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1612:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1613:     variable in your environment, and it will use that value as the
                   1614:     root of your packages tree. So, to use
                   1615:     <code class="filename">/usr/local</code>, set
                   1616:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1617:     Please note that you should use a directory which is dedicated to
                   1618:     packages and not shared with other programs (i.e., do not try and
                   1619:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1620:     to add any of your own files or directories (such as
                   1621:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1622:     <code class="filename">pkgsrc/</code>) below the
                   1623:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1624:     conflicts between programs and other files installed by the
                   1625:     package system and whatever else may have been installed
                   1626:     there.</p>
1.110     hubertf  1627: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1628:     alter some configuration options at build time.  Have a look at
                   1629:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1630:     of what will be set there by default.  Environment variables such
                   1631:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1632:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1633:     set them each time you want to use pkgsrc.</p>
1.385     leot     1634: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
                   1635:     covers</span>”</span> to see what is going on when a package is building
1.88      wiz      1636:     or being installed. This may be for debugging purposes, or out of
                   1637:     simple curiosity. A number of utility values have been added to
                   1638:     help with this.</p>
1.128     wiz      1639: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1640: <li class="listitem">
1.378     leot     1641: <p>If you invoke the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1642:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1643:        information will be displayed. For example,</p>
1.75      rillig   1644: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1645: <p>will show all the commands that are invoked, up to and
1.385     leot     1646:        including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75      rillig   1647: </li>
1.128     wiz      1648: <li class="listitem">
1.378     leot     1649: <p>If you want to know the value of a certain <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1650:        definition, then the <code class="varname">VARNAME</code> definition
                   1651:        should be used, in conjunction with the show-var
1.378     leot     1652:        target. e.g. to show the expansion of the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1653:        variable <code class="varname">LOCALBASE</code>:</p>
                   1654: <pre class="screen">
                   1655: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1656: /usr/pkg
                   1657: <code class="prompt">%</code>
1.88      wiz      1658:        </pre>
1.75      rillig   1659: </li>
                   1660: </ol></div>
                   1661: <p>If you want to install a binary package that you've either
1.88      wiz      1662:     created yourself (see next section), that you put into
                   1663:     pkgsrc/packages manually or that is located on a remote FTP
                   1664:     server, you can use the "bin-install" target. This target will
1.378     leot     1665:     install a binary package - if available - via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1666:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1667:     sites searched is kept in the variable
                   1668:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.378     leot     1669:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1670:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1671:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1672:     details.</p>
                   1673: <p>A final word of warning: If you set up a system that has a
                   1674:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1675:     set that before any packages are installed, as you cannot use
                   1676:     several directories for the same purpose. Doing so will result in
                   1677:     pkgsrc not being able to properly detect your installed packages,
                   1678:     and fail miserably. Note also that precompiled binary packages are
                   1679:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1680:     <code class="filename">/usr/pkg</code>, and that you should
                   1681:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1682:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1683: </div>
                   1684: </div>
                   1685: </div>
1.148     asau     1686: <div class="chapter">
1.75      rillig   1687: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1688: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1689: <div class="toc">
                   1690: <p><b>Table of Contents</b></p>
1.210     leot     1691: <dl class="toc">
1.267     rillig   1692: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1693: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig   1694: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                   1695: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                   1696: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                   1697: <dd><dl>
                   1698: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                   1699: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1700: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1701: </dl></dd>
1.355     rillig   1702: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                   1703: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig   1704: </dl>
                   1705: </div>
1.104     rillig   1706: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1707: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1708: that file depends on the installation. On NetBSD, when you use
1.378     leot     1709: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1710: <code class="filename">/etc/</code>. In all other cases the default location is
                   1711: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1712: bootstrap program to install the binary packages.</p>
                   1713: <p>The format of the configuration file is that of the usual
                   1714: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1715: is done by setting variables in this file. Note that you can define all
                   1716: kinds of variables, and no special error checking (for example for
1.223     rillig   1717: spelling mistakes) takes place.</p>
1.148     asau     1718: <div class="sect1">
1.75      rillig   1719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1720: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1721: <p>The following variables apply to all
1.89      rillig   1722:     pkgsrc packages. A complete list of the variables that can be
                   1723:     configured by the user is available in
                   1724:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1725:     comments that describe each variable's intent.</p>
1.148     asau     1726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1727: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1728:            packages will be installed. The default is
1.76      rillig   1729:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1730:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1731: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1.385     leot     1732:            <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75      rillig   1733:            installed. The default is
1.76      rillig   1734:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1735: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1736:            X11 is installed on the system. The default is
1.194     bsiegert 1737:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1738: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1739:            downloaded copies of the original source distributions used
                   1740:            for building pkgsrc packages. The default is
1.76      rillig   1741:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1742: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1743:            database about installed packages is stored.  The default is
1.230     sevan    1744:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1745: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1746:            If set, override the packages'
                   1747:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1748: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1749:            Backup location(s) for distribution files and patch files
                   1750:            if not found locally or in
1.76      rillig   1751:            <code class="filename">${MASTER_SITES}</code> or
                   1752:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1753:            The defaults is
                   1754:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1755: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1756:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1757:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.385     leot     1758:            release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
                   1759:            (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1.128     wiz      1760: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1761:            List of acceptable licenses. License names are case-sensitive.
                   1762:            Whenever you try to build a package whose license is not in this
                   1763:            list, you will get an error message. If the license condition is
                   1764:            simple enough, the error message will include specific
                   1765:            instructions on how to change this variable.</p></li>
1.75      rillig   1766: </ul></div>
                   1767: </div>
1.148     asau     1768: <div class="sect1">
1.75      rillig   1769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1770: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1771: <p>
1.75      rillig   1772:       </p>
1.148     asau     1773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1774: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1775:            directory for the binary packages. The default is
1.76      rillig   1776:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1777: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1778:            The top level directory where, if defined, the separate
                   1779:            working directories will get created, and symbolically
1.76      rillig   1780:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1781:            This is useful for building packages on several
1.76      rillig   1782:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1783:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1784:            is local to every architecture. (It should be noted that
                   1785:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1786:            &mdash; it is an internal definition which refers to the
1.75      rillig   1787:            root of the pkgsrc tree. It is possible to have many
                   1788:            pkgsrc tree instances.)</p></li>
1.128     wiz      1789: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1790:            Directory for local patches that aren't part of pkgsrc.
1.385     leot     1791:            See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.93      rillig   1792:            information.</p></li>
1.128     wiz      1793: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1794:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1795:            BSD-style Makefile. If this is not set,
                   1796:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1797:            <code class="filename">/dev/null</code> to avoid picking up
                   1798:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1799: </ul></div>
                   1800: </div>
1.148     asau     1801: <div class="sect1">
1.75      rillig   1802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1803: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1.355     rillig   1804: <p>Whenever a package depends on a package that has a
                   1805:     <code class="filename">builtin.mk</code> file, the dependent package can
                   1806:     either use the built-in (native) version from the base system or the
                   1807:     pkgsrc-provided version.  This only affects dependencies, so it is
                   1808:     still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
                   1809:     on the native pcre++ version instead.</p>
                   1810: <p>To force using the pkgsrc-provided version for a particular
1.385     leot     1811:     package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
                   1812:     <em class="replaceable"><code>package-ID</code></em></span>”</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
1.355     rillig   1813:     using the native package, define
1.385     leot     1814:     <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
                   1815:     <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1.355     rillig   1816:     <em class="replaceable"><code>package-ID</code></em> is the one from the
                   1817:     <code class="filename">buildlink3.mk</code> of the package. In most cases,
                   1818:     this ID is the same as the directory name of the package, but for
                   1819:     example, <code class="filename">devel/pcre++</code> has the
1.385     leot     1820:     package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1.355     rillig   1821: <p>For the packages that are not listed by their package ID,
                   1822:     pkgsrc uses the pkgsrc-provided version if
                   1823:     <code class="varname">PREFER_PKGSRC</code> contains the word
1.385     leot     1824:     <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
                   1825:     contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1.355     rillig   1826:     version. For example, to require using the pkgsrc-provided versions
                   1827:     for all but the most basic bits on a NetBSD system, you can
                   1828:     set:</p>
                   1829: <pre class="programlisting">
                   1830: PREFER_PKGSRC=  yes
                   1831: PREFER_NATIVE=  getopt skey tcp_wrappers
                   1832: </pre>
                   1833: <p>A package <span class="emphasis"><em>must</em></span> have a
                   1834:     <code class="filename">builtin.mk</code> file to be listed in
                   1835:     <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
                   1836:     that list.</p>
                   1837: <p><code class="varname">PREFER_PKGSRC</code> and
                   1838:     <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
                   1839:     ensure that the bootstrap process does not use inapropriate native
                   1840:     tools as dependencies for core packages.</p>
                   1841: <pre class="screen">
                   1842: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   1843: </pre>
                   1844: <p>Switching between settings globally at a later date can
                   1845:     introduce complications with dependency resolution.  This is caused
                   1846:     by packages built with the opposite preference being installed
                   1847:     alongside each other.  Hence, when changing any of these variables
                   1848:     after bootstrap, you need to rebuild all packages depending on those
                   1849:     whose preference has been changed.  This is not trivial and should
                   1850:     be avoided.</p>
                   1851: <p>When using pkgsrc on Linux systems, there is high risk of
1.385     leot     1852:     <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1.355     rillig   1853:     inadvertently use a command or library not installed by pkgsrc, e.g.
                   1854:     those installed by yum or apt.  Such foreign dependencies may be
                   1855:     installed, removed, or upgraded to a version incompatible with the
                   1856:     pkgsrc package at any time, causing pkgsrc packages to subsequently
                   1857:     malfunction.  Pkgsrc cannot prevent this, as it has no control over
                   1858:     other package managers. Another potential problem is that under
                   1859:     Redhat Enterprise and related Linux systems, yum packages are only
                   1860:     patched and never upgraded, so eventually they may become too
                   1861:     outdated for use by pkgsrc.  Even intentionally using foreign
                   1862:     dependencies, not considered leakage, can lead to these problems, so
                   1863:     it is generally discouraged.  In order to minimize such problems,
1.385     leot     1864:     PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1.355     rillig   1865:     pkgsrc is aware of any changes to dependency packages and can
                   1866:     rebuild or upgrade the entire dependency tree as needed.  This
                   1867:     default can be overridden by setting --prefer-pkgsrc to a
1.385     leot     1868:     list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.355     rillig   1869: </div>
                   1870: <div class="sect1">
                   1871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1872: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1873: <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     1874:                 By default, binary packages of built packages are
1.263     leot     1875:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1876:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1877: <p>Packages have to support installation into a
1.103     wiz      1878:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1879:     to be built, before the actual filesystem is touched. DESTDIR
                   1880:     support exists in two variations:</p>
1.148     asau     1881: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1882: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1883:       installation and packaging is still run as root.</p></li>
                   1884: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1885:       build, installation and packaging as normal user. Root
                   1886:       privileges are only needed to add packages.</p></li>
                   1887: </ul></div>
1.103     wiz      1888: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1889:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1890: <p>Considering the <code class="filename">foo/bar</code> package,
                   1891:     DESTDIR full support can be tested using the following commands
                   1892: 
                   1893: </p>
                   1894: <pre class="programlisting">
                   1895: <code class="prompt">$</code> id
                   1896: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1897: <code class="prompt">$</code> mkdir $HOME/packages
                   1898: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1899: </pre>
                   1900: <p>
                   1901: 
                   1902:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1903:     should be needed
                   1904: 
                   1905: </p>
                   1906: <pre class="programlisting">
1.174     asau     1907: <code class="prompt">$</code> make stage-install
1.118     imil     1908: </pre>
                   1909: <p>
                   1910: 
                   1911:     Create a package without root privileges
                   1912: 
                   1913: </p>
                   1914: <pre class="programlisting">
1.174     asau     1915: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1916: </pre>
                   1917: <p>
                   1918: 
                   1919:     For the following command, you must be able to gain root
1.378     leot     1920:     privileges using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1921: 
                   1922: </p>
                   1923: <pre class="programlisting">
1.174     asau     1924: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1925: </pre>
                   1926: <p>
                   1927: 
                   1928:     Then, as a simple user
                   1929: 
                   1930: </p>
                   1931: <pre class="programlisting">
                   1932: <code class="prompt">$</code> make clean
                   1933: </pre>
                   1934: <p>
                   1935: 
                   1936:     </p>
1.103     wiz      1937: </div>
1.148     asau     1938: <div class="sect1">
1.103     wiz      1939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1940: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1941: <div class="sect2">
1.78      rillig   1942: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1943: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1944: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1945:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1946: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1947: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1948: <dd>
                   1949: <p>This is a list of values specifying the chain of
                   1950:          compilers to invoke when building packages.  Valid values
                   1951:          are:</p>
1.148     asau     1952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1953: <li class="listitem"><p><code class="varname">ccc</code>:
                   1954:            Compaq C Compilers (Tru64)</p></li>
                   1955: <li class="listitem"><p><code class="varname">ccache</code>:
                   1956:            compiler cache (chainable)</p></li>
                   1957: <li class="listitem"><p><code class="varname">clang</code>:
                   1958:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1959: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1960:            distributed C/C++ (chainable)</p></li>
1.174     asau     1961: <li class="listitem"><p><code class="varname">f2c</code>:
                   1962:            Fortran 77 to C compiler (chainable)</p></li>
                   1963: <li class="listitem"><p><code class="varname">icc</code>:
                   1964:            Intel C++ Compiler (Linux)</p></li>
                   1965: <li class="listitem"><p><code class="varname">ido</code>:
                   1966:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1967: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1968:            GNU C/C++ Compiler</p></li>
1.174     asau     1969: <li class="listitem"><p><code class="varname">hp</code>:
                   1970:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1971: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1972:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1973: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1974:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1975: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1976:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1977: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1978:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1979: </ul></div>
                   1980: <p>The default is
1.385     leot     1981:          <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>.  You can use
1.89      rillig   1982:          <code class="varname">ccache</code> and/or
                   1983:          <code class="varname">distcc</code> with an appropriate
                   1984:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.385     leot     1985:          e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>.  This
1.94      dmcmahil 1986:          variable should always be terminated with a value for
                   1987:          a real compiler.  Note that only one real compiler
1.385     leot     1988:          should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94      dmcmahil 1989:          is not allowed).</p>
1.89      rillig   1990: </dd>
                   1991: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1992: <dd><p>This specifies the minimum version of GCC to use
                   1993:          when building packages.  If the system GCC doesn't
                   1994:          satisfy this requirement, then pkgsrc will build and
                   1995:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1996: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1997: <dd><p>Specifies which version of python to use when several
                   1998:          options are available.</p></dd>
                   1999: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 2000: <dd><p>Specifies the Fortran compiler to use.
                   2001:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     2002: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   2003: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   2004:          <code class="varname">gfortran</code> is used, this option specifies which
                   2005:          version to use.</p></dd>
1.89      rillig   2006: </dl></div>
                   2007: </div>
1.148     asau     2008: <div class="sect2">
1.89      rillig   2009: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2010: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2011: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2012:        please make sure to use the <code class="literal">+=</code> operator
                   2013:        instead of the <code class="literal">=</code> operator:</p>
                   2014: <pre class="programlisting">
1.100     rillig   2015: CFLAGS+=        -your -flags
1.78      rillig   2016: </pre>
                   2017: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.385     leot     2018:        <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117     jnemeth  2019:        need to add their own flags.  You may want to take a look
1.322     leot     2020:        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      2021:        package if you're interested in optimization specifically
                   2022:        for the current CPU. </p>
1.78      rillig   2023: </div>
1.148     asau     2024: <div class="sect2">
1.88      wiz      2025: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2026: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2027: <p>If you want to pass flags to the linker, both in the configure
                   2028: step and the build step, you can do this in two ways.  Either set
                   2029: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2030: between the two is that <code class="varname">LIBS</code> will be appended to
                   2031: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2032: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2033: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2034: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2035: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2036: settings, use the <code class="literal">+=</code> operator:</p>
                   2037: <pre class="programlisting">
1.100     rillig   2038: LDFLAGS+=        -your -linkerflags
1.88      wiz      2039: </pre>
                   2040: </div>
1.78      rillig   2041: </div>
1.148     asau     2042: <div class="sect1">
1.78      rillig   2043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2044: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 2045: <p>
1.75      rillig   2046:       </p>
1.148     asau     2047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2048: <li class="listitem">
1.75      rillig   2049: <p><code class="varname">PKG_DEVELOPER</code>:
1.347     gutterid 2050:         Run some sanity checks that package developers want:
                   2051:         </p>
1.148     asau     2052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2053: <li class="listitem"><p>make sure patches apply with zero
1.347     gutterid 2054:             fuzz</p></li>
1.128     wiz      2055: <li class="listitem"><p>run check-shlibs to see that all
1.347     gutterid 2056:             binaries will find their shared libs.</p></li>
1.75      rillig   2057: </ul></div>
                   2058: </li>
1.347     gutterid 2059: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>: 
                   2060:         Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
                   2061:         </code> values in PLIST entries.
                   2062:         </p></li>
1.128     wiz      2063: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347     gutterid 2064:         of debugging output which is displayed whilst making and
                   2065:         installing the package.  The default value for this is 0,
                   2066:         which will not display the commands as they are executed
                   2067:         (normal, default, quiet operation); the value 1 will display
                   2068:         all shell commands before their invocation, and the value 2
                   2069:         will display both the shell commands before their invocation,
                   2070:         as well as their actual execution progress with <span class="command"><strong>set
                   2071:         -x</strong></span>.</p></li>
1.75      rillig   2072: </ul></div>
                   2073: <p>
                   2074:     </p>
                   2075: </div>
1.148     asau     2076: <div class="sect1">
1.75      rillig   2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2078: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.88      wiz      2079: <p>Some packages have build time options, usually to select
                   2080:     between different dependencies, enable optional support for big
                   2081:     dependencies or enable experimental features.</p>
1.75      rillig   2082: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2083:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2084:     show-options</strong></span>, for example:</p>
1.75      rillig   2085: <pre class="programlisting">
                   2086:     The following options are supported by this package:
                   2087:         ssl      Enable SSL support.
                   2088:     Exactly one of the following gecko options is required:
                   2089:         firefox  Use firefox as gecko rendering engine.
                   2090:         mozilla  Use mozilla as gecko rendering engine.
                   2091:     At most one of the following database options may be selected:
                   2092:         mysql    Enable support for MySQL database.
                   2093:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2094: 
1.75      rillig   2095:     These options are enabled by default: firefox
                   2096:     These options are currently enabled: mozilla ssl
1.1       grant    2097: </pre>
1.75      rillig   2098: <p>The following variables can be defined in
1.110     hubertf  2099:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2100:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2101:     which can be used to select or disable options for all packages
                   2102:     that support them, and
                   2103:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2104:     which can be used to select or disable options specifically for
                   2105:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.385     leot     2106:     these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88      wiz      2107:     are disabled. A few examples:</p>
1.75      rillig   2108: <pre class="screen">
1.110     hubertf  2109: <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   2110: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2111: PKG_OPTIONS.kdebase=    debug -sasl
                   2112: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2113: <p>It is important to note that options that were specifically
1.120     snj      2114:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2115:     you do not wish to include the option.  If you are unsure you can view
                   2116:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2117: <p>The following settings are consulted in the order given, and
                   2118:     the last setting that selects or disables an option is
                   2119:     used:</p>
1.128     wiz      2120: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2121: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2122:       maintainer</p></li>
1.128     wiz      2123: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2124:       variables (see below)</p></li>
1.128     wiz      2125: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2126: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2127: </ol></div>
                   2128: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2129:     selected is used, all others are automatically disabled.  If an
                   2130:     option of the group is explicitly disabled, the previously
                   2131:     selected option, if any, is used.  It is an error if no option
                   2132:     from a required group of options is selected, and building the
                   2133:     package will fail.</p>
                   2134: <p>Before the options framework was introduced, build options
                   2135:     were selected by setting a variable (often named
                   2136:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2137:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2138:     transition to the options framework for the user, these legacy
                   2139:     variables are converted to the appropriate options setting
                   2140:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2141:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2142:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2143:     directly.  Support for the legacy variables will be removed
                   2144:     eventually.</p>
1.75      rillig   2145: </div>
                   2146: </div>
1.148     asau     2147: <div class="chapter">
1.75      rillig   2148: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2149: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2150: <div class="toc">
                   2151: <p><b>Table of Contents</b></p>
1.210     leot     2152: <dl class="toc">
1.267     rillig   2153: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2154: <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   2155: </dl>
                   2156: </div>
1.148     asau     2157: <div class="sect1">
1.75      rillig   2158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2159: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2160: <p>Once you have built and installed a package, you can create
                   2161:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.378     leot     2162:     another system with <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2163:     the same package on a group of hosts and wasting CPU time. It also
                   2164:     provides a simple means for others to install your package, should
                   2165:     you distribute it.</p>
                   2166: <p>To create a binary package, change into the appropriate
1.110     hubertf  2167:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2168:     package</strong></span>:</p>
                   2169: <pre class="screen">
1.223     rillig   2170: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2171: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2172: </pre>
1.356     gutterid 2173: <p>This will build your package (if not already done) and package
                   2174:     it into a binary package. You can then use the
                   2175:     <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
                   2176:     created in <code class="varname">PACKAGES</code>, which defaults to
                   2177:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
1.385     leot     2178:     tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
1.356     gutterid 2179:     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>
                   2180:     example.</p>
1.385     leot     2181: <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      2182:     such a binary package.</p>
1.75      rillig   2183: </div>
1.148     asau     2184: <div class="sect1">
1.75      rillig   2185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2186: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2187: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.106     rillig   2188: </div>
                   2189: </div>
1.148     asau     2190: <div class="chapter">
1.106     rillig   2191: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2192: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2193: builds)</h2></div></div></div>
                   2194: <div class="toc">
                   2195: <p><b>Table of Contents</b></p>
1.210     leot     2196: <dl class="toc">
1.267     rillig   2197: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2198: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2199: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.390     wiz      2200: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
                   2201: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
                   2202: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
                   2203: <dd><dl>
                   2204: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
                   2205: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                   2206: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
                   2207: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
                   2208: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
                   2209: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2210: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
                   2211: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
                   2212: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
                   2213: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2214: </dl></dd>
1.390     wiz      2215: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2216: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2217: </dl>
                   2218: </div>
1.290     gutterid 2219: <p>For a number of reasons, you may want to build binary packages
                   2220: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2221: For instance, when you have multiple machines that should run the same software,
                   2222: it is wasted time if they all build their packages themselves from source.
                   2223: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2224: deploying onto production systems.
1.180     wiz      2225: There is a way of getting a set of binary packages:
1.290     gutterid 2226: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2227: This chapter describes how to set it up.</p>
1.148     asau     2228: <div class="sect1">
1.106     rillig   2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2230: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2231: <p>First of all, you have to decide whether you build all packages
                   2232: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2233: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2234: A number of particularly heavy packages exist that are not actually
                   2235: interesting to a wide audience. (The approximate resource consumption for a
1.390     wiz      2236: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.4. Requirements of a full bulk build">Section 8.4, “Requirements of a full bulk build”</a>.)
1.290     gutterid 2237: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2238: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2239: </p>
                   2240: <p>During bulk builds various packages are installed and deinstalled
                   2241: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2242: so make sure that you don't need any package during the builds.
1.223     rillig   2243: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2244: or something even more restrictive, depending on what the operating system provides,
                   2245: or dedicate the whole physical machine.
                   2246: As a useful side effect this makes sure that bulk builds cannot
                   2247: break anything in your system. There have been numerous cases where
1.106     rillig   2248: certain packages tried to install files outside the
                   2249: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2250: <code class="filename">/etc</code>.
                   2251: </p>
1.106     rillig   2252: </div>
1.148     asau     2253: <div class="sect1">
1.106     rillig   2254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2255: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
1.295     rillig   2256: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2258: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2259: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2260: </ul></div>
1.148     asau     2261: <div class="sect2">
1.116     rillig   2262: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2263: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2264: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2265: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2266: Configure network access to fetch distribution files.
1.223     rillig   2267: Create a user with name "pbulk".</p>
1.178     asau     2268: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2269: <pre class="screen">
1.264     sevan    2270: <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>
                   2271: <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      2272: <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     2273: </pre>
                   2274: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2275: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2276: <pre class="screen">
1.230     sevan    2277: <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     2278: <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>
                   2279: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2280: </pre>
                   2281: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2282: <h3 class="title">Note</h3>
                   2283: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2284: <code class="filename">mk.conf</code> that contains settings you want to
                   2285: apply to packages you build. For instance,</p>
                   2286: <pre class="programlisting">
1.223     rillig   2287: PKG_DEVELOPER=          yes     # perform more checks
                   2288: X11_TYPE=               modular # use pkgsrc X11
                   2289: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2290:                                 # when building all packages)
1.178     asau     2291: </pre>
                   2292: </div>
                   2293: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2294: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2295: <pre class="programlisting">
                   2296: www/firefox
                   2297: mail/thunderbird
                   2298: misc/libreoffice4
                   2299: </pre>
1.179     asau     2300: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2301: and make final amendments, if wanted.</p>
1.178     asau     2302: <p>Start it:</p>
                   2303: <pre class="screen">
                   2304: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2305: </pre>
                   2306: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2307: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2308: </p>
                   2309: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2310: <h3 class="title">Note</h3>
                   2311: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2312: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2313: The script is kept small enough for better understanding.</p>
                   2314: </div>
                   2315: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2316: <h3 class="title">Note</h3>
                   2317: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320     wiz      2318: unprivileged bulk build and helps configuring distributed bulk builds.
                   2319: Distributed bulk builds support either building in worker chroots
                   2320: (each node is a path to a different chroot)
                   2321: that replicate the target system, including the pbulk prefix,
                   2322: or remote machines (each node is
                   2323: an IP address that must be accessible over SSH without a password).</p>
1.178     asau     2324: </div>
1.106     rillig   2325: </div>
                   2326: </div>
1.148     asau     2327: <div class="sect1">
1.106     rillig   2328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.390     wiz      2329: <a name="bulk.scan"></a>8.3. Speeding up bulk build scans</h2></div></div></div>
                   2330: <p>At the start of a bulk build. pkgsrc is scanned for details
                   2331:   about the packages to build. This is needed e.g. to build a
                   2332:   dependency graph for building the packages in the correct
                   2333:   order.</p>
                   2334: <p>Basically, this calls <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> once for each package. To
                   2335:   speed this up, some variables can be pre-computed and others can be
                   2336:   cached. This will greatly reduce the time needed for the scan part
                   2337:   of a bulk build.</p>
                   2338: <p>The fake <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/varcache/index.html" target="_top"><code class="filename">pkgtools/varcache</code></a>
                   2339:   package provides a Makefile target to precompute some often-used
                   2340:   variables for the build system that shouldn't change during one
                   2341:   build. Redirect its output to a file and include it from
                   2342:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>; for example:</p>
                   2343: <pre class="screen">
                   2344: <code class="prompt">$</code> <strong class="userinput"><code>cd pkgtools/varcache</code></strong>
                   2345: <code class="prompt">$</code> <strong class="userinput"><code>make show-varcache &gt; /etc/varcache.mk</code></strong>
                   2346: <code class="prompt">$</code> <strong class="userinput"><code>echo .include "varcache.mk" &gt;&gt; /etc/mk.conf</code></strong>
                   2347:   </pre>
                   2348: <p>Some system information is needed quite early in the build
                   2349:   and can not be cached this way. It must be set in the environment
                   2350:   for the next speed-up:</p>
                   2351: <pre class="screen">
                   2352: <code class="prompt">$</code> <strong class="userinput"><code>export HOST_MACHINE_ARCH=`uname -m`</code></strong>
                   2353: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS=`uname -s`</code></strong>
                   2354: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS_VERSION=`uname -r | awk -F. '{major=int($1); minor=int($2); if (minor&gt;=100) minor=99; patch=int($3); if (patch&gt;=100) patch=99; printf "%02d%02d%02d", major, minor, patch}'`</code></strong>
                   2355: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OS_VERSION=`uname -r`</code></strong>
                   2356:   </pre>
                   2357: <p>Some settings that also affect the scan time strongly can be set in
                   2358:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
                   2359: <pre class="programlisting">
                   2360: NATIVE_PKG_TOOLS_BIN=/usr/sbin # location on NetBSD
                   2361: NO_PKGTOOLS_REQD_CHECK=yes     # assume pkg tools are up-to-date
                   2362: SKIP_LICENSE_CHECK=yes         # do not check license validity
                   2363: _SRC_TOP_=                     # bulk build is not running from inside /usr/src
                   2364: UNPRIVILEGED_USER=pbulk        # use the appropriate user for your system
                   2365: UNPRIVILEGED_GROUP=builder     # use the appropriate group for your system
                   2366: UNPRIVILEGED_GROUPS=builder    # use the appropriate groups for your system
                   2367: </pre>
                   2368: <p>Finally, some packages require information about build options
                   2369: of other packages. This information can be cached by setting
                   2370: <code class="varname">PBULK_CACHE_DIRECTORY</code>.</p>
                   2371: <pre class="programlisting">
                   2372: PBULK_CACHE_DIRECTORY=/tmp/pbulk_cache
                   2373: </pre>
                   2374: <p>For all of these: please make sure they are kept up-to-date for
                   2375: changes in your environment. The safest method is to re-create the
                   2376: varcache before each build, make sure the environment variables are
                   2377: still up-to-date, and to delete the
                   2378: <code class="varname">PBULK_CACHE_DIRECTORY</code> before builds.</p>
                   2379: </div>
                   2380: <div class="sect1">
                   2381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2382: <a name="bulk.req"></a>8.4. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2383: <p>A complete bulk build requires lots of disk space. Some of the
                   2384: disk space can be read-only, some other must be writable. Some can be on
                   2385: remote filesystems (such as NFS) and some should be local. Some can be
                   2386: temporary filesystems, others must survive a sudden reboot.</p>
                   2387: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320     wiz      2388: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2389: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180     wiz      2390: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2391: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2392: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2393: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2394: </ul></div>
                   2395: </div>
                   2396: <div class="sect1">
                   2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.390     wiz      2398: <a name="bulk.var"></a>8.5. Bulk build variants</h2></div></div></div>
1.293     rillig   2399: <p>To ensure that pkgsrc packages work in different configurations, it
                   2400: makes sense to run non-default bulk builds from time to time. This
                   2401: section lists some ideas for bulk builds that intentionally let packages
                   2402: fail if they don't follow the pkgsrc style.</p>
                   2403: <div class="sect2">
                   2404: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2405: <a name="bulk.var.confopt"></a>8.5.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2406: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2407: <pre class="programlisting">
                   2408: GNU_CONFIGURE_STRICT=   yes
                   2409: </pre>
                   2410: <p>When a package fails this additional check, the most common cause
                   2411: is that the configure option was valid for an older version of the
                   2412: package but does not apply anymore. In that case, just remove it.</p>
                   2413: </div>
                   2414: <div class="sect2">
                   2415: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2416: <a name="bulk.var.comperr"></a>8.5.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2417: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2418: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2419: compiler wrappers make it easy to force compiler options when the package
                   2420: is built. This can be used to find typical bugs across all packages that
                   2421: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2422: more reliable with the next updates.</p>
                   2423: <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   2424: <pre class="programlisting">
                   2425: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2426: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2427: </pre>
1.294     rillig   2428: <p>When a package fails to build using these stricter compiler
                   2429: options, document the circumstances in which the compiler produced the
                   2430: error message. This includes:</p>
1.293     rillig   2431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2432: <li class="listitem"><p>The platform
                   2433: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2434: <li class="listitem"><p>The source file</p></li>
                   2435: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2436: part of the diagnostic.</p></li>
1.294     rillig   2437: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2438: </ul></div>
                   2439: <p>If a package produces these error messages, but the package is
1.294     rillig   2440: 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
                   2441: in the next builds:</p>
1.293     rillig   2442: <pre class="programlisting">
1.294     rillig   2443: .if ${PKGPATH} == category/package
1.293     rillig   2444: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2445: # error message
                   2446: # code
1.294     rillig   2447: # Reason why the code does not need to be fixed.
1.293     rillig   2448: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2449: .endif
1.293     rillig   2450: </pre>
                   2451: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2452: needs to be fixed, prepare a local patch (see
                   2453: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2454: authors of the package, providing them with the information you collected
                   2455: above.</p>
                   2456: <p>Patches that are not essential for the package to work should only
                   2457: be reported upstream but not committed to pkgsrc, to make future updates
                   2458: easier.</p>
1.293     rillig   2459: </div>
                   2460: <div class="sect2">
                   2461: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2462: <a name="bulk.var.builderr"></a>8.5.3. Force compiler options only in the build phase</h3></div></div></div>
1.296     rillig   2463: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2464: these apply to all phases of the package build process. Especially in the
                   2465: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2466: decisions. The GNU configure scripts feed many small test programs to the
                   2467: C compiler to see whether certain headers are available, functions are
                   2468: defined in a library and programs can be run. In many cases these
                   2469: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2470: -Wextra -Werror</code>.</p>
                   2471: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2472: options being added between the <code class="literal">configure</code> and
                   2473: <code class="literal">build</code> phases. It's a little more complicated than the
                   2474: other examples in this section but still easy enough.</p>
                   2475: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2476: desired compiler options. The compiler wrapper's original task is to hide
                   2477: unwanted directories of include files and to normalize compiler options.
                   2478: It does this by wrapping the compiler command and rewriting the command
                   2479: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2480: package directory and examine the
                   2481: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2482: individual configurations for the C compiler and the related tools. The
                   2483: plan is to find a hook between the configure and build phases, and to
                   2484: modify these configuration files at that point.</p>
                   2485: <p>To find this hook, have a look at
                   2486: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2487: <code class="literal">pre-build-checks-hook</code>. The word
                   2488: <code class="literal">checks</code> doesn't quite fit, but the
                   2489: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2490: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2491: <pre class="programlisting">
                   2492: # Just a few example options.
                   2493: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2494: 
                   2495: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2496: pre-build-checks-hook: add-build-only-cflags
                   2497: 
                   2498: add-build-only-cflags: .PHONY
                   2499:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2500:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2501:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2502:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2503:         done;                                   \
                   2504:         &gt; ${.TARGET}
                   2505: .endif
                   2506: </pre>
                   2507: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2508: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2509: not with spaces.)</p>
                   2510: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2511: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2512: should be undefined, possibly because it is only defined for a subset of
                   2513: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2514: at least one compiler option, to prevent a syntax error in the shell
                   2515: parser.</p>
                   2516: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2517: that the additional compiler options are only appended once, even if
                   2518: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2519: creates a marker file.</p>
                   2520: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2521: configure</strong></span> in a package directory. Up to now, everything works
                   2522: as usual. Examine the directory
                   2523: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2524: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2525: the file <code class="filename">cc</code>. Examine the tail of the
                   2526: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2527: options are used.</p>
                   2528: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2529: options to the file <code class="filename">cc</code> and will create the marker
                   2530: file in the same directory. After that, the build starts as usual, but
                   2531: with the added compiler options. Examine the tail of the file
                   2532: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2533: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2534: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2535: with these options.</p>
                   2536: <p>Building packages using this setup variant and fixing the resulting
1.390     wiz      2537: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.5.2. Detect classes of bugs by forcing compiler warnings">Section 8.5.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
1.296     rillig   2538: </div>
                   2539: <div class="sect2">
                   2540: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2541: <a name="bulk.var.dirs"></a>8.5.4. Use custom directories</h3></div></div></div>
1.293     rillig   2542: <p>Some directories like <code class="varname">PREFIX</code>,
                   2543: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2544: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2545: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2546: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2547: <pre class="programlisting">
                   2548: PREFIX=         /a-random-uuid
                   2549: PKG_SYSCONFDIR= /a-random-uuid
                   2550: VARBASE=        /a-random-uuid
                   2551: PKGMANDIR=     a-random-uuid
                   2552: PKG_INFODIR=   a-random-uuid
                   2553: </pre>
                   2554: </div>
                   2555: <div class="sect2">
                   2556: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2557: <a name="bulk.var.warn"></a>8.5.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2558: <p>When building a package, warnings are typically ignored since they
                   2559: just flow by and do not cause the build to fail immediately. To find
                   2560: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2561: <pre class="programlisting">
                   2562: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2563: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2564: </pre>
                   2565: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2566: them can be redefined with a simple definition like above.</p>
1.294     rillig   2567: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2568: the package Makefile, research whether the package actually needs Perl.
                   2569: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2570: Makefile, and if it doesn't, add
                   2571: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2572: </div>
                   2573: <div class="sect2">
                   2574: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2575: <a name="bulk.var.pkglint"></a>8.5.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2576: <p>Using pkglint as part of the regular build process is mostly a
                   2577: waste of time. If you want to fix some of the warnings, just run pkglint
                   2578: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2579: 10), which is much faster than a complete bulk build.</p>
                   2580: </div>
                   2581: <div class="sect2">
                   2582: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2583: <a name="bulk.var.strings"></a>8.5.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2584: <p>To ensure that the binary packages don't contain references to the
                   2585: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2586: that variable includes the item <code class="literal">extra</code>, it is
                   2587: possible to define additional patterns that must not appear in any
                   2588: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2589: <pre class="programlisting">
                   2590: CHECK_WRKREF=                   extra
                   2591: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2592: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2593: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2594: </pre>
                   2595: <p>The above patterns will probably generate many false positives,
                   2596: therefore the results need to be taken with a grain of salt.</p>
                   2597: </div>
                   2598: <div class="sect2">
                   2599: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2600: <a name="bulk.var.test"></a>8.5.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2601: <p>To run the test suites that come with each package, add this line
                   2602: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2603: <pre class="programlisting">
                   2604: PKGSRC_RUN_TEST=        yes
                   2605: </pre>
                   2606: <p>Be prepared that even the most basic packages fail this test. When
                   2607: doing a bulk build with this, it will often abort in the early phase
                   2608: where the packages are scanned for their dependencies since there are
                   2609: cyclic dependencies. There is still a lot to do in this area.</p>
                   2610: </div>
                   2611: <div class="sect2">
                   2612: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2613: <a name="bulk.var.shvar"></a>8.5.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2614: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2615: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2616: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2617: <pre class="programlisting">
                   2618: RUN=    @set -eu;
                   2619: </pre>
1.296     rillig   2620: <p>After that, ensure that none of the bulk build log files (even
                   2621: those for successfully built packages) contains the string
                   2622: <code class="literal">parameter not set</code> or whatever error message the
                   2623: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2624: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2625: definition.</p>
                   2626: </div>
                   2627: <div class="sect2">
                   2628: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2629: <a name="bulk.var.quiet"></a>8.5.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2630: <p>The build logs of a package are often quite long. This allows error
                   2631: messages or other interesting details to hide between the noise. To make
                   2632: the actual error message stand out more, add these lines to
                   2633: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2634: <pre class="programlisting">
                   2635: GNU_CONFIGURE_QUIET=    yes
                   2636: MAKE_FLAGS+=            -s
                   2637: </pre>
                   2638: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2639: Make. On exotic platforms with their own make, it may be a little
                   2640: different.</p>
                   2641: </div>
                   2642: </div>
                   2643: <div class="sect1">
                   2644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.390     wiz      2645: <a name="creating-cdroms"></a>8.6. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2646: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2647:     create a CD-ROM set of the resulting binary packages to assist
                   2648:     in installing packages on other machines.  The
1.322     leot     2649:     <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      2650:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2651:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2652:     way that keeps all the dependencies for a given package on the same
                   2653:     CD as that package.</p>
1.148     asau     2654: <div class="sect2">
1.75      rillig   2655: <div class="titlepage"><div><div><h3 class="title">
1.390     wiz      2656: <a name="cdpack-example"></a>8.6.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2657: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2658:       man page. The following short example assumes that the binary
                   2659:       packages are left in
                   2660:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2661:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2662:       hold the ISO 9660 images.</p>
                   2663: <pre class="screen">
                   2664: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2665: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2666: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2667:       </pre>
                   2668: <p>If you wish to include a common set of files
                   2669:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2670:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2671:       directory which contains these files, e.g.:</p>
1.87      wiz      2672: <pre class="screen">
                   2673: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2674: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2675: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2676: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2677: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2678: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2679: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2680:       </pre>
1.75      rillig   2681: <p>Now create the images:</p>
                   2682: <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   2683: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2684:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2685:       in their root directories.</p>
1.75      rillig   2686: </div>
                   2687: </div>
                   2688: </div>
1.148     asau     2689: <div class="chapter">
1.75      rillig   2690: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2691: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2692: <div class="toc">
                   2693: <p><b>Table of Contents</b></p>
1.210     leot     2694: <dl class="toc">
1.267     rillig   2695: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2696: <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   2697: </dl>
                   2698: </div>
                   2699: <p>The files that are installed by pkgsrc are organized in a way that
                   2700: is similar to what you find in the <code class="filename">/usr</code> directory
                   2701: of the base system. But some details are different. This is because
                   2702: pkgsrc initially came from FreeBSD and had adopted its file system
                   2703: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2704: which operating system you are using pkgsrc with, you can expect the
                   2705: same layout for pkgsrc.</p>
1.91      rillig   2706: <p>There are mainly four root directories for pkgsrc, which are all
                   2707: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2708: When pkgsrc has been installed as root, the default locations
                   2709: are:</p>
                   2710: <pre class="programlisting">
1.100     rillig   2711: LOCALBASE=              /usr/pkg
                   2712: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2713: VARBASE=                /var
1.231     sevan    2714: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2715: </pre>
                   2716: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2717: user), the default locations are:</p>
                   2718: <pre class="programlisting">
1.100     rillig   2719: LOCALBASE=              ${HOME}/pkg
                   2720: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2721: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2722: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2723: </pre>
                   2724: <p>What these four directories are for, and what they look like is
                   2725: explained below.</p>
1.148     asau     2726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2727: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2728: <code class="filename">/usr</code> directory in the base system. It is the
1.385     leot     2729: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90      rillig   2730: the well-known subdirectories like <code class="filename">bin</code>,
                   2731: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2732: <code class="filename">share</code> and
                   2733: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2734: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2735: <code class="filename">/var</code> in the base system. Some programs (especially
                   2736: games, network daemons) need write access to it during normal
                   2737: operation.</p></li>
1.128     wiz      2738: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2739: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2740: 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   2741: itself.</p></li>
                   2742: </ul></div>
1.148     asau     2743: <div class="sect1">
1.90      rillig   2744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2745: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2746: </h2></div></div></div>
1.90      rillig   2747: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2748: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2749: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2750: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2751: <dd><p>Contains executable programs that are intended to be
                   2752: directly used by the end user.</p></dd>
                   2753: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2754: <dd><p>Contains files for the emulation layers of various other
                   2755: operating systems, especially for
                   2756: NetBSD.</p></dd>
                   2757: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2758: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2759: <dd><p>Contains
                   2760: the configuration files.</p></dd>
                   2761: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2762: <dd><p>Contains headers for the C and C++ programming
                   2763: languages.</p></dd>
                   2764: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2765: <dd><p>Contains GNU info files of various
                   2766: packages.</p></dd>
                   2767: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2768: <dd><p>Contains shared and static
                   2769: libraries.</p></dd>
                   2770: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2771: <dd><p>Contains data files that don't change after
                   2772: installation. Other data files belong into
                   2773: <code class="filename">${VARBASE}</code>.</p></dd>
                   2774: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2775: <dd><p>Contains programs that are not intended to be used by
                   2776: end users, such as helper programs or network
                   2777: daemons.</p></dd>
                   2778: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2779: <dd><p>Contains programs that are intended to be executed as
                   2780: CGI scripts by a web server.</p></dd>
                   2781: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2782: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2783: <dd><p>Contains brief
                   2784: documentation in form of manual pages.</p></dd>
                   2785: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2786: <dd><p>Contains programs that are intended to be used only by
                   2787: the super-user.</p></dd>
                   2788: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2789: <dd><p>Contains platform-independent data files that don't
                   2790: change after installation.</p></dd>
                   2791: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2792: <dd><p>Contains documentation files provided by the
                   2793: packages.</p></dd>
                   2794: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2795: <dd><p>Contains example files provided by the packages. Among
                   2796: others, the original configuration files are saved here and copied to
                   2797: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2798: installation.</p></dd>
                   2799: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2800: <dd><p>Contains the original files for rc.d
                   2801: scripts.</p></dd>
                   2802: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2803: <code class="filename">${VARBASE}</code>)</span></dt>
                   2804: <dd><p>Contains files
                   2805: that may be modified after
                   2806: installation.</p></dd>
                   2807: </dl></div>
                   2808: </div>
1.148     asau     2809: <div class="sect1">
1.90      rillig   2810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2811: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2812: </h2></div></div></div>
1.148     asau     2813: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2814: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2815: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2816: <dd><p>Contains
                   2817: information about the currently installed
                   2818: packages.</p></dd>
                   2819: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2820: <dd><p>Contains highscore
                   2821: files.</p></dd>
                   2822: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2823: <dd><p>Contains log files.</p></dd>
                   2824: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2825: <dd><p>Contains informational files about daemons that are
                   2826: currently running.</p></dd>
                   2827: </dl></div>
                   2828: </div>
                   2829: </div>
1.148     asau     2830: <div class="chapter">
1.90      rillig   2831: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2832: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2833: <div class="toc">
                   2834: <p><b>Table of Contents</b></p>
1.210     leot     2835: <dl class="toc">
1.267     rillig   2836: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2837: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2838: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2839: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2840: <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>
                   2841: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2842: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2843: <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>
                   2844: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot     2845: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
                   2846: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                   2847: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336     nia      2848: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig   2849: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2850: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2851: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2852: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
1.385     leot     2853: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75      rillig   2854: </dl>
                   2855: </div>
                   2856: <p>This section contains hints, tips &amp; tricks on special things in
                   2857: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2858: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2859: <div class="sect1">
1.75      rillig   2860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2861: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2862: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2864: <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   2865:          This is a general purpose list for most issues regarding
                   2866:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2867:          for pkgsrc configuration, unexpected build failures, using
                   2868:          particular packages, upgrading pkgsrc installations,
                   2869:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2870:          proposals for changes that impact the pkgsrc user community,
                   2871:          e.g. major infrastructure changes, new features, package
                   2872:          removals, etc., may also be posted.</p></li>
1.289     leot     2873: <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   2874:          A list where the results of pkgsrc bulk builds are sent and
                   2875:          discussed.</p></li>
1.289     leot     2876: <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   2877:          This list is for those who are interested in getting a
                   2878:          commit message for every change committed to pkgsrc. It is
                   2879:          also available in digest form, meaning one daily message
                   2880:          containing all commit messages for changes to the package
                   2881:          source tree in that 24 hour period.</p></li>
                   2882: </ul></div>
                   2883: <p>To subscribe, do:</p>
                   2884: <pre class="programlisting">
1.100     rillig   2885: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2886: </pre>
                   2887: <p>Archives for all these mailing lists are available from
1.289     leot     2888: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
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.385     leot     2892: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2893: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2894: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2895: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2896: they might be useful, and not to duplicate the documentation that comes
                   2897: with each package.</p>
                   2898: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322     leot     2899: <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   2900:       Symlinks for use by buildlink.</p></li></ul></div>
                   2901: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2902: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2903: <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    2904:       Calculates various kinds of checksums (including SHA3).</p></li>
1.322     leot     2905: <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   2906:       Compatibility library for pkgsrc tools.</p></li>
1.322     leot     2907: <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      2908:       non-BSD systems due to lack of native mtree.</p></li>
1.322     leot     2909: <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   2910:       Up-to-date replacement for
1.76      rillig   2911:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2912:       systems where pkg_install is not present.</p></li>
                   2913: </ul></div>
                   2914: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2915: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2916: <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   2917:       Create a binary package from an
1.110     hubertf  2918:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2919:       save the old package.</p></li>
1.322     leot     2920: <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   2921:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2922:       from multiple locations. It currently supports the following
                   2923:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322     leot     2924: <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  2925:       the best compiler flags to optimise code for your current
1.128     wiz      2926:       CPU and compiler. </p></li>
1.75      rillig   2927: </ul></div>
                   2928: <p>Utilities for keeping track of installed packages, being up to date,
                   2929: etc:</p>
1.148     asau     2930: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2931: <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      2932:     update tool similar to apt(1). Download, install, and upgrade
                   2933:     binary packages easily.</p></li>
1.322     leot     2934: <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   2935:       packages whose installed versions do not match the latest pkgsrc
                   2936:       entries.</p></li>
1.322     leot     2937: <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   2938:       dependency graphs of packages, to aid in choosing a strategy for
                   2939:       updating.</p></li>
1.322     leot     2940: <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
                   2941:       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>
                   2942: <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   2943:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322     leot     2944: <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   2945:       does various checks on the complete pkgsrc system.</p></li>
1.322     leot     2946: <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   2947:       packages you have installed.</p></li>
                   2948: </ul></div>
                   2949: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2951: <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   2952:       making and maintaining patches for a package (includes pkgdiff,
                   2953:       pkgvi, mkpatches, etc.).</p></li>
1.322     leot     2954: <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   2955:       converting to pkgsrc.</p></li>
                   2956: </ul></div>
                   2957: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2958: utilities)</p>
1.148     asau     2959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2960: <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   2961:       packages in a chrooted area.</p></li>
1.322     leot     2962: <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   2963:       kernel version for chrooted cross builds.</p></li>
                   2964: </ul></div>
                   2965: </div>
1.148     asau     2966: <div class="sect1">
1.75      rillig   2967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2968: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2969: <p>To install packages from source as a non-root user, download
1.385     leot     2970: 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   2971: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2972: --unprivileged</strong></span>.</p>
                   2973: <p>This will install the binary part of pkgsrc to
                   2974: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2975: into <code class="filename">~/pkg/etc</code>.</p>
                   2976: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2977: </div>
1.148     asau     2978: <div class="sect1">
1.75      rillig   2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2980: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2981: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2982: enable this feature by adding the option
                   2983: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2984: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2985: distfile is found, pkgsrc will try to resume it.</p>
                   2986: <p>You can also
1.168     wiz      2987: use a different program than the platform default program by changing the
1.117     jnemeth  2988: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2989: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2990: by using the value manual.  A value of custom disables the system defaults
                   2991: and dependency tracking for the fetch program.  In that case you have to
                   2992: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2993: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2994: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2995: <p>For example, if you want to use
1.117     jnemeth  2996: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2997: like:</p>
                   2998: <pre class="programlisting">
1.223     rillig   2999: FETCH_USING=    wget
1.1       grant    3000: </pre>
1.75      rillig   3001: </div>
1.148     asau     3002: <div class="sect1">
1.75      rillig   3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3004: <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      3005: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3006: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3007: you will have to add the following line into
1.110     hubertf  3008: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3009: <pre class="programlisting">
1.103     wiz      3010: X11_TYPE=modular
1.1       grant    3011: </pre>
1.75      rillig   3012: </div>
1.148     asau     3013: <div class="sect1">
1.75      rillig   3014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3015: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3016: <p>If you are sitting behind a firewall which does not allow direct
                   3017: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3018: relevant proxy hosts.  This is done using an environment variable in the
                   3019: form of a URL, e.g. in Amdahl, the machine
1.385     leot     3020: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75      rillig   3021: port 80 as the proxy port number.  So the proxy environment variables
                   3022: are:</p>
                   3023: <pre class="programlisting">
1.100     rillig   3024: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3025: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3026: </pre>
1.75      rillig   3027: </div>
1.148     asau     3028: <div class="sect1">
1.75      rillig   3029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3030: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      3031: <p>Some fetch tools are not prepared to support HTTPS by default
                   3032: (for example, the one in NetBSD 6.0), or the one installed by the
                   3033: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   3034: dependency graph).</p>
                   3035: <p>Usually you won't notice, because distribution files are
1.385     leot     3036: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
1.173     wiz      3037: be often enough if you are following pkgsrc-current. In that case, set
                   3038: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
1.385     leot     3039: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
1.173     wiz      3040: with HTTPS support by default. Of course, these tools need to be
                   3041: installed before you can use them this way.</p>
                   3042: </div>
                   3043: <div class="sect1">
                   3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3045: <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   3046: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3047: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3048: the first available command from the following list:</p>
1.148     asau     3049: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3050: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3051: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3052: </ul></div>
                   3053: <p>On a default NetBSD installation, this will be
1.76      rillig   3054: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3055: connections first, and falls back to active connections if the server
                   3056: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3057: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3058: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3059: <p>Having that option present will prevent
1.76      rillig   3060: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3061: transfers.</p>
                   3062: </div>
1.148     asau     3063: <div class="sect1">
1.75      rillig   3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3065: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3066: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3067: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3068: 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   3069: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3070: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3071: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3072: resulting list to your machine at work/school and use it there.  If you
1.378     leot     3073: don't have a NetBSD-compatible <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3074: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3075: URL:</p>
                   3076: <p>At home:</p>
                   3077: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3078: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3079: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3080: <p>At work:</p>
                   3081: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3082: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3083: home.</p>
                   3084: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3085: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3086: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3087: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3088: directly by running:</p>
1.75      rillig   3089: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3090: <p>If you even decide to ignore
                   3091: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3092: by running:</p>
                   3093: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3094: </div>
1.148     asau     3095: <div class="sect1">
1.75      rillig   3096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3097: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
                   3098: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322     leot     3099: <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   3100: package, you get the error from make that it doesn't know how to make
1.76      rillig   3101: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.385     leot     3102: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75      rillig   3103: the NetBSD base distribution on your machine.  It is recommended to do
                   3104: that to format man pages.</p>
1.322     leot     3105: <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   3106: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3107: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3108: </div>
1.148     asau     3109: <div class="sect1">
1.75      rillig   3110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3111: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87      wiz      3112: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3113: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3114: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3115: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3116: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3117: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3118: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3119: -r</strong></span>).</p>
                   3120: </div>
1.148     asau     3121: <div class="sect1">
1.75      rillig   3122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3123: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75      rillig   3124: <p>When installing packages as non-root user and using the just-in-time
1.378     leot     3125: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3126: password for each required package installed.  To avoid this, the sudo
                   3127: package can be used, which does password caching over a limited time.  To
1.336     nia      3128: use it, install <span class="command"><strong>sudo</strong></span> or
                   3129: <span class="command"><strong>priv</strong></span> (either as binary package, from
                   3130: <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     3131: <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  3132: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3133: <span class="emphasis"><em>after</em></span> the definition of the
                   3134: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3135: <pre class="programlisting">
1.100     rillig   3136: .if exists(${LOCALBASE}/bin/sudo)
1.379     wiz      3137: SU_CMD=        ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.100     rillig   3138: .endif
1.1       grant    3139: </pre>
1.379     wiz      3140: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
                   3141: <span class="command"><strong>sudo</strong></span> to preserve the environment.
                   3142: Without this, the bin-install target will fail when building a
                   3143: package with a non-default python version.
                   3144: </p>
1.75      rillig   3145: </div>
1.148     asau     3146: <div class="sect1">
1.75      rillig   3147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3148: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3149: <p>As the system administrator, you can choose where configuration files
                   3150: are installed.  The default settings make all these files go into
1.76      rillig   3151: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3152: be suboptimal depending on your expectations (e.g., a read-only,
                   3153: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3154: configuration of the provided packages).</p>
                   3155: <p>In order to change the defaults, you can modify the
                   3156: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3157: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3158: directory; some common examples include <code class="filename">/etc</code> or
                   3159: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3160: <p>Furthermore, you can change this value on a per-package basis by
                   3161: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3162: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3163: package you would like to modify, that is, the contents of
                   3164: <code class="varname">PKGBASE</code>.</p>
                   3165: <p>Note that after changing these settings, you must rebuild and
                   3166: reinstall any affected packages.</p>
                   3167: </div>
1.148     asau     3168: <div class="sect1">
1.75      rillig   3169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3170: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3171: <p>Please be aware that there can often be bugs in third-party software,
                   3172: and some of these bugs can leave a machine vulnerable to exploitation by
                   3173: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3174: maintains a database of known-exploits to packages which have at one time
                   3175: been included in pkgsrc.  The database can be downloaded automatically, and
                   3176: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3177: do this, refer to the following two tools (installed as part of the
1.322     leot     3178: <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      3179: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3180: <li class="listitem">
1.122     reed     3181: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3182:     download a list of the security vulnerabilities information.  This list
1.132     spz      3183:     is kept up to date by the pkgsrc security team, and is distributed
                   3184:     from the NetBSD ftp server:</p>
1.292     leot     3185: <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   3186: </li>
1.128     wiz      3187: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3188:     current machine, checking each known vulnerability.  If a
1.75      rillig   3189:     vulnerable package is installed, it will be shown by output to stdout,
                   3190:     including a description of the type of vulnerability, and a URL
                   3191:     containing more information.</p></li>
                   3192: </ol></div>
1.233     sevan    3193: <p>Use of these tools is strongly recommended!
1.385     leot     3194: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.233     sevan    3195: reporting.</p>
                   3196: <p>If this database is installed, pkgsrc builds will use it to
                   3197: perform a security check before building any package.</p>
1.75      rillig   3198: </div>
1.148     asau     3199: <div class="sect1">
1.75      rillig   3200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3201: <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   3202: <p>When you add your own preferences to the
                   3203:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3204:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3205:        environment variables to the <code class="filename">./configure</code>
1.378     leot     3206:        scripts and to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3207:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3208:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3209:        package.</p>
                   3210: <p>Currently there is no solution to this problem. If you
                   3211:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3212:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3213:        directory and then inspect any <code class="filename">Makefile</code> and
                   3214:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3215:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.385     leot     3216:        these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75      rillig   3217:        programmers write so bad code that it only works for the
                   3218:        specific combination of <code class="varname">CFLAGS</code> they have
                   3219:        chosen.</p>
1.287     rillig   3220: <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>
                   3221: <pre class="programlisting">
                   3222: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3223: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3224: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3225: </pre>
                   3226: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3227: to see whether the above flags are passed to the actual build
                   3228: commands in general.</p>
                   3229: <p>To find out whether the flags are passed to individual compiler
                   3230: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3231: most cases, the flags from the original command lines (the lines starting
                   3232: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3233: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3234: missing from the actual compiler command, it must have been removed by
1.385     leot     3235: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3236: </div>
1.148     asau     3237: <div class="sect1">
1.80      rillig   3238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3239: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3240: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3241: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3242:        case that occurs often is that people only update pkgsrc in
                   3243:        parts, because of performance reasons. Since pkgsrc is one large
                   3244:        system, not a collection of many small systems, there are
                   3245:        sometimes changes that only work when the whole pkgsrc tree is
                   3246:        updated.</p></li>
1.148     asau     3247: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.385     leot     3248:        Search for <span class="quote">“<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>”</span> or
                   3249:        <span class="quote">“<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>”</span> in all your pkgsrc
1.80      rillig   3250:        files.</p></li>
1.148     asau     3251: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3252:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3253:        verify this.</p></li>
1.218     rillig   3254: <li class="step"><p>If you are a package developer who wants to invest
1.385     leot     3255:        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     3256: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3257:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3258: </ol></div>
                   3259: </div>
1.148     asau     3260: <div class="sect1">
1.88      wiz      3261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3262: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89      rillig   3263: <p>You have modified a file from pkgsrc, and someone else has
                   3264: modified that same file afterwards in the CVS repository. Both changes
                   3265: are in the same region of the file, so when you updated pkgsrc, the
                   3266: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3267: file. Because of these markers, the file is no longer a valid
                   3268: <code class="filename">Makefile</code>.</p>
                   3269: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3270: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3271: -dP</strong></span> in that directory to download the current version.</p>
                   3272: </div>
1.75      rillig   3273: </div>
                   3274: </div>
1.148     asau     3275: <div class="part">
1.75      rillig   3276: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     3277: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3278: <div class="partintro">
1.77      rillig   3279: <div></div>
                   3280: <p>This part of the book deals with creating and
1.385     leot     3281:        modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77      rillig   3282:        guide on creating a new package. The remaining chapters are more
                   3283:        like a reference manual for pkgsrc.</p>
1.75      rillig   3284: <div class="toc">
                   3285: <p><b>Table of Contents</b></p>
1.210     leot     3286: <dl class="toc">
1.267     rillig   3287: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3288: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3289: <dd><dl>
1.299     rillig   3290: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3291: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3292: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3293: <dd><dl>
1.299     rillig   3294: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3295: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3296: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3297: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3298: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3299: </dl></dd>
1.299     rillig   3300: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3301: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3302: <dd><dl>
                   3303: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3304: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3305: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3306: </dl></dd>
                   3307: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3308: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3309: </dl></dd>
1.299     rillig   3310: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3311: <dd><dl>
1.299     rillig   3312: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3313: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3314: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3315: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3316: <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   3317: <dd><dl>
1.299     rillig   3318: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3319: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3320: </dl></dd>
1.299     rillig   3321: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3322: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3323: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3324: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3325: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3326: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3327: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3328: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3329: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3330: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3331: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3332: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3333: </dl></dd>
                   3334: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3335: <dd><dl>
                   3336: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3337: <dd><dl>
1.334     nia      3338: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   3339: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   3340: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig   3341: </dl></dd>
1.299     rillig   3342: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3343: <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   3344: </dl></dd>
1.299     rillig   3345: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3346: <dd><dl>
1.299     rillig   3347: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3348: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3349: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3350: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3351: <dd><dl>
1.299     rillig   3352: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3353: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3354: <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>
                   3355: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 3356: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig   3357: </dl></dd>
                   3358: </dl></dd>
1.299     rillig   3359: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3360: <dd><dl>
1.299     rillig   3361: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3362: <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>
                   3363: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3364: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3365: </dl></dd>
1.299     rillig   3366: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3367: <dd><dl>
1.299     rillig   3368: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3369: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3370: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3371: </dl></dd>
                   3372: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3373: <dd><dl>
                   3374: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3375: <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   3376: <dd><dl>
1.299     rillig   3377: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3378: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3379:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3380:       and
                   3381:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3382:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3383: </dl></dd>
1.299     rillig   3384: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig   3385: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig   3386: </dl></dd>
                   3387: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3388: <dd><dl>
1.299     rillig   3389: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3390: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3391: <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>
                   3392: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3393: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3394: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3395: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3396: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3397: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3398: </dl></dd>
1.299     rillig   3399: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3400: <dd><dl>
                   3401: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3402: <dd><dl>
                   3403: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3404: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3405: </dl></dd>
1.299     rillig   3406: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3407: <dd><dl>
1.299     rillig   3408: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3409: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353     dholland 3410: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   3411: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   3412: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   3413: </dl></dd>
                   3414: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3415: <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>
                   3416: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3417: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3418: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3419: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3420: <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   3421: </dl></dd>
                   3422: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3423: <dd><dl>
                   3424: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3425: <dd><dl>
                   3426: <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>
                   3427: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3428: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3429: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3430: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3431: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3432: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3433: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3434: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3435: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3436: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3437: </dl></dd>
                   3438: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3439: <dd><dl>
                   3440: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3441: <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>
                   3442: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3443: </dl></dd>
                   3444: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3445: <dd><dl>
                   3446: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3447: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3448: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      3449: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      3450: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   3451: </dl></dd>
                   3452: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3453: <dd><dl>
                   3454: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3455: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      3456: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      3457: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   3458: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   3459: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   3460: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   3461: </dl></dd>
                   3462: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3463: <dd><dl>
                   3464: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3465: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3466: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot     3467: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.287     rillig   3468: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3469: </dl></dd>
                   3470: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3471: <dd><dl>
                   3472: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3473: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3474: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3475: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3476: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      3477: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      3478: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   3479: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   3480: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   3481: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   3482: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   3483: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   3484: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   3485: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   3486: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   3487: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      3488:     emulation</a></span></dt>
1.369     wiz      3489: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   3490: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig   3491: </dl></dd>
1.267     rillig   3492: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3493: </dl></dd>
1.299     rillig   3494: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3495: <dd><dl>
                   3496: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3497: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3498: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3499: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3500: </dl></dd>
1.267     rillig   3501: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3502: <dd><dl>
1.267     rillig   3503: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3504: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3505: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3506: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3507: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3508: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3509: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3510: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3511: </dl></dd>
1.382     wiz      3512: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                   3513: <dd><dl>
                   3514: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   3515: <dd><dl>
                   3516: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   3517: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   3518: </dl></dd>
                   3519: </dl></dd>
                   3520: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig   3521: </dl>
                   3522: </div>
1.77      rillig   3523: </div>
1.148     asau     3524: <div class="chapter">
1.77      rillig   3525: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     3526: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
1.267     rillig   3527: <p>
                   3528:        To get help when developing pkgsrc, the definitive source is this
                   3529:        document, the pkgsrc guide. If you don't find anything here,
                   3530:        there are alternatives:
                   3531: </p>
                   3532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3533: <li class="listitem">
                   3534: <p>
                   3535:        The built-in pkgsrc help, which is available after bootstrapping
1.385     leot     3536:        pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.267     rillig   3537:        help for any topic, such as a variable name like
                   3538:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3539:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3540:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.385     leot     3541: <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   3542: </li>
                   3543: <li class="listitem"><p>
1.278     rillig   3544:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3545:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3546: </p></li>
                   3547: <li class="listitem"><p>
                   3548:        To see the values of the most common variables, run
                   3549:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3550:        topic. To see the variables for a single topic, run
                   3551:        <span class="command"><strong>bmake
                   3552:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3553:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3554: </p></li>
                   3555: <li class="listitem"><p>
1.267     rillig   3556:        The tech-pkg mailing list, to which
                   3557:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3558:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3559:        questions</a>.</p></li>
                   3560: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland 3561:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig   3562:        or by using a specialized chat program such as
                   3563:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3564:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3565: </ul></div>
                   3566: </div>
                   3567: <div class="chapter">
                   3568: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     3569: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3570: <div class="toc">
                   3571: <p><b>Table of Contents</b></p>
1.210     leot     3572: <dl class="toc">
1.299     rillig   3573: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3574: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3575: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3576: <dd><dl>
                   3577: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3578: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3579: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3580: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3581: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3582: </dl></dd>
                   3583: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3584: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3585: <dd><dl>
                   3586: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3587: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3588: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3589: </dl></dd>
1.299     rillig   3590: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3591: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3592: </dl>
                   3593: </div>
1.299     rillig   3594: <p>Whenever you're preparing a package, there are a number of
                   3595: files involved which are described in the following
                   3596: sections.</p>
                   3597: <div class="sect1">
                   3598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3599: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
1.299     rillig   3600: </h2></div></div></div>
                   3601: <p>Building, installation and creation of a binary package are all
                   3602:   controlled by the package's <code class="filename">Makefile</code>.
                   3603:   The <code class="filename">Makefile</code> describes various things about
                   3604:   a package, for example from where to get it, how to configure,
                   3605:   build, and install it.</p>
                   3606: <p>A package <code class="filename">Makefile</code> contains several
                   3607:   sections that describe the package.</p>
                   3608: <p>In the first section there are the following variables, which
                   3609:   should appear exactly in the order given here.  The order and
                   3610:   grouping of the variables is mostly historical and has no further
                   3611:   meaning.</p>
                   3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3613: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3614:     distribution file to be downloaded from the package's
                   3615:     website.</p></li>
                   3616: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3617:     package, as used by pkgsrc. You need to provide it if
                   3618:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3619:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3620:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3621:     directory name together with the version number. It must match the
                   3622:     regular expression
                   3623:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3624:     starts with a letter or digit, and contains only letters, digits,
1.319     nia      3625:     dashes, underscores, dots and plus signs.
                   3626:     New packages should have entirely lower-case names, with the exception
                   3627:     of some that must follow pre-existing conventions
                   3628:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3629:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3630:     the package name.</p></li>
1.299     rillig   3631: <li class="listitem">
                   3632: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3633:     which the package fits in. You can choose any of the top-level
                   3634:     directories of pkgsrc for it.</p>
                   3635: <p>Currently the following values are available for
                   3636:     <code class="varname">CATEGORIES</code>. If more than
                   3637:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3638: <pre class="programlisting">
1.299     rillig   3639: archivers     cross         geography     meta-pkgs     security
                   3640: audio         databases     graphics      misc          shells
                   3641: benchmarks    devel         ham           multimedia    sysutils
                   3642: biology       editors       inputmethod   net           textproc
                   3643: cad           emulators     lang          news          time
                   3644: chat          finance       mail          parallel      wm
                   3645: comms         fonts         math          pkgtools      www
                   3646: converters    games         mbone         print         x11
1.77      rillig   3647: </pre>
                   3648: </li>
1.299     rillig   3649: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3650:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3651:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3652:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.385     leot     3653:     <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.299     rillig   3654: </ul></div>
                   3655: <p>The second section contains information about separately
                   3656:   downloaded patches, if any.
                   3657:   </p>
                   3658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3659: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3660:     Name(s) of additional files that contain distribution patches.
                   3661:     There is no default. pkgsrc will look for them at
                   3662:     <code class="varname">PATCH_SITES</code>.
                   3663:     They will automatically be uncompressed before patching if
                   3664:     the names end with <code class="filename">.gz</code> or
                   3665:     <code class="filename">.Z</code>.</p></li>
                   3666: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3667:     Primary location(s) for distribution patch files (see
                   3668:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3669: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.378     leot     3670:     an argument to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   3671:     help find the correct files to patch. It defaults to
                   3672:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3673: </ul></div>
                   3674: <p>The third section contains the following variables.
                   3675:   </p>
                   3676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.367     gdt      3677: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
                   3678:     of the person who is currently responsible for this package.  In
                   3679:     theory, the maintainer will be aware of upstream release, keep it
                   3680:     updated, and generally resolve problems.  Others contemplating
                   3681:     significant changes should ask the maintainer for advice or review
                   3682:     of a proposed change.  This is not necessary for micro updates,
                   3683:     bug fixes, pkgsrc-wide changes affecting many packages, and other
                   3684:     things expected to be uncontroversial.  It goes with this "should
                   3685:     ask" that the maintainer should respond to inquiries reasonably
                   3686:     promptly (most of the time), and either approve changes or provide
                   3687:     reasons why not.  Typically, when packaging a new program, set
                   3688:     <code class="varname">MAINTAINER</code> to yourself.  If you don't intend to
                   3689:     maintain the package (especially if you feel you have no special
                   3690:     insight), set it to <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.  This
                   3691:     special value is a code point indicating that there is no
                   3692:     maintainer, but the variable is mandatory, absent
                   3693:     <code class="varname">OWNER</code>.</p></li>
                   3694: <li class="listitem">
                   3695: <p><code class="varname">OWNER</code> can be used instead of
                   3696:     <code class="varname">MAINTAINER</code> in relatively rare circumstances
                   3697:     when the package is such that modifying it is riskier than normal.
                   3698:     This is a stronger form of being the maintainer, with an
                   3699:     expectation that others will ask for almost all changes, except
                   3700:     revbumps and accommodating structural changes.  Someone who becomes
                   3701:     <code class="varname">OWNER</code> has a strong obligation to keep the
                   3702:     package very well maintained, to answer queries promptly and to be
                   3703:     a steward of the package on behalf of users.  In this case,
                   3704:     <code class="varname">MAINTAINER</code> should be omitted.</p>
                   3705: <p>Because of the friction that <code class="varname">OWNER</code> adds,
                   3706:     PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
                   3707:     time.</p>
                   3708: </li>
1.299     rillig   3709: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3710:     find more information about the package.</p></li>
                   3711: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3712:     description of the package (should not include the package
                   3713:     name).</p></li>
                   3714: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.385     leot     3715:     applicable for the package. See <a class="xref" href="#handling-licenses" title="21.1.3. Handling licenses">Section 21.1.3, “Handling licenses”</a> for further details.</p></li>
1.299     rillig   3716: </ul></div>
                   3717: <p>Other variables that affect the build:
                   3718:   </p>
                   3719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3720: <p><code class="varname">WRKSRC</code>: The directory where the
                   3721:       interesting distribution files of the package are found. The
                   3722:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3723:       works for most packages.</p>
                   3724: <p>If a package doesn't create a subdirectory for itself
                   3725:       (most GNU software does, for instance), but extracts itself in
                   3726:       the current directory, you should set
                   3727:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3728: <p>If a package doesn't create a subdirectory with the
                   3729:       name of <code class="varname">DISTNAME</code> but some different name,
                   3730:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3731:       <code class="filename">${WRKDIR}</code>, for example
                   3732:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322     leot     3733:       <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   3734: <p>The name of the working directory created by pkgsrc is
                   3735:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3736:       variable. By default, its value is
                   3737:       <code class="filename">work</code>. If you want to use the same
                   3738:       pkgsrc tree for building different kinds of binary packages,
                   3739:       you can change the variable according to your needs. Two
                   3740:       other variables handle common cases of setting
                   3741:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3742:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3743:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3744:       the host's name is attached to the directory name. If
                   3745:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3746:       is attached, which might look like
                   3747:       <code class="filename">work.i386</code> or
                   3748:       <code class="filename">work.sparc</code>.</p>
                   3749: </li></ul></div>
                   3750: <p>Please pay attention to the following gotchas:</p>
                   3751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3752: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3753:       installed in compressed form by the package.  For packages using
                   3754:       BSD-style makefiles which honor MANZ, there is
                   3755:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3756: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
1.385     leot     3757:       <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.299     rillig   3758:       below).</p></li>
1.385     leot     3759: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, “Packages installing info files”</a>.</p></li>
1.299     rillig   3760: </ul></div>
                   3761: </div>
1.148     asau     3762: <div class="sect1">
1.91      rillig   3763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3764: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
1.299     rillig   3765: </h2></div></div></div>
                   3766: <p>The <code class="filename">distinfo</code> file contains the message
                   3767:   digest, or checksum, of each distfile needed for the package. This
                   3768:   ensures that the distfiles retrieved from the Internet have not been
                   3769:   corrupted during transfer or altered by a malign force to introduce
                   3770:   a security hole. To provide maximum security, all distfiles are
1.357     gutterid 3771:   protected using two different message digest algorithms (BLAKE2s
                   3772:   and SHA512), as well as the file size.</p>
1.299     rillig   3773: <p>The <code class="filename">distinfo</code> file also contains the
                   3774:   checksums for all the patches found in the
1.385     leot     3775:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a>). These checksums ensure that patches
1.299     rillig   3776:   are only applied intentionally and that they don't accidentally change,
                   3777:   e.g. when merging different changes together. They also make sure that
                   3778:   new patches are actually added to CVS and old ones are removed.
                   3779:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3780:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3781: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3782:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3783: <p>Some packages have different sets of distfiles depending on
1.322     leot     3784:   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   3785:   <code class="filename">distinfo</code> file and care should be taken when
                   3786:   upgrading such a package to ensure distfile information is not
                   3787:   lost.</p>
                   3788: </div>
                   3789: <div class="sect1">
                   3790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3791: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
1.299     rillig   3792: </h2></div></div></div>
                   3793: <p>Some packages don't work out-of-the box on the various
                   3794:   platforms that are supported by pkgsrc. These packages need
                   3795:   to be patched to make them work. The patch files can be
                   3796:   found in the <code class="filename">patches/</code> directory.</p>
                   3797: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3798:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3799:   extracting them, in alphabetic order.</p>
1.148     asau     3800: <div class="sect2">
1.91      rillig   3801: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3802: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
1.299     rillig   3803: <p>The <code class="filename">patch-*</code> files should be in
                   3804:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3805:   problems. (To force patches to apply with fuzz you can set
                   3806:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3807:   should contain only changes for a single file, and no file should be
                   3808:   patched by more than one patch file. This helps to keep future
                   3809:   modifications simple.</p>
                   3810: <p>Each patch file is structured as follows: In the first line,
                   3811:   there is the RCS Id of the patch itself. The second line should be
                   3812:   empty for aesthetic reasons. After that, there should be a comment for
                   3813:   each change that the patch does. There are a number of standard
                   3814:   cases:</p>
                   3815: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3816: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3817:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3818: <li class="listitem"><p>Patches that change source code should mention the
                   3819:   platform and other environment (for example, the compiler) that the
                   3820:   patch is needed for.</p></li>
                   3821: </ul></div>
                   3822: <p>The patch should be commented so that any
                   3823:   developer who knows the code of the application can make some use of
                   3824:   the patch. Special care should be taken for the upstream developers,
                   3825:   since we generally want that they accept our patches, so we have less
                   3826:   work in the future.</p>
1.91      rillig   3827: </div>
1.148     asau     3828: <div class="sect2">
1.91      rillig   3829: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3830: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
1.299     rillig   3831: <p>One important thing to mention is to pay attention that no RCS
                   3832:   IDs get stored in the patch files, as these will cause problems when
                   3833:   later checked into the NetBSD CVS tree. Use the
1.322     leot     3834:   <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   3835:   problems.</p>
                   3836: <p>For even more automation, we recommend using
                   3837:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337     gutterid 3838:   whole set of patches. You just have to back up files before you
                   3839:   edit them to <code class="filename">filename.orig</code>, e.g., with
1.299     rillig   3840:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3841:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3842:   you upgrade a package this way, you can easily compare the new
                   3843:   set of patches with the previously existing one with
                   3844:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3845:   are replaced by new files, so carefully check if you want to take all
                   3846:   the changes.</p>
                   3847: <p>When you have finished a package, remember to generate
                   3848:   the checksums for the patch files by using the <span class="command"><strong>make
1.385     leot     3849:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="12.2. distinfo">Section 12.2, “<code class="filename">distinfo</code>”</a>.</p>
1.299     rillig   3850: <p>When adding a patch that corrects a problem in the
                   3851:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3852:   man pages should go), send the patch as a bug report to the
                   3853:   maintainer.  This benefits non-pkgsrc users of the package,
                   3854:   and usually makes it possible to remove the patch in future
                   3855:   version.</p>
                   3856: <p>The file names of the patch files are usually of the form
                   3857:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3858:   Many packages still use the previous convention
                   3859:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3860:   but new patches should be of the form containing the filename.
1.322     leot     3861:   <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   3862:   automatically.</p>
1.337     gutterid 3863: <p>When updating pre-existing patch files, if a file uses the old
                   3864:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
                   3865:   convention, it's best not to change it to the new form, as that will
                   3866:   just cause churn that makes it harder to track changes to patching
                   3867:   over time. Similarly, if a patch now applies at different line offsets,
                   3868:   but still applies cleanly as-is, there's no need to update it, as that
                   3869:   also unnecessarily complicates the patch history.</p>
1.118     imil     3870: </div>
1.275     brook    3871: <div class="sect2">
                   3872: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3873: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
1.299     rillig   3874: <p>If you want to share patches between multiple packages
                   3875:   in pkgsrc, e.g. because they use the same distfiles, set
                   3876:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3877:   can be found, e.g.:</p>
                   3878: <pre class="programlisting">
                   3879: PATCHDIR=       ../../editors/xemacs/patches
                   3880: </pre>
                   3881: <p>Patch files that are distributed by the author or other
                   3882:     maintainers can be listed in
                   3883:     <code class="varname">PATCHFILES</code>.</p>
                   3884: <p>If it is desired to store any patches that should not be
                   3885:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3886:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3887:     directory tree there is expected to have the same
1.385     leot     3888:     <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.299     rillig   3889:     patches are expected to be stored inside these dirs (also
                   3890:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3891:     example, if you want to keep a private patch for
                   3892:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3893:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3894:     files in the named directory are expected to be patch files,
                   3895:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3896:     applied</em></span>.</p>
1.275     brook    3897: </div>
                   3898: <div class="sect2">
                   3899: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3900: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
1.299     rillig   3901: <p>When fixing a portability issue in the code do not use
                   3902:       preprocessor magic to check for the current operating system nor
                   3903:       platform.  Doing so hurts portability to other platforms because
                   3904:       the OS-specific details are not abstracted appropriately.</p>
                   3905: <p>The general rule to follow is: instead of checking for the
                   3906:       operating system the application is being built on, check for the
                   3907:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3908:       instead of assuming that kqueue is available under NetBSD and
                   3909:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3910:       kqueue support, add a check that detects kqueue itself &mdash;
                   3911:       yes, this generally involves patching the
                   3912:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3913:       that prevents some OSes from adopting interfaces from other OSes
                   3914:       (e.g. Linux implementing kqueue), something that the above checks
                   3915:       cannot take into account.</p>
                   3916: <p>Of course, checking for features generally involves more
                   3917:       work on the developer's side, but the resulting changes are
                   3918:       cleaner and there are chances they will work on many other
                   3919:       platforms.  Not to mention that there are higher chances of being
                   3920:       later integrated into the mainstream sources.  Remember:
                   3921:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3922: <p>Some typical examples:</p>
                   3923: <div class="table">
1.385     leot     3924: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
1.299     rillig   3925: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3926: <colgroup>
                   3927: <col>
                   3928: <col>
                   3929: <col>
                   3930: </colgroup>
                   3931: <thead><tr>
                   3932: <th>Where</th>
                   3933: <th>Incorrect</th>
                   3934: <th>Correct</th>
                   3935: </tr></thead>
                   3936: <tbody>
                   3937: <tr>
                   3938: <td>configure script</td>
                   3939: <td>
1.275     brook    3940: <pre class="programlisting">
1.299     rillig   3941: case ${target_os} in
                   3942: netbsd*) have_kvm=yes ;;
                   3943: *)       have_kvm=no  ;;
                   3944: esac
1.275     brook    3945: </pre>
1.299     rillig   3946:              </td>
                   3947: <td>
1.275     brook    3948: <pre class="programlisting">
1.299     rillig   3949: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3950: </pre>
1.299     rillig   3951:              </td>
                   3952: </tr>
                   3953: <tr>
                   3954: <td>C source file</td>
                   3955: <td>
1.91      rillig   3956: <pre class="programlisting">
1.299     rillig   3957: #if defined(__NetBSD__)
                   3958: #  include &lt;sys/event.h&gt;
                   3959: #endif
1.91      rillig   3960: </pre>
1.299     rillig   3961:              </td>
                   3962: <td>
1.91      rillig   3963: <pre class="programlisting">
1.299     rillig   3964: #if defined(HAVE_SYS_EVENT_H)
                   3965: #  include &lt;sys/event.h&gt;
                   3966: #endif
1.91      rillig   3967: </pre>
1.299     rillig   3968:              </td>
                   3969: </tr>
                   3970: <tr>
                   3971: <td>C source file</td>
                   3972: <td>
1.91      rillig   3973: <pre class="programlisting">
1.299     rillig   3974: int
                   3975: monitor_file(...)
                   3976: {
                   3977: #if defined(__NetBSD__)
                   3978:         int fd = kqueue();
                   3979:         ...
                   3980: #else
                   3981:         ...
                   3982: #endif
                   3983: }
1.91      rillig   3984: </pre>
1.299     rillig   3985:              </td>
                   3986: <td>
1.91      rillig   3987: <pre class="programlisting">
1.299     rillig   3988: int
                   3989: monitor_file(...)
                   3990: {
                   3991: #if defined(HAVE_KQUEUE)
                   3992:         int fd = kqueue();
                   3993:         ...
                   3994: #else
                   3995:         ...
                   3996: #endif
                   3997: }
1.91      rillig   3998: </pre>
1.299     rillig   3999:              </td>
                   4000: </tr>
                   4001: </tbody>
                   4002: </table></div>
                   4003: </div>
                   4004: <br class="table-break">
                   4005: </div>
                   4006: <div class="sect2">
                   4007: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4008: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
1.299     rillig   4009: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4010:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4011:       improvements you do to a package to the mainstream developers.
                   4012:       This is the only way to get their attention on portability issues
                   4013:       and to ensure that future versions can be built out-of-the box on
                   4014:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4015:       the fixes straight from the packaged code.</p>
                   4016: <p>This generally involves cleaning up the patches
                   4017:       (because sometimes the patches that are
                   4018:       added to pkgsrc are quick hacks), filing bug reports in the
                   4019:       appropriate trackers for the projects and working with the
                   4020:       mainstream authors to accept your changes.  It is
                   4021:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4022:       the packages in pkgsrc are kept simple and thus further changes
                   4023:       can be done without much hassle.</p>
                   4024: <p>When you have done this, please add a URL to the upstream
                   4025:       bug report to the patch comment.</p>
                   4026: <p>Support the idea of free software!</p>
                   4027: </div>
1.91      rillig   4028: </div>
1.299     rillig   4029: <div class="sect1">
                   4030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4031: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
1.299     rillig   4032: <div class="variablelist"><dl class="variablelist">
                   4033: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4034: <dd><p>A multi-line description of the piece of software.  This should include
                   4035:          any credits where they are due.  Please bear in mind that others do not
                   4036:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4037:          will read everything that you write here.</p></dd>
                   4038: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4039: <dd><p>This file governs the files that are installed on your
                   4040:          system: all the binaries, manual pages, etc. There are other
                   4041:          directives which may be entered in this file, to control the
                   4042:          creation and deletion of directories, and the location of
1.385     leot     4043:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
1.299     rillig   4044:          information.</p></dd>
                   4045: </dl></div>
                   4046: </div>
                   4047: <div class="sect1">
                   4048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4049: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
1.299     rillig   4050: <div class="sect2">
                   4051: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4052: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
1.299     rillig   4053: <div class="variablelist"><dl class="variablelist">
                   4054: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   4055: <dd>
1.378     leot     4056: <p>This shell script is invoked twice by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   4057:            First time after package extraction and before files are
                   4058:            moved in place, the second time after the files to install
                   4059:            are moved in place. This can be used to do any custom
                   4060:            procedures not possible with @exec commands in
1.378     leot     4061:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
1.385     leot     4062:            <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.299     rillig   4063:            Please note that you can modify variables in it easily by using
                   4064:            <code class="varname">FILES_SUBST</code> in the package's
                   4065:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4066: <pre class="programlisting">
1.299     rillig   4067: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4068: </pre>
1.385     leot     4069: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
1.299     rillig   4070:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4071:            performed for <code class="varname">PREFIX</code>,
                   4072:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4073:            <code class="varname">VARBASE</code>, and a few others, type
                   4074:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4075:            complete list.</p>
                   4076: </dd>
                   4077: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4078: <dd><p>This script is executed before and after any files are removed.  It is
                   4079:            this script's responsibility to clean up any additional messy details
                   4080:            around the package's installation, since all pkg_delete knows is how to
                   4081:            delete the files created in the original distribution.
1.378     leot     4082:            See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4083:            and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   4084:            The same methods to replace variables can be used as for
                   4085:            the <code class="filename">INSTALL</code> file.</p></dd>
                   4086: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4087: <dd>
                   4088: <p>This file is displayed after installation of the package.
1.312     gdt      4089:            While this was used often in the past, it has two
                   4090:            problems: the display will be missed if many packages are
1.375     jkoshy   4091:            installed at once, and the person installing the package
1.312     gdt      4092:            and the one using or configuring it may be different.  It
                   4093:            should therefore be used only in exceptional circumstances
                   4094:            where lasting negative consequences would result from
                   4095:            someone not reading it.</p>
                   4096: <p>MESSAGE should not be used for:</p>
                   4097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4098: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   4099: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   4100: <li class="listitem"><p>anything that should be explained in the
                   4101:              installation/configuration documentation that should
                   4102:              come with the package</p></li>
                   4103: </ul></div>
                   4104: <p>If the documentation provided by upstream needs
1.313     leot     4105:            enhancing, create e.g. files/README.pkgsrc and install it
                   4106:            in the package's documentation directory.
1.312     gdt      4107:            </p>
                   4108: <p>Note that MESSAGE is shown for all operating
                   4109:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     4110:            it should be narrowed to only those operating systems and
1.312     gdt      4111:            init systems to which it applies.</p>
                   4112: <p>Note that you can modify variables in it easily by using
1.299     rillig   4113:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4114:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4115: <pre class="programlisting">
1.299     rillig   4116: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4117: </pre>
1.385     leot     4118: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.299     rillig   4119:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4120:            performed for <code class="varname">PKGNAME</code>,
                   4121:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4122:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4123:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4124:            <code class="varname">ROOT_GROUP</code>, and
                   4125:            <code class="varname">ROOT_USER</code>.</p>
                   4126: <p>You can display a different or additional files by
                   4127:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4128:            default is <code class="filename">MESSAGE</code>, if the file
                   4129:            exists.</p>
                   4130: </dd>
                   4131: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4132: <dd>
                   4133: <p>This file is used by the alternatives framework.
                   4134:            It creates, configures, and destroys generic wrappers used to
                   4135:            run programs with similar interfaces.
                   4136:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4137:             for more information.</p>
                   4138: <p>Each line of the file contains two filenames, first
                   4139:            the wrapper and then the alternative provided by the package.
                   4140:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4141: </dd>
                   4142: </dl></div>
                   4143: </div>
                   4144: <div class="sect2">
                   4145: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4146: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
1.299     rillig   4147: <div class="variablelist"><dl class="variablelist">
                   4148: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4149: <dd><p>This file contains arbitrary things that could
                   4150:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4151:        to be used by more than one package. This file should only be
                   4152:        used when the packages that will use the file are known in
                   4153:        advance. For other purposes it is often better to write a
                   4154:        <code class="filename">*.mk</code> file and give it a good name that
                   4155:        describes what it does.</p></dd>
                   4156: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4157: <dd><p>This file contains the dependency information
1.385     leot     4158:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
1.299     rillig   4159: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4160: <dd><p>This file contains workarounds for compiler bugs
                   4161:        and similar things. It is included automatically by the pkgsrc
                   4162:        infrastructure, so you don't need an extra
                   4163:        <code class="literal">.include</code> line for
                   4164:        it.</p></dd>
                   4165: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4166: <dd><p>This file contains the code for the
1.385     leot     4167:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.299     rillig   4168:        selected by the user. If a package has only one or two options,
                   4169:        it is equally acceptable to put the code directly into the
                   4170:        <code class="filename">Makefile</code>.</p></dd>
                   4171: </dl></div>
                   4172: </div>
                   4173: <div class="sect2">
                   4174: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4175: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
1.299     rillig   4176: <div class="variablelist"><dl class="variablelist">
                   4177: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4178: <dd><p>These files do not take place in the creation of
                   4179:        a package and thus are purely informative to the package
                   4180:        developer.</p></dd>
                   4181: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4182: <dd><p>This file contains things that need to be done
                   4183:        to make the package even
                   4184:        better.</p></dd>
                   4185: </dl></div>
                   4186: </div>
                   4187: </div>
                   4188: <div class="sect1">
                   4189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4190: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
1.299     rillig   4191: </h2></div></div></div>
                   4192: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4193:     unpacked into the directory denoted by
                   4194:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4195:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4196:     directory is also used to keep various timestamp files.
                   4197:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4198:     The default is <code class="filename">${.CURDIR}/work</code>
                   4199:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4200:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   4201: </div>
1.299     rillig   4202: <div class="sect1">
                   4203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4204: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
1.299     rillig   4205: </h2></div></div></div>
                   4206: <p>If you have any files that you wish to be placed in the package
                   4207:     prior to configuration or building, you can place these files here
                   4208:     and use a <span class="command"><strong>${CP}</strong></span> command in the
1.385     leot     4209:     <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.299     rillig   4210: <p>If you want to share files in this way with other
                   4211:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4212:     to the other package's <code class="filename">files</code> directory,
                   4213:     e.g.:</p>
1.91      rillig   4214: <pre class="programlisting">
1.299     rillig   4215: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4216: </pre>
                   4217: </div>
                   4218: </div>
1.148     asau     4219: <div class="chapter">
1.75      rillig   4220: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     4221: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4222: <div class="toc">
                   4223: <p><b>Table of Contents</b></p>
1.210     leot     4224: <dl class="toc">
1.299     rillig   4225: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4226: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4227: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4228: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4229: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4230: <dd><dl>
                   4231: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4232: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4233: </dl></dd>
                   4234: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4235: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4236: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4237: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4238: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4239: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4240: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4241: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4242: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4243: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4244: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4245: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4246: </dl>
                   4247: </div>
1.148     asau     4248: <div class="sect1">
1.75      rillig   4249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4250: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
1.299     rillig   4251: <p>This chapter gives a detailed description on how a package is
                   4252:     built. Building a package is separated into different
                   4253:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4254:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4255:     described in the following sections. Each phase is split into
                   4256:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4257:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4258:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4259:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4260:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4261: <p>Never override the regular targets (like
                   4262:     <code class="varname">fetch</code>), if you have to, override the
                   4263:     <code class="varname">do-*</code> ones instead.</p>
                   4264: <p>The basic steps for building a program are always the same.  First
                   4265:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4266:     the local system and then extracted. After any pkgsrc-specific patches
                   4267:     to compile properly are applied, the software can be configured, then
                   4268:     built (usually by compiling), and finally the generated binaries, etc.
                   4269:     can be put into place on the system.</p>
                   4270: <p>To get more details about what is happening at each step,
                   4271:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4272:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4273:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4274: </div>
                   4275: <div class="sect1">
                   4276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4277: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
1.299     rillig   4278: <p>Before outlining the process performed by the NetBSD package system in
                   4279:     the next section, here's a brief discussion on where programs are
                   4280:     installed, and which variables influence this.</p>
                   4281: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4282:     where all files of the final program shall be installed. It is
                   4283:     usually set to <code class="varname">LOCALBASE</code>
                   4284:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4285:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4286:     <code class="varname">PREFIX</code> needs to be put
                   4287:     into the various places in the program's source where paths to
1.385     leot     4288:     these files are encoded.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="21.3.1. Shared libraries - libtool">Section 21.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.299     rillig   4289: <p>When choosing which of these variables to use,
                   4290:     follow the following rules:</p>
1.148     asau     4291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4292: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4293:        where the current pkg will be installed.  When referring to a
                   4294:        pkg's own installation path, use
1.385     leot     4295:        <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.338     nia      4296: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299     rillig   4297:        are installed.  If you need to construct a -I or -L argument
                   4298:        to the compiler to find includes and libraries installed by
1.385     leot     4299:        another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.299     rillig   4300:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4301:        installed all packages in <code class="filename">/usr/local</code>. As
                   4302:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4303:        administrator, this variable is a misnomer.</p></li>
                   4304: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4305:        distribution (from xsrc, etc.) is installed. When looking for
                   4306:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.385     leot     4307:        installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.299     rillig   4308: <li class="listitem"><p>X11-based packages using imake must set
                   4309:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4310:        <code class="varname">LOCALBASE</code>.</p></li>
                   4311: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.378     leot     4312:        install files according to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4313:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4314:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4315: </ul></div>
                   4316: </div>
                   4317: <div class="sect1">
                   4318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4319: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
1.299     rillig   4320: <p>When building a package, various directories are used to store
                   4321:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4322:     directories are explained here.</p>
                   4323: <p>Some of the directory variables contain relative pathnames. There
                   4324:     are two common base directories for these relative directories:
                   4325:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4326:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4327:     inside the package itself.</p>
                   4328: <div class="variablelist"><dl class="variablelist">
                   4329: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4330: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4331:       root directory. Generally, you don't need
                   4332:       it.</p></dd>
                   4333: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4334: <dd><p>This is an absolute pathname that points to the
                   4335:       current package.</p></dd>
                   4336: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343     gutterid 4337: <dd>
                   4338: <p>This is a pathname relative to
                   4339:       <code class="varname">PKGSRCDIR</code> that points to the current package.
                   4340:       It is defined after including <code class="filename">bsd.prefs.mk</code>
                   4341:       and can be used in makefile fragments that are used by several
                   4342:       packages to distinguish between these packages. Other variables
                   4343:       that would serve the same purpose are <code class="varname">PKGBASE</code>
                   4344:       and <code class="varname">PKGNAME</code>, but these are only defined after
                   4345:       including <code class="filename">bsd.pkg.mk</code>, which is too
                   4346:       late.</p>
                   4347: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
                   4348:       <code class="varname">PKGPATH</code> to tweak variables like
                   4349:       <code class="varname">MAKE_JOBS</code> and
                   4350:       <code class="varname">CFLAGS</code>.</p>
                   4351: </dd>
1.299     rillig   4352: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4353: <dd><p>This is an absolute pathname pointing to the directory
                   4354:       where all work takes place. The distfiles are extracted to this
                   4355:       directory. It also contains temporary directories and log files used by
                   4356:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4357:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4358: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4359: <dd><p>This is an absolute pathname pointing to the directory
                   4360:       where the distfiles are extracted. It is usually a direct subdirectory
                   4361:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4362:       that isn't hidden. This variable may be changed by a package
                   4363:       <code class="filename">Makefile</code>.</p></dd>
                   4364: </dl></div>
                   4365: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4366:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4367:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4368:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4369:     If users would like to have their pkgsrc trees behave in a
                   4370:     read-only manner, then the value of
                   4371:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4372:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4373: </div>
1.148     asau     4374: <div class="sect1">
1.75      rillig   4375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4376: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
1.299     rillig   4377: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343     gutterid 4378:     <em class="replaceable"><code>phase</code></em></strong></span>, where
                   4379:     <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
                   4380:     automatically run all phases that are required for this phase. The
                   4381:     default phase is <code class="varname">build</code>, that is, when you run
                   4382:     <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299     rillig   4383:     the package will be built, but not installed.</p>
1.75      rillig   4384: </div>
1.148     asau     4385: <div class="sect1">
1.75      rillig   4386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4387: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.299     rillig   4388: <p>The first step in building a package is to fetch the
                   4389:     distribution files (distfiles) from the sites that are providing
                   4390:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4391:     phase.</p>
1.148     asau     4392: <div class="sect2">
1.93      rillig   4393: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4394: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
1.299     rillig   4395: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4396:       defines all URLs from where the distfile, whose name is
                   4397:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4398:       fetched. The more complicated cases are described
                   4399:       below.</p>
                   4400: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4401:       the list of distfiles that have to be fetched. Its value
                   4402:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4403:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4404:       so that most packages don't need to define it at all.
                   4405:       <code class="varname">EXTRACT_SUFX</code> is
                   4406:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4407:       freely. Note that if your package requires additional
                   4408:       distfiles to the default one, you cannot just append the
                   4409:       additional filenames using the <code class="literal">+=</code>
                   4410:       operator, but you have write for example:</p>
                   4411: <pre class="programlisting">
                   4412: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4413: </pre>
                   4414: <p>Each distfile is fetched from a list of sites, usually
                   4415:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4416:       <code class="varname">DISTFILES</code> or multiple
                   4417:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4418:       set
                   4419:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4420:       to the list of URLs where the file
                   4421:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4422:       (including the suffix) can be found.</p>
                   4423: <pre class="programlisting">
                   4424: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4425: DISTFILES+=     foo-file.tar.gz
                   4426: SITES.foo-file.tar.gz= \
                   4427: https://www.somewhere.com/somehow/ \
                   4428: https://www.somewhereelse.com/mirror/somehow/
                   4429: </pre>
                   4430: <p>When actually fetching the distfiles, each item from
                   4431:       <code class="varname">MASTER_SITES</code> or
                   4432:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4433:       appended to it, without an intermediate slash. Therefore,
                   4434:       all site values have to end with a slash or other separator
                   4435:       character. This allows for example to set
                   4436:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4437:       that gets the name of the distfile as a parameter. In this
                   4438:       case, the definition would look like:</p>
                   4439: <pre class="programlisting">
                   4440: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4441: </pre>
                   4442: <p> The exception to this rule are URLs starting with a dash.
                   4443:       In that case the URL is taken as is, fetched and the result
                   4444:       stored under the name of the distfile. You can use this style
                   4445:       for the case when the download URL style does not match the
                   4446:       above common case. For example, if permanent download URL is a
                   4447:       redirector to the real download URL, or the download file name
                   4448:       is offered by an HTTP Content-Disposition header. In the
                   4449:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4450:       created instead of the default
                   4451:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4452: <pre class="programlisting">
                   4453: DISTNAME=       foo-1.0.0
                   4454: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4455: </pre>
                   4456: <p>There are some predefined values for
                   4457:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4458:       packages.  The names of the variables should speak for
                   4459:       themselves.</p>
                   4460: <table border="0" summary="Simple list" class="simplelist">
                   4461: <tr>
                   4462: <td>MASTER_SITE_APACHE</td>
                   4463: <td>MASTER_SITE_BACKUP</td>
                   4464: </tr>
                   4465: <tr>
                   4466: <td>MASTER_SITE_CRATESIO</td>
                   4467: <td>MASTER_SITE_CYGWIN</td>
                   4468: </tr>
                   4469: <tr>
                   4470: <td>MASTER_SITE_DEBIAN</td>
                   4471: <td>MASTER_SITE_FREEBSD</td>
                   4472: </tr>
                   4473: <tr>
                   4474: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4475: <td>MASTER_SITE_GENTOO</td>
                   4476: </tr>
                   4477: <tr>
                   4478: <td>MASTER_SITE_GITHUB</td>
1.340     gutterid 4479: <td>MASTER_SITE_GITLAB</td>
                   4480: </tr>
                   4481: <tr>
1.299     rillig   4482: <td>MASTER_SITE_GNOME</td>
1.340     gutterid 4483: <td>MASTER_SITE_GNU</td>
1.299     rillig   4484: </tr>
                   4485: <tr>
1.379     wiz      4486: <td>MASTER_SITE_GNUPG</td>
1.299     rillig   4487: <td>MASTER_SITE_GNUSTEP</td>
                   4488: </tr>
                   4489: <tr>
1.379     wiz      4490: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299     rillig   4491: <td>MASTER_SITE_IFARCHIVE</td>
                   4492: </tr>
                   4493: <tr>
1.379     wiz      4494: <td>MASTER_SITE_KDE</td>
1.299     rillig   4495: <td>MASTER_SITE_MOZILLA</td>
                   4496: </tr>
                   4497: <tr>
1.379     wiz      4498: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299     rillig   4499: <td>MASTER_SITE_MYSQL</td>
                   4500: </tr>
                   4501: <tr>
1.379     wiz      4502: <td>MASTER_SITE_NETLIB</td>
1.299     rillig   4503: <td>MASTER_SITE_OPENBSD</td>
                   4504: </tr>
                   4505: <tr>
1.379     wiz      4506: <td>MASTER_SITE_OPENOFFICE</td>
1.299     rillig   4507: <td>MASTER_SITE_OSDN</td>
                   4508: </tr>
                   4509: <tr>
1.379     wiz      4510: <td>MASTER_SITE_PERL_CPAN</td>
1.299     rillig   4511: <td>MASTER_SITE_PGSQL</td>
                   4512: </tr>
                   4513: <tr>
1.379     wiz      4514: <td>MASTER_SITE_PYPI</td>
1.299     rillig   4515: <td>MASTER_SITE_RUBYGEMS</td>
                   4516: </tr>
                   4517: <tr>
1.379     wiz      4518: <td>MASTER_SITE_R_CRAN</td>
1.299     rillig   4519: <td>MASTER_SITE_SOURCEFORGE</td>
                   4520: </tr>
1.85      jmmv     4521: <tr>
1.379     wiz      4522: <td>MASTER_SITE_SUNSITE</td>
1.299     rillig   4523: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4524: </tr>
                   4525: <tr>
1.379     wiz      4526: <td>MASTER_SITE_TEX_CTAN</td>
1.299     rillig   4527: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4528: </tr>
                   4529: <tr>
1.379     wiz      4530: <td>MASTER_SITE_XEMACS</td>
1.299     rillig   4531: <td>MASTER_SITE_XORG</td>
                   4532: </tr>
                   4533: </table>
                   4534: <p>Some explanations for the less self-explaining ones:
                   4535:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.369     wiz      4536:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.299     rillig   4537:       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>
                   4538: <p>If you choose one of these predefined sites, you may
                   4539:       want to specify a subdirectory of that site. Since these
                   4540:       macros may expand to more than one actual site, you
                   4541:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4542:       specify a subdirectory:</p>
1.100     rillig   4543: <pre class="programlisting">
1.299     rillig   4544: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4545: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4546: </pre>
1.299     rillig   4547: <p>Note the trailing slash after the subdirectory
                   4548:       name.</p>
                   4549: </div>
                   4550: <div class="sect2">
                   4551: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4552: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
1.299     rillig   4553: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4554:       all the distfiles exist in a local directory
                   4555:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4556:       user). If the files do not exist, they are fetched using
                   4557:       commands of the form</p>
1.100     rillig   4558: <pre class="programlisting">
1.299     rillig   4559: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4560: </pre>
                   4561: <p>where <code class="literal">${site}</code> varies through
                   4562:       several possibilities in turn: first,
                   4563:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4564:       sites specified in either <code class="varname">SITES.file</code> if
                   4565:       defined, else <code class="varname">MASTER_SITES</code> or
                   4566:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4567:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4568:       all except the first and the last can be optionally sorted
                   4569:       by the user, via setting either
                   4570:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4571:       <code class="varname">MASTER_SORT_AWK</code> or
                   4572:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4573: <p> The specific command and arguments used depend on the
                   4574:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4575:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4576: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4577:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4578:       distfiles, if they are freely distributable.  Packages setting
                   4579:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.385     leot     4580:       <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.299     rillig   4581:       mirrored.</p>
1.85      jmmv     4582: </div>
                   4583: </div>
1.299     rillig   4584: <div class="sect1">
                   4585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4586: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.299     rillig   4587: <p>After the distfile(s) are fetched, their checksum is
                   4588:     generated and compared with the checksums stored in the
                   4589:     distinfo file. If the checksums don't match, the build is
                   4590:     aborted. This is to ensure the same distfile is used for
                   4591:     building, and that the distfile wasn't changed, e.g. by some
                   4592:     malign force, deliberately changed distfiles on the master
                   4593:     distribution site or network lossage.</p>
1.75      rillig   4594: </div>
1.148     asau     4595: <div class="sect1">
1.75      rillig   4596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4597: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.299     rillig   4598: <p>When the distfiles are present on the local system, they
                   4599:     need to be extracted, as they usually come in the form of some
                   4600:     compressed archive format.</p>
                   4601: <p>By default, all <code class="varname">DISTFILES</code> are
                   4602:     extracted. If you only need some of them, you can set the
                   4603:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4604:     files.</p>
                   4605: <p>Extracting the files is usually done by a little
                   4606:     program, <code class="filename">mk/extract/extract</code>, which
                   4607:     already knows how to extract various archive formats, so most
                   4608:     likely you will not need to change anything here. But if you
                   4609:     need, the following variables may help you:</p>
1.148     asau     4610: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4611: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4612: <dd><p>Use these variables to override the default
                   4613:       options for an extract command, which are defined in
                   4614:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4615: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4616: <dd><p>This variable can be set to
                   4617:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4618:       (which is the default value), <code class="literal">pax</code>, or an
                   4619:       absolute pathname pointing to the command with which tar
                   4620:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4621:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4622: </dl></div>
1.299     rillig   4623: <p>If the <code class="filename">extract</code> program doesn't
                   4624:     serve your needs, you can also override the
                   4625:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4626:     command used for extracting the files. This command is
                   4627:     executed in the <code class="filename">${WRKSRC}</code>
                   4628:     directory. During execution of this command, the shell
                   4629:     variable <code class="varname">extract_file</code> holds the absolute
                   4630:     pathname of the file that is going to be extracted.</p>
                   4631: <p>And if that still does not suffice, you can override the
                   4632:     <code class="varname">do-extract</code> target in the package
                   4633:     Makefile.</p>
1.75      rillig   4634: </div>
1.148     asau     4635: <div class="sect1">
1.75      rillig   4636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4637: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.299     rillig   4638: <p>After extraction, all the patches named by the
                   4639:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4640:     subdirectory of the package as well as in
                   4641:     $LOCALPATCHES/$PKGPATH (e.g.
                   4642:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4643:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4644:     <code class="filename">.gz</code> are uncompressed before they are
                   4645:     applied, files ending in <code class="filename">.orig</code> or
                   4646:     <code class="filename">.rej</code> are ignored. Any special options to
1.378     leot     4647:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.385     leot     4648:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.378     leot     4649: <p>By default <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4650:     fail if the expected text from the patch context is not found in the
                   4651:     patched file. If that happens, fix the patch file by comparing it
                   4652:     with the actual text in the file to be patched.</p>
1.78      rillig   4653: </div>
1.148     asau     4654: <div class="sect1">
1.75      rillig   4655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4656: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4657: <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>.
1.299     rillig   4658:     </p>
1.75      rillig   4659: </div>
1.148     asau     4660: <div class="sect1">
1.75      rillig   4661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4662: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.299     rillig   4663: <p>This phase creates wrapper programs for the compilers and
                   4664:     linkers. The following variables can be used to tweak the
                   4665:     wrappers.</p>
                   4666: <div class="variablelist"><dl class="variablelist">
                   4667: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4668: <dd><p>The command used to print progress
                   4669:       messages. Does nothing by default. Set to
                   4670:       <code class="literal">${ECHO}</code> to see the progress
                   4671:       messages.</p></dd>
                   4672: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4673: <dd><p>This variable can be set to
                   4674:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4675:       depending on whether you want additional information in the
                   4676:       wrapper log file.</p></dd>
                   4677: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4678: <dd><p>This variable can be set to
                   4679:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4680:       on whether the wrapper should use its cache, which will
                   4681:       improve the speed. The default value is
                   4682:       <code class="literal">yes</code>, but is forced to
                   4683:       <code class="literal">no</code> if the platform does not support
                   4684:       it.</p></dd>
                   4685: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4686: <dd><p>A list of reordering commands. A reordering
                   4687:       command has the form
                   4688:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4689:       It ensures that that
                   4690:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4691:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4692:       </p></dd>
                   4693: </dl></div>
                   4694: </div>
                   4695: <div class="sect1">
                   4696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4697: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.299     rillig   4698: <p>Most pieces of software need information on the header
                   4699:     files, system calls, and library routines which are available
                   4700:     on the platform they run on. The process of determining this
                   4701:     information is known as configuration, and is usually
                   4702:     automated. In most cases, a script is supplied with the
                   4703:     distfiles, and its invocation results in generation of header
                   4704:     files, Makefiles, etc.</p>
                   4705: <p>If the package contains a configure script, this can be
                   4706:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.385     leot     4707:     <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.299     rillig   4708:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.385     leot     4709:     <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
1.301     rillig   4710: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4711:     equivalent of the following command is run. See
                   4712:     <code class="filename">mk/configure/configure.mk</code>, target
                   4713:     <code class="literal">do-configure-script</code> for the exact
                   4714:     definition.</p>
                   4715: <pre class="programlisting">
                   4716: .for dir in ${CONFIGURE_DIRS}
                   4717:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4718:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4719:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4720: .endfor
1.100     rillig   4721: </pre>
1.299     rillig   4722: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.385     leot     4723:     <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.299     rillig   4724:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4725:     configure script is run with the environment
                   4726:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4727:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4728:     <code class="varname">CONFIGURE_ENV</code>,
                   4729:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.385     leot     4730:     <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.299     rillig   4731:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4732:     package.</p>
                   4733: <p>If the program uses the Perl way of configuration (mainly Perl
                   4734:     modules, but not only), i.e. a file called
                   4735:     <code class="filename">Makefile.PL</code>, it should include
                   4736:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4737:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4738:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4739: <p>If the program uses an <code class="filename">Imakefile</code>
                   4740:     for configuration, the appropriate steps can be invoked by
                   4741:     setting <code class="varname">USE_IMAKE</code> to
1.385     leot     4742:     <span class="quote">“<span class="quote">yes</span>”</span>.  If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
1.299     rillig   4743:     You can add variables to xmkmf's environment by adding them to the
                   4744:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4745: <p>If the program uses <code class="filename">cmake</code>
                   4746:     for configuration, the appropriate steps can be invoked by
1.348     wiz      4747:     including <code class="filename">../../devel/cmake/build.mk</code>.
1.299     rillig   4748:     You can add variables to cmake's environment by adding them to the
                   4749:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.373     wiz      4750:     by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.348     wiz      4751:     If you want to add arguments only for particular stages, you can use the
                   4752:     <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
                   4753:     <code class="varname">CMAKE_BUILD_ARGS</code>, and
                   4754:     <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
                   4755:     You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
                   4756:     directories in which CMake should be run, relative to
1.385     leot     4757:     <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
1.348     wiz      4758:     </p>
1.374     wiz      4759: <p>Any package using the now-deprecated
                   4760:     <code class="varname">USE_CMAKE=yes</code> should be converted.
                   4761:     Essentially, replace with an include of
                   4762:     <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
                   4763:     directory and settings to use it, and check/fix settings that
                   4764:     intend to perform the build in a subdirectory.
                   4765:     </p>
1.299     rillig   4766: <p>If there is no configure step at all, set
1.385     leot     4767:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75      rillig   4768: </div>
1.148     asau     4769: <div class="sect1">
1.75      rillig   4770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4771: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4772: <p>For building a package, a rough equivalent of the following
                   4773:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4774:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4775: <pre class="programlisting">
1.301     rillig   4776: .for dir in ${BUILD_DIRS}
                   4777:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4778:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4779:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4780:                 -f ${MAKE_FILE} \
                   4781:                 ${BUILD_TARGET}
                   4782: .endfor
1.97      rillig   4783: </pre>
1.299     rillig   4784: <p><code class="varname">BUILD_DIRS</code> (default:
1.385     leot     4785:     <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.299     rillig   4786:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4787:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4788:     <code class="varname">MAKE_ENV</code> and arguments
                   4789:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4790:     <code class="varname">MAKE_ENV</code>,
                   4791:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4792:     <code class="varname">MAKE_FILE</code> and
                   4793:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4794:     package.</p>
                   4795: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.385     leot     4796:     <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
                   4797:     <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.299     rillig   4798:     default value of <code class="varname">MAKE_FILE</code> is
1.385     leot     4799:     <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
                   4800:     defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.299     rillig   4801: <p>If there is no build step at all, set
1.385     leot     4802:     <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97      rillig   4803: </div>
1.148     asau     4804: <div class="sect1">
1.97      rillig   4805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4806: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.391   ! wiz      4807: <p>The test phase is for running a program's self
        !          4808:     tests. Dependencies that are only required for testing can be
        !          4809:     specified using <code class="varname">TEST_DEPENDS</code>.</p>
        !          4810: <p>For packages using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for building, you can set
        !          4811:     <code class="varname">TEST_TARGET</code>. Often, the proper value is
        !          4812:     <span class="quote">“<span class="quote">check</span>”</span> or <span class="quote">“<span class="quote">test</span>”</span>. If more elaborate
        !          4813:     steps are needed, you can define a <code class="literal">do-test</code>
        !          4814:     target.</p>
        !          4815: <p>To run the tests, call <span class="quote">“<span class="quote">make test</span>”</span>.</p>
        !          4816: <p>When building a package, the tests are not run
        !          4817:     automatically, except if <code class="varname">PKGSRC_RUN_TEST</code> is set
        !          4818:     to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75      rillig   4819: </div>
1.148     asau     4820: <div class="sect1">
1.75      rillig   4821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4822: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.299     rillig   4823: <p>Once the build stage has completed, the final step is to
                   4824:     install the software in public directories, so users can
                   4825:     access the programs and files.</p>
1.301     rillig   4826: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4827:     of the following code is executed; see
                   4828:     <code class="filename">mk/install/install.mk</code>, target
                   4829:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4830:     before and after this code, several consistency checks are run
                   4831:     against the files-to-be-installed, see
                   4832:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4833: <pre class="programlisting">
                   4834: .for dir in ${INSTALL_DIRS}
                   4835:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4836:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4837:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4838:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4839: .endfor
1.220     wiz      4840: </pre>
1.299     rillig   4841: <p>The variable's meanings are analogous to the ones in the
                   4842:     <span class="emphasis"><em>build</em></span> phase.
                   4843:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4844:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.385     leot     4845:     is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
                   4846:     <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.299     rillig   4847:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4848:     defined.</p>
                   4849: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4850:     variables are useful. They are all variations of the
1.378     leot     4851:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4852:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4853:     install command. The specialized variants, together with their
                   4854:     intended use, are:</p>
                   4855: <div class="variablelist"><dl class="variablelist">
                   4856: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4857: <dd><p>directories that contain
                   4858:       binaries</p></dd>
                   4859: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4860: <dd><p>directories that contain
                   4861:       scripts</p></dd>
                   4862: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4863: <dd><p>directories that contain shared and static
                   4864:       libraries</p></dd>
                   4865: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4866: <dd><p>directories that contain data
                   4867:       files</p></dd>
                   4868: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4869: <dd><p>directories that contain man
                   4870:       pages</p></dd>
                   4871: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4872: <dd><p>directories that contain data files for games
                   4873:       </p></dd>
                   4874: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4875: <dd><p>binaries that can be stripped from debugging
                   4876:       symbols</p></dd>
                   4877: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4878: <dd><p>binaries that cannot be
                   4879:       stripped</p></dd>
                   4880: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4881: <dd><p>game
                   4882:       binaries</p></dd>
                   4883: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4884: <dd><p>shared and static
                   4885:       libraries</p></dd>
                   4886: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4887: <dd><p>data files</p></dd>
                   4888: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4889: <dd><p>data files for
                   4890:       games</p></dd>
                   4891: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4892: <dd><p>man pages</p></dd>
                   4893: </dl></div>
                   4894: <p>Some other variables are:</p>
                   4895: <div class="variablelist"><dl class="variablelist">
                   4896: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.378     leot     4897: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4898:       when installing binaries. Any debugging sections and symbols present in
                   4899:       binaries will be preserved.
                   4900:       </p></dd>
                   4901: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4902: <dd><p>A list of directories relative to
                   4903:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4904:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4905:       The package is supposed to create all needed directories itself
                   4906:       before installing files to it and list all other directories here.
                   4907:       </p></dd>
                   4908: </dl></div>
                   4909: <p>In the rare cases that a package shouldn't install anything,
1.385     leot     4910:     set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.299     rillig   4911:     mostly relevant for packages in the <code class="filename">regress</code>
                   4912:     category.</p>
1.75      rillig   4913: </div>
1.148     asau     4914: <div class="sect1">
1.75      rillig   4915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4916: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.299     rillig   4917: <p>Once the install stage has completed, a binary package of
                   4918:     the installed files can be built.  These binary packages can be
                   4919:     used for quick installation without previous compilation, e.g. by
                   4920:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4921:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4922: <p>By default, the binary packages are created in
                   4923:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4924:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4925:     one for each category in the <code class="varname">CATEGORIES</code>
                   4926:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4927:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4928: </div>
1.148     asau     4929: <div class="sect1">
1.75      rillig   4930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4931: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
1.299     rillig   4932: <p>Once you're finished with a package, you can clean the work
                   4933:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4934:     to clean the work directories of all dependencies too, use
                   4935:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4936: </div>
1.148     asau     4937: <div class="sect1">
1.75      rillig   4938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4939: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4940: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4941: <dt><span class="term">pre/post-*</span></dt>
                   4942: <dd>
                   4943: <p>For any of the main targets described in the previous
                   4944:          section (configure, build, install, etc.), two auxiliary
                   4945:          targets exist with
1.385     leot     4946:          <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.299     rillig   4947:          prefix for the main target's name.  These targets are
                   4948:          invoked before and after the main target is called,
                   4949:          allowing extra configuration or installation steps be
                   4950:          performed from a package's Makefile, for example, which
                   4951:          a program's configure script or install target
                   4952:          omitted.</p>
                   4953: <p>About 5% of the pkgsrc packages define their custom
                   4954:          post-extract target, another 5% define pre-configure, and 10%
                   4955:          define post-install. The other pre/post-* targets are defined
                   4956:          even less often.</p>
                   4957: </dd>
                   4958: <dt><span class="term">do-*</span></dt>
1.75      rillig   4959: <dd>
1.299     rillig   4960: <p>Should one of the main targets do the wrong thing,
                   4961:          and should there be no variable to fix this, you can
                   4962:          redefine it with the do-* target.  (Note that redefining
                   4963:          the target itself instead of the do-* target is a bad
                   4964:          idea, as the pre-* and post-* targets won't be called
                   4965:          anymore, etc.)</p>
                   4966: <p>About 15% of the pkgsrc packages override the default
                   4967:          do-install, the other do-* targets are overridden even less
                   4968:          often.</p>
1.75      rillig   4969: </dd>
1.299     rillig   4970: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4971: <dd>
1.299     rillig   4972: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4973:          you noticed some file was not installed properly, you
                   4974:          can repeat the installation with this target, which will
1.385     leot     4975:          ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.299     rillig   4976: <p>This is the default value of
                   4977:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4978:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4979:          package</strong></span>, where the defaults are
1.385     leot     4980:          <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.299     rillig   4981:          respectively.</p>
1.75      rillig   4982: </dd>
1.299     rillig   4983: <dt><span class="term">deinstall</span></dt>
                   4984: <dd>
1.378     leot     4985: <p>This target does a <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4986:          current directory, effectively de-installing the
                   4987:          package. The following variables can be used to tune the
                   4988:          behaviour:</p>
                   4989: <div class="variablelist"><dl class="variablelist">
                   4990: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.378     leot     4991: <dd><p>Add a "-v" to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4992: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4993: <dd><p>Remove all packages that require (depend on)
                   4994:                the given package.  This can be used to remove any
                   4995:                packages that may have been pulled in by a given
                   4996:                package, e.g. if <span class="command"><strong>make deinstall
                   4997:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4998:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4999:                likely to remove whole KDE. Works by adding
1.385     leot     5000:                <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   5001:                command line.</p></dd>
                   5002: </dl></div>
                   5003: </dd>
                   5004: <dt><span class="term">bin-install</span></dt>
                   5005: <dd><p>Install a binary package from local disk and via FTP
                   5006:          from a list of sites (see the
                   5007:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   5008:          <span class="command"><strong>make package</strong></span> if no binary package is
                   5009:          available anywhere.  The arguments given to
                   5010:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   5011:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   5012:          operation, etc.</p></dd>
                   5013: <dt><span class="term">install-clean</span></dt>
                   5014: <dd><p>This target removes the state files for the "install" and later
                   5015:          phases so that the "install" target may be re-invoked. This can be
                   5016:          used after editing the PLIST to install the package without
                   5017:          rebuilding it.</p></dd>
                   5018: <dt><span class="term">build-clean</span></dt>
                   5019: <dd><p>This target removes the state files for the "build" and later
                   5020:          phases so that the "build" target may be re-invoked.</p></dd>
                   5021: <dt><span class="term">update</span></dt>
                   5022: <dd>
                   5023: <p>This target causes the current package to be
                   5024:          updated to the latest version.  The package and all
                   5025:          depending packages first get de-installed, then current
                   5026:          versions of the corresponding packages get compiled and
                   5027:          installed.  This is similar to manually noting which
                   5028:          packages are currently installed, then performing a
                   5029:          series of <span class="command"><strong>make deinstall</strong></span> and
                   5030:          <span class="command"><strong>make install</strong></span> (or whatever
                   5031:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   5032:          packages.</p>
1.385     leot     5033: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.299     rillig   5034:          resume package updating in case a previous <span class="command"><strong>make
                   5035:          update</strong></span> was interrupted for some reason.
                   5036:          However, in this case, make sure you don't call
                   5037:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   5038:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   5039:          Otherwise, you lose the ability to automatically update
                   5040:          the current package along with the dependent packages
                   5041:          you have installed.</p>
                   5042: <p>Resuming an interrupted <span class="command"><strong>make
                   5043:          update</strong></span> will only work as long as the package
                   5044:          tree remains unchanged.  If the source code for one of
                   5045:          the packages to be updated has been changed, resuming
                   5046:          <span class="command"><strong>make update</strong></span> will most certainly
                   5047:          fail!</p>
                   5048: <p>The following variables can be used either on the
                   5049:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   5050:          alter the behaviour of <span class="command"><strong>make
                   5051:          update</strong></span>:</p>
                   5052: <div class="variablelist"><dl class="variablelist">
                   5053: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   5054: <dd><p>Install target to recursively use for the
                   5055:                updated package and the dependent packages.
                   5056:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.385     leot     5057:                set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.299     rillig   5058:                <span class="command"><strong>make update</strong></span>.  Other good
1.385     leot     5059:                targets are <span class="quote">“<span class="quote">package</span>”</span> or
                   5060:                <span class="quote">“<span class="quote">bin-install</span>”</span>.  Do not set this to
                   5061:                <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.299     rillig   5062:                endless loop!</p></dd>
                   5063: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   5064: <dd><p>Don't clean up after updating.  Useful if
                   5065:                you want to leave the work sources of the updated
                   5066:                packages around for inspection or other purposes.
                   5067:                Be sure you eventually clean up the source tree
1.385     leot     5068:                (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.299     rillig   5069:                or you may run into troubles with old source code
                   5070:                still lying around on your next
                   5071:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   5072:                update</strong></span>.</p></dd>
                   5073: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   5074: <dd><p>Deinstall each package before installing
                   5075:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   5076:                may be necessary if the
1.385     leot     5077:                <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.299     rillig   5078:                called after interrupting a running <span class="command"><strong>make
                   5079:                update</strong></span>.</p></dd>
                   5080: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   5081: <dd><p>Allows you to disable recursion and hardcode
                   5082:                the target for packages.  The default is
1.385     leot     5083:                <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.299     rillig   5084:                facilitating a recursive update of prerequisite
                   5085:                packages.  Only set
                   5086:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   5087:                disable recursive updates. Use
                   5088:                <code class="varname">UPDATE_TARGET</code> instead to just
                   5089:                set a specific target for each package to be
                   5090:                installed during <span class="command"><strong>make update</strong></span>
                   5091:                (see above).</p></dd>
                   5092: </dl></div>
                   5093: </dd>
                   5094: <dt><span class="term">clean-update</span></dt>
                   5095: <dd>
                   5096: <p>Clean the source tree for all packages that would
                   5097:          get updated if <span class="command"><strong>make update</strong></span> was called
                   5098:          from the current directory.  This target should not be
                   5099:          used if the current package (or any of its depending
                   5100:          packages) have already been de-installed (e.g., after
                   5101:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   5102:          some packages you intended to update. As a rule of
                   5103:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   5104:          the first time you run <span class="command"><strong>make update</strong></span>
                   5105:          and only if you have a dirty package tree (e.g., if you
                   5106:          used <code class="varname">NOCLEAN</code>).</p>
                   5107: <p>If you are unsure about whether your tree is
                   5108:          clean, you can either perform a <span class="command"><strong>make
                   5109:          clean</strong></span> at the top of the tree, or use the
                   5110:          following sequence of commands from the directory of the
                   5111:          package you want to update (<span class="emphasis"><em>before</em></span>
                   5112:          running <span class="command"><strong>make update</strong></span> for the first
                   5113:          time, otherwise you lose all the packages you wanted to
                   5114:          update!):</p>
                   5115: <pre class="screen">
                   5116: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   5117: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   5118: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   5119:          </pre>
                   5120: <p>The following variables can be used either on the
                   5121:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   5122:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   5123: <div class="variablelist"><dl class="variablelist">
                   5124: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   5125: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   5126:                reconstruct the list of directories to update for
                   5127:                this package.  Only use this if <span class="command"><strong>make
                   5128:                update</strong></span> successfully installed all
                   5129:                packages you wanted to update.  Normally, this is
                   5130:                done automatically on <span class="command"><strong>make
                   5131:                update</strong></span>, but may have been suppressed by
                   5132:                the <code class="varname">NOCLEAN</code> variable (see
                   5133:                above).</p></dd>
                   5134: </dl></div>
                   5135: </dd>
                   5136: <dt><span class="term">replace</span></dt>
                   5137: <dd>
                   5138: <p>Update the installation of the current package.  This
                   5139:          differs from update in that it does not replace dependent
1.322     leot     5140:          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   5141:          target to work.</p>
                   5142: <p><span class="emphasis"><em>Be careful when using this
                   5143:          target!</em></span> There are no guarantees that dependent
                   5144:          packages will still work, in particular they will most
                   5145:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   5146:          library package whose shared library major version changed
                   5147:          between your installed version and the new one.  For this
                   5148:          reason, this target is not officially supported and only
                   5149:          recommended for advanced users.</p>
                   5150: </dd>
                   5151: <dt><span class="term">info</span></dt>
1.378     leot     5152: <dd><p>This target invokes <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   5153:          package. You can use this to check which version of a
                   5154:          package is installed.</p></dd>
                   5155: <dt><span class="term">index</span></dt>
                   5156: <dd>
                   5157: <p>This is a top-level command, i.e. it should be used in
                   5158:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   5159:          database of all packages in the local pkgsrc tree, including
                   5160:          dependencies, comment, maintainer, and some other useful
                   5161:          information.  Individual entries are created by running
                   5162:          <span class="command"><strong>make describe</strong></span> in the packages'
                   5163:          directories.  This index file is saved as
                   5164:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   5165:          verbose format by running <span class="command"><strong>make
                   5166:          print-index</strong></span>.  You can search in it with
                   5167:          <span class="command"><strong>make search
                   5168:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   5169:          extract a list of all packages that depend on a particular
                   5170:          one by running <span class="command"><strong>make show-deps
                   5171:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   5172: <p>Running this command takes a very long time, some
                   5173:          hours even on fast machines!</p>
                   5174: </dd>
                   5175: <dt><span class="term">readme</span></dt>
                   5176: <dd>
                   5177: <p>This target generates a
1.314     nia      5178:          <code class="filename">index.html</code> file, which can be
1.322     leot     5179:          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   5180:          contain references to any packages which are in the
                   5181:          <code class="varname">PACKAGES</code> directory on the local
                   5182:          host. The generated files can be made to refer to URLs
                   5183:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   5184:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      5185:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   5186:          files which pointed to binary packages on the local
                   5187:          machine, in the directory
                   5188:          <code class="filename">/usr/packages</code>, set
                   5189:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   5190:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   5191:          <code class="varname">${PACKAGES}</code> directory and its
                   5192:          subdirectories will be searched for all the binary
                   5193:          packages.</p>
                   5194: <p>The target can be run at the toplevel or in category
                   5195:          directories, in which case it descends recursively.</p>
                   5196: </dd>
                   5197: <dt><span class="term">readme-all</span></dt>
                   5198: <dd><p>This is a top-level command, run it in
                   5199:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   5200:          file <code class="filename">README-all.html</code> which contains a
                   5201:          list of all packages currently available in the NetBSD
                   5202:          Packages Collection, together with the category they belong
                   5203:          to and a short description. This file is compiled from the
1.314     nia      5204:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   5205:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   5206:          readme</strong></span>.</p></dd>
                   5207: <dt><span class="term">cdrom-readme</span></dt>
                   5208: <dd><p>This is very much the same as the
1.385     leot     5209:          <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.299     rillig   5210:          used when generating a pkgsrc tree to be written to a
                   5211:          CD-ROM.  This target also produces
1.314     nia      5212:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   5213:          to refer to URLs based on
                   5214:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   5215:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   5216: <dt><span class="term">show-distfiles</span></dt>
                   5217: <dd><p>This target shows which distfiles and patchfiles
                   5218:          are needed to build the package
                   5219:          (<code class="varname">ALLFILES</code>, which contains all
                   5220:          <code class="varname">DISTFILES</code> and
                   5221:          <code class="varname">PATCHFILES</code>, but not
                   5222:          <code class="filename">patches/*</code>).</p></dd>
                   5223: <dt><span class="term">show-downlevel</span></dt>
                   5224: <dd><p>This target shows nothing if the package is not
                   5225:          installed. If a version of this package is installed,
                   5226:          but is not the version provided in this version of
                   5227:          pkgsrc, then a warning message is displayed. This target
                   5228:          can be used to show which of your installed packages are
                   5229:          downlevel, and so the old versions can be deleted, and
                   5230:          the current ones added.</p></dd>
                   5231: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5232: <dd><p>This target shows the directory in the pkgsrc
                   5233:          hierarchy from which the package can be built and
                   5234:          installed. This may not be the same directory as the one
                   5235:          from which the package was installed. This target is
                   5236:          intended to be used by people who may wish to upgrade
                   5237:          many packages on a single host, and can be invoked from
                   5238:          the top-level pkgsrc Makefile by using the
1.385     leot     5239:          <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.299     rillig   5240: <dt><span class="term">show-installed-depends</span></dt>
                   5241: <dd><p>This target shows which installed packages match
                   5242:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5243:          if out of date dependencies are causing build
                   5244:          problems.</p></dd>
                   5245: <dt><span class="term">print-build-depends-list</span></dt>
                   5246: <dd><p>This target shows the list of packages that the current package
                   5247:            depends on for building.</p></dd>
                   5248: <dt><span class="term">print-run-depends-list</span></dt>
                   5249: <dd><p>This target shows the list of packages that the current package
                   5250:            depends on for running.</p></dd>
                   5251: <dt><span class="term">check-shlibs</span></dt>
                   5252: <dd><p>After a package is installed, check all its
                   5253:          binaries and (on ELF platforms) shared libraries to see
                   5254:          if they find the shared libs they need.  Run by default
                   5255:          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>
                   5256: <dt><span class="term">print-PLIST</span></dt>
                   5257: <dd>
1.385     leot     5258: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.299     rillig   5259:          upgraded pkg, this prints out an attempt to generate a
                   5260:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5261:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5262:          to care for shared libs etc., but it is
                   5263:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5264:          result before putting it into
                   5265:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5266:          diff the output of this command against an already
                   5267:          existing <code class="filename">PLIST</code> file.</p>
1.378     leot     5268: <p>If the package installs files via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5269:          other methods that don't update file access times, be
                   5270:          sure to add these files manually to your
1.385     leot     5271:          <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
                   5272:          -newer</span>”</span> command used by this target won't catch
1.299     rillig   5273:          them!</p>
1.385     leot     5274: <p>See <a class="xref" href="#print-PLIST" title="19.3. Tweaking output of make print-PLIST">Section 19.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.299     rillig   5275:          information on this target.</p>
                   5276: </dd>
1.371     cheusov  5277: <dt><span class="term">rebuild</span></dt>
                   5278: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
                   5279:          noticed some further modifications of sources are needed,
                   5280:          you can repeat the build with this target, which will ignore
1.385     leot     5281:          the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
1.371     cheusov  5282:          helpful while working with patches.</p></dd>
                   5283: <dt><span class="term">repackage</span></dt>
                   5284: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
                   5285:          noticed some further modifications of sources are needed,
                   5286:          you can repeat the package with this target, which will ignore
1.385     leot     5287:          the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
1.371     cheusov  5288:          helpful while working with patches, PLIST* files etc.</p></dd>
                   5289: <dt><span class="term">retest</span></dt>
                   5290: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
                   5291:          noticed some further modifications of sources are needed,
                   5292:          you can repeat the test with this target, which will ignore
1.385     leot     5293:          the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
1.371     cheusov  5294:          helpful while working with patches.</p></dd>
1.299     rillig   5295: </dl></div>
                   5296: </div>
                   5297: </div>
                   5298: <div class="chapter">
                   5299: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     5300: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.299     rillig   5301: <div class="toc">
                   5302: <p><b>Table of Contents</b></p>
                   5303: <dl class="toc">
                   5304: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5305: <dd><dl>
1.334     nia      5306: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   5307: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   5308: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299     rillig   5309: </dl></dd>
                   5310: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5311: <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>
                   5312: </dl>
                   5313: </div>
                   5314: <p>When you find a package that is not yet in pkgsrc, you
                   5315: most likely have a URL from where you can download the source
                   5316: code. Starting with this URL, creating a package involves only a
                   5317: few steps.</p>
                   5318: <div class="procedure"><ol class="procedure" type="1">
                   5319: <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
                   5320: enable the basic quality checks.</p></li>
                   5321: <li class="step">
1.322     leot     5322: <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   5323: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5324: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5325: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5326: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5327: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5328: </li>
                   5329: <li class="step">
                   5330: <p>Choose one of the top-level directories as the category in
                   5331: which you want to place your package. You can also create a directory of
1.334     nia      5332: your own (maybe called <code class="filename">local</code>). Change into that
                   5333: category directory:</p>
                   5334: <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   5335: </li>
                   5336: <li class="step">
1.334     nia      5337: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
                   5338: argument the URL of the distribution file (in most cases a
                   5339: <code class="filename">.tar.gz</code> file). This will download the distribution
                   5340: file and create the necessary files of the package, based on what's in
                   5341: the distribution file:</p>
1.299     rillig   5342: <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>
                   5343: </li>
                   5344: <li class="step">
                   5345: <p>Examine the extracted files to determine the dependencies of
                   5346: your package. Ideally, this is mentioned in some
                   5347: <code class="filename">README</code> file, but things may differ. For each of
                   5348: these dependencies, look where it exists in pkgsrc, and if there is a
                   5349: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5350: line to your package <code class="filename">Makefile</code> which includes that
                   5351: file just before the last line. If the
                   5352: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5353: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5354: that the package's include files and libraries are provided.</p>
1.334     nia      5355: <p>If you just need binaries from a dependent package, add a
1.299     rillig   5356: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5357: version of the dependency and where it can be found in pkgsrc. This line
                   5358: should be placed in the third paragraph. If the dependency is only
                   5359: needed for building the package, but not when using it, use
                   5360: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5361: instead of <code class="varname">DEPENDS</code>.
                   5362: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5363: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5364: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334     nia      5365: packages, i.e. packages for the platform where the package is built;
1.299     rillig   5366: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334     nia      5367: packages, i.e. packages for the platform for which the package
                   5368: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
                   5369: specifies a dependency used only for testing the resulting package
                   5370: built, using the upstream project's included test suite, on the native
                   5371: platform.
1.299     rillig   5372: Your package may then look like this:</p>
                   5373: <pre class="programlisting">
                   5374: [...]
                   5375: 
                   5376: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5377: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5378: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5379: 
                   5380: [...]
                   5381: 
                   5382: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5383: .include "../../devel/glib2/buildlink3.mk"
                   5384: .include "../../mk/bsd.pkg.mk"
                   5385: </pre>
                   5386: </li>
                   5387: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.385     leot     5388: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.299     rillig   5389: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5390: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5391: additional explanations.</p></li>
                   5392: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.385     leot     5393: 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, “Common types of packages”</a>. After you have followed the instructions
1.299     rillig   5394: over there, you can hopefully continue here.</p></li>
                   5395: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5396: directory from the extracted files. Besides these files, a lot of cache
1.334     nia      5397: files and other system information have been saved in the working
                   5398: directory, which may have become outdated after you edited the
1.299     rillig   5399: <code class="filename">Makefile</code>.</p></li>
                   5400: <li class="step">
                   5401: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.385     leot     5402: 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      5403: <p>If the extracted files from the package need to be fixed, run
                   5404: multiple rounds of these commands:</p>
                   5405: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299     rillig   5406: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5407: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334     nia      5408: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
                   5409: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299     rillig   5410: </li>
                   5411: <li class="step"><p>When the package builds fine, the next step is to install
                   5412: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5413: everything works.</p></li>
                   5414: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5415: contains a list of the files that are installed by the package, is
                   5416: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5417: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5418: the file using your preferred text editor to see if the list of
                   5419: files looks plausible.</p></li>
                   5420: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5421: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5422: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5423: had been registered in the database of installed files, but with an
                   5424: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5425: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5426: registered with the list of files from
                   5427: <code class="filename">PLIST</code>.</p></li>
                   5428: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5429: from above again in a single step, making sure that the PLIST is correct
                   5430: and the whole package is created as intended.</p></li>
1.334     nia      5431: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
                   5432: left to do.</p></li>
1.385     leot     5433: <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>
1.299     rillig   5434: </ol></div>
                   5435: <div class="sect1">
                   5436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5437: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
1.299     rillig   5438: <div class="sect2">
                   5439: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5440: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299     rillig   5441: <p>Python modules and programs packages are easily created using a
                   5442: set of predefined variables.</p>
                   5443: <p>
                   5444: If some Python versions are not supported by the software, set the
                   5445: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5446: that are not supported, e.g.
                   5447: </p>
                   5448: <pre class="programlisting">
                   5449: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5450: </pre>
                   5451: <p>
1.363     gutterid 5452: If the packaged software is a Python module, include
1.372     wiz      5453: <code class="filename">../../lang/python/wheel.mk</code>.  Note per PEP-518,
1.376     wiz      5454: the minimum and default requirement to create .whl files is <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a>; however, there are various
                   5455: other possible tools that projects can use. Thus inclusion of
1.372     wiz      5456: <code class="filename">wheel.mk</code> does not imply these defaults are
                   5457: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
                   5458: specifically requires as packaging tools must be defined in the
                   5459: package Makefile.
1.330     wiz      5460: </p>
1.362     wiz      5461: <p>The package directory should be called
1.385     leot     5462: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
                   5463: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.299     rillig   5464: </p>
                   5465: <pre class="programlisting">
                   5466: DISTNAME=   foopymodule-1.2.10
                   5467: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5468: </pre>
1.341     gutterid 5469: <p>
                   5470: For software in PyPi, the name should match what PyPi specifies for
                   5471: "pip install software".
                   5472: </p>
1.299     rillig   5473: <p>If it is an application, include
1.385     leot     5474: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
1.299     rillig   5475: In order to correctly set the path to the Python interpreter, use the
                   5476: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5477: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5478: For example:
                   5479: </p>
                   5480: <pre class="programlisting">
                   5481: REPLACE_PYTHON=   *.py
                   5482: </pre>
                   5483: </div>
                   5484: <div class="sect2">
                   5485: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5486: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299     rillig   5487: <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>
                   5488: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322     leot     5489: 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   5490: Individual packages (and optionally their dependencies) may be created
                   5491: and updated.  R packages generally follow the same form, and most of
                   5492: the relevant information needed is contained in a
                   5493: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5494: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5495: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5496: creates or updates a package in the canonical form.  The resulting
                   5497: package should be reviewed for correctness.</p>
                   5498: </div>
                   5499: <div class="sect2">
                   5500: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5501: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299     rillig   5502: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322     leot     5503: <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   5504: <p>If the TeXlive package name is not known, it may be useful to
                   5505: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
1.385     leot     5506: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
1.299     rillig   5507: 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
                   5508: archive</a>.</p>
                   5509: <p>If the TeXlive package name is known, download the files from
                   5510: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5511: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5512: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5513: also have associated documentation packages, so download
                   5514: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5515: should be placed in the appropriate category directory, which is often
                   5516: but not always <code class="filename">print</code>.  Then run the following
                   5517: command in the category directory.</p>
                   5518: <pre class="programlisting">
                   5519: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5520: </pre>
                   5521: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5522: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5523: are correct.</p>
                   5524: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5525: currently does not include version information in package filenames
                   5526: and changes their contents periodically when updates occur.
                   5527: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5528: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5529: main one and the corresponding documentation, upload the distfiles
                   5530: with the following command in each package directory.</p>
                   5531: <pre class="programlisting">
                   5532: make upload-distfiles
                   5533: </pre>
                   5534: </div>
                   5535: </div>
                   5536: <div class="sect1">
                   5537: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5538: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
1.299     rillig   5539: <div class="sect2">
                   5540: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5541: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.299     rillig   5542: <div class="sect3">
                   5543: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5544: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
1.299     rillig   5545: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.385     leot     5546: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.299     rillig   5547: pkgsrc. As the description says it has to do with the web, the obvious
1.385     leot     5548: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.299     rillig   5549: <pre class="programlisting">
                   5550: <code class="prompt">$</code> mkdir www/nvu
                   5551: <code class="prompt">$</code> cd www/nvu
                   5552: </pre>
                   5553: <p>The web site says that the sources are available as a tar file, so
                   5554: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5555: <pre class="programlisting">
                   5556: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5557: </pre>
                   5558: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5559: below the <code class="varname">DISTNAME</code> line, as the package name should
1.385     leot     5560: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.299     rillig   5561: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5562: <code class="varname">COMMENT</code> fields. Then the package
                   5563: <code class="filename">Makefile</code> looked like that:</p>
                   5564: <pre class="programlisting">
                   5565: # $NetBSD $
                   5566: #
                   5567: 
                   5568: DISTNAME=       nvu-1.0-sources
                   5569: PKGNAME=        nvu-1.0
                   5570: CATEGORIES=     www
                   5571: MASTER_SITES=   http://cvs.nvu.com/download/
                   5572: EXTRACT_SUFX=   .tar.bz2
                   5573: 
                   5574: MAINTAINER=     rillig@NetBSD.org
                   5575: HOMEPAGE=       http://cvs.nvu.com/
                   5576: COMMENT=        Web Authoring System
                   5577: 
                   5578: # url2pkg-marker (please do not remove this line.)
                   5579: .include "../../mk/bsd.pkg.mk"
                   5580: </pre>
                   5581: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5582: this is a workaround to prevent CVS expanding to the filename of the
                   5583: guide.</p>
                   5584: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5585: source archive:</p>
                   5586: <pre class="programlisting">
                   5587: url2pkg&gt; Running "make makesum" ...
                   5588: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5589: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5590: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5591: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5592: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5593: url2pkg&gt; Running "make extract" ...
                   5594: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5595: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5596: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5597: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5598: ===&gt; Installing dependencies for nvu-1.0
                   5599: ===&gt; Overriding tools for nvu-1.0
                   5600: ===&gt; Extracting for nvu-1.0
                   5601: url2pkg&gt; Adjusting the Makefile.
                   5602: 
                   5603: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5604: 
                   5605: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5606: </pre>
                   5607: </div>
                   5608: <div class="sect3">
                   5609: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5610: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.299     rillig   5611: <p>Now that the package has been extracted, let's see what's inside
                   5612: it. The package has a <code class="filename">README.txt</code>, but that only
                   5613: says something about mozilla, so it's probably useless for seeing what
                   5614: dependencies this package has. But since there is a GNU configure script
                   5615: in the package, let's hope that it will complain about everything it
                   5616: needs.</p>
                   5617: <pre class="programlisting">
                   5618: <code class="prompt">$</code> bmake
                   5619: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5620: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5621: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5622: ===&gt; Patching for nvu-1.0
                   5623: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5624: ===&gt; Configuring for nvu-1.0
                   5625: [...]
                   5626: configure: error: Perl 5.004 or higher is required.
                   5627: [...]
                   5628: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5629: [...]
                   5630: </pre>
                   5631: <p>That worked quite well. So I opened the package Makefile in my
                   5632: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.385     leot     5633: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.299     rillig   5634: package have changed now, and since a perl wrapper is automatically
1.385     leot     5635: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.299     rillig   5636: from scratch.</p>
                   5637: <pre class="programlisting">
                   5638: <code class="prompt">$</code> bmake clean
                   5639: ===&gt; Cleaning for nvu-1.0
                   5640: <code class="prompt">$</code> bmake
                   5641: [...]
                   5642: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5643: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5644: [...]
                   5645: </pre>
1.385     leot     5646: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.299     rillig   5647: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5648: <pre class="programlisting">
                   5649: [...]
                   5650: checking for GTK - version &gt;= 1.2.0... no
                   5651: *** Could not run GTK test program, checking why...
                   5652: [...]
                   5653: </pre>
                   5654: <p>Now to the other dependencies. The first question is: Where is the
                   5655: GTK package hidden in pkgsrc?</p>
                   5656: <pre class="programlisting">
                   5657: <code class="prompt">$</code> echo ../../*/gtk*
                   5658: [many packages ...]
                   5659: <code class="prompt">$</code> echo ../../*/gtk
                   5660: ../../x11/gtk
                   5661: <code class="prompt">$</code> echo ../../*/gtk2
                   5662: ../../x11/gtk2
                   5663: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5664: ../../x11/gtk2/buildlink3.mk
                   5665: </pre>
                   5666: <p>The first try was definitely too broad. The second one had exactly
                   5667: one result, which is very good. But there is one pitfall with GNOME
                   5668: packages. Before GNOME 2 had been released, there were already many
                   5669: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5670: packages, the GNOME 2 packages were imported as separate packages, and
1.385     leot     5671: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.299     rillig   5672: whether this was the case here, and indeed it was.</p>
                   5673: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5674: file, adding the dependency is very easy. I just inserted an
                   5675: <code class="literal">.include</code> line before the last line of the package
                   5676: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5677: <pre class="programlisting">
                   5678: [...]
                   5679: .include "../../x11/gtk2/buildlink3.mk"
                   5680: .include "../../mk/bsd.pkg.mk
                   5681: </pre>
                   5682: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5683: was:</p>
1.75      rillig   5684: <pre class="programlisting">
1.299     rillig   5685: [...]
                   5686: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5687: checking for GTK - version &gt;= 1.2.0... no
                   5688: *** Could not run GTK test program, checking why...
                   5689: *** The test program failed to compile or link. See the file config.log for the
                   5690: *** exact error that occured. This usually means GTK was incorrectly installed
                   5691: *** or that you have moved GTK since it was installed. In the latter case, you
                   5692: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5693: configure: error: Test for GTK failed.
                   5694: [...]
1.222     sevan    5695: </pre>
1.385     leot     5696: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
                   5697: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.299     rillig   5698: told me that this package really wanted to have the GNOME 1 version of
                   5699: GTK. If the package had looked for GTK2, it would have looked for
                   5700: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5701: So I changed the <code class="literal">x11/gtk2</code> to
                   5702: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5703: and tried again.</p>
1.119     mishka   5704: <pre class="programlisting">
1.299     rillig   5705: [...]
                   5706: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5707: In file included from xpidl.c:42:
                   5708: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5709: In file included from xpidl.c:42:
                   5710: xpidl.h:132: error: parse error before "IDL_ns"
                   5711: [...]
1.222     sevan    5712: </pre>
1.299     rillig   5713: <p>The package still does not find all of its dependencies. Now the
                   5714: question is: Which package provides the
                   5715: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5716: <pre class="programlisting">
1.299     rillig   5717: <code class="prompt">$</code> echo ../../*/*idl*
                   5718: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5719: <code class="prompt">$</code> echo ../../*/*IDL*
                   5720: ../../net/libIDL
1.222     sevan    5721: </pre>
1.299     rillig   5722: <p>Let's take the one from the second try. So I included the
                   5723: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5724: again. But the error didn't change. After digging through some of the
                   5725: code, I concluded that the build process of the package was broken and
                   5726: couldn't have ever worked, but since the Mozilla source tree is quite
                   5727: large, I didn't want to fix it. So I added the following to the package
                   5728: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5729: <pre class="programlisting">
1.299     rillig   5730: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5731: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5732: </pre>
1.299     rillig   5733: <p>The latter line is needed because the package expects the library
                   5734: <code class="filename">libIDL.so</code>, but only
                   5735: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5736: wrapper to rewrite that on the fly.</p>
                   5737: <p>The next problem was related to a recent change of the FreeType
1.322     leot     5738: 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   5739: which patch files were relevant for this issue and copied them to the
                   5740: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5741: patches so that they applied cleanly and retried again. This time,
                   5742: everything worked.</p>
1.197     wiz      5743: </div>
1.299     rillig   5744: <div class="sect3">
                   5745: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5746: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5747: <pre class="programlisting">
1.299     rillig   5748: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5749: [...]
                   5750: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5751: <code class="prompt">$</code> bmake deinstall
                   5752: <code class="prompt">$</code> bmake install
1.222     sevan    5753: </pre>
1.299     rillig   5754: </div>
                   5755: </div>
1.75      rillig   5756: </div>
                   5757: </div>
1.148     asau     5758: <div class="chapter">
1.75      rillig   5759: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     5760: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5761: <div class="toc">
                   5762: <p><b>Table of Contents</b></p>
1.210     leot     5763: <dl class="toc">
1.299     rillig   5764: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5765: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5766: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5767: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5768: <dd><dl>
                   5769: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5770: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5771: <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>
                   5772: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 5773: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75      rillig   5774: </dl></dd>
                   5775: </dl>
                   5776: </div>
1.299     rillig   5777: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5778:   each of which forms a well-defined part of the pkgsrc system. Using
1.378     leot     5779:   the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299     rillig   5780:   like pkgsrc requires some discipline to keep the code correct and
                   5781:   understandable.</p>
                   5782: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5783:   programming are variables and shell
                   5784:   commands. Among these shell commands may even be more complex ones
1.378     leot     5785:   like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299     rillig   5786:   as intended it is necessary to quote all variables correctly when they
                   5787:   are used.</p>
                   5788: <p>This chapter describes some patterns that appear quite often in
                   5789:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5790:   with them.</p>
1.148     asau     5791: <div class="sect1">
1.75      rillig   5792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5793: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
1.299     rillig   5794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5795: <p>When you are creating a file as a
                   5796:     target of a rule, always write the data to a temporary file first
                   5797:     and finally rename that file. Otherwise there might occur an error
                   5798:     in the middle of generating the file, and when the user runs
1.378     leot     5799:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299     rillig   5800:     regenerated properly. Example:</p>
1.75      rillig   5801: <pre class="programlisting">
1.299     rillig   5802: wrong:
                   5803:         @echo "line 1" &gt; ${.TARGET}
                   5804:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5805:         @false
                   5806: 
                   5807: correct:
                   5808:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5809:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5810:         @false
                   5811:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5812: </pre>
1.299     rillig   5813: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5814:     <code class="filename">wrong</code> will exist, although there was an error
                   5815:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5816:     correct</strong></span> gives an error message twice, as expected.</p>
1.378     leot     5817: <p>You might remember that <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5818:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5819:     happens when it is interrupted, for example by pressing
                   5820:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.378     leot     5821:     when one of the commands fails (like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5822: </li></ul></div>
                   5823: </div>
                   5824: <div class="sect1">
                   5825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5826: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.299     rillig   5827: <p><code class="filename">Makefile</code> variables contain strings that
                   5828:     can be processed using the five operators <code class="code">=</code>,
                   5829:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.378     leot     5830:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5831:     page.</p>
                   5832: <p>When a variable's value is parsed from a
                   5833:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5834:     the backslash character <code class="code">\</code> are handled specially. If a
                   5835:     backslash is the last character in a line, that backslash is removed
                   5836:     from the line and the line continues with the next line of the file.</p>
                   5837: <p>The <code class="code">#</code> character starts a comment that reaches
                   5838:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5839:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5840: <p>The evaluation of variables either happens immediately or lazy.
                   5841:     It happens immediately when the variable occurs on the right-hand
                   5842:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5843:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5844:     In the other cases, it is evaluated lazily.</p>
                   5845: <p>Some of the modifiers split the string into words and then
                   5846:     operate on the words, others operate on the string as a whole. When a
                   5847:     string is split into words, double quotes and single quotes are
1.378     leot     5848:     interpreted as delimiters, just like in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5849: <div class="sect2">
                   5850: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5851: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
1.299     rillig   5852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5853: <li class="listitem"><p>All variable names starting with an underscore
                   5854:        are reserved for use by the pkgsrc infrastructure. They shall
                   5855:        not be used by packages.</p></li>
                   5856: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5857:        lowercase variable names for the iteration
                   5858:        variables.</p></li>
                   5859: <li class="listitem"><p>All list variables should have a plural name,
                   5860:        such as <code class="varname">PKG_OPTIONS</code> or
                   5861:        <code class="varname">DISTFILES</code>.</p></li>
                   5862: </ul></div>
                   5863: </div>
                   5864: </div>
                   5865: <div class="sect1">
                   5866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5867: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
1.299     rillig   5868: <div class="sect2">
                   5869: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5870: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
1.299     rillig   5871: <p>When adding a string that possibly contains whitespace or quotes to
                   5872: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5873: modifier.</p>
                   5874: <p>When adding another list to a list (example 2), it must not be
                   5875: quoted, since its elements are already quoted.</p>
1.75      rillig   5876: <pre class="programlisting">
1.299     rillig   5877: STRING=         foo * bar `date`
                   5878: LIST=           # empty
                   5879: ANOTHER_LIST=   a=b c=d
                   5880: 
                   5881: LIST+=          ${STRING:Q}       # 1
                   5882: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5883: </pre>
1.299     rillig   5884: </div>
                   5885: <div class="sect2">
                   5886: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5887: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.299     rillig   5888: <p>Echoing a string containing special characters needs special
                   5889: work.</p>
1.75      rillig   5890: <pre class="programlisting">
1.299     rillig   5891: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5892: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5893: 
                   5894: all:
                   5895:         echo ${STRING}                  # 1
                   5896:         echo ${STRING:Q}                # 2
                   5897:         printf '%s\n' ${STRING:Q}''     # 3
                   5898:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5899: </pre>
1.299     rillig   5900: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5901: are just copied.</p>
                   5902: <p>Example 2 quotes the string so that the shell interprets it
                   5903: correctly. But the echo command may additionally interpret strings with a
                   5904: leading dash or those containing backslashes.</p>
1.378     leot     5905: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5906: interprets the format string, but not the next argument. The trailing
                   5907: single quotes handle the case when the string is empty. In that case, the
                   5908: :Q modifier would result in an empty string too, which would then be
1.378     leot     5909: skipped by the shell. For <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5910: but other programs may care.</p>
                   5911: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5912: need to be quoted because the quoting has already been done
                   5913: when adding elements to the list.</p>
1.75      rillig   5914: </div>
1.148     asau     5915: <div class="sect2">
1.75      rillig   5916: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5917: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.299     rillig   5918: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5919: GNU-style configure script (especially those that call other configure
                   5920: scripts), it must not have leading or trailing whitespace, since
                   5921: otherwise the configure script gets confused. To trim leading and
                   5922: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5923: following example:</p>
1.75      rillig   5924: <pre class="programlisting">
1.299     rillig   5925: CPPFLAGS=               # empty
                   5926: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5927: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5928: 
1.299     rillig   5929: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5930: 
1.299     rillig   5931: all:
                   5932:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5933:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5934: </pre>
                   5935: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5936: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5937: space.</p>
                   5938: </div>
                   5939: <div class="sect2">
                   5940: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5941: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
1.299     rillig   5942: <p>When a possibly empty variable is used in a shell program, it may
                   5943: lead to a syntax error.</p>
                   5944: <pre class="programlisting">
                   5945: EGFILES=        # empty
1.87      wiz      5946: 
1.299     rillig   5947: install-examples:   # produces a syntax error in the shell
                   5948:         for egfile in ${EGFILES}; do            \
                   5949:                 echo "Installing $$egfile";     \
                   5950:         done
                   5951: </pre>
                   5952: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.378     leot     5953: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5954: To fix this syntax error, use one of the snippets below.</p>
                   5955: <pre class="programlisting">
1.344     gutterid 5956: EGFILES=        # empty
1.87      wiz      5957: 
1.299     rillig   5958: install-examples:
                   5959:         for egfile in ${EGFILES} ""; do         \
                   5960:                 [ -n "$$egfile" ] || continue;  \
                   5961:                 echo "Installing $$egfile";     \
                   5962:         done
                   5963: </pre>
                   5964: <p>In this case, an empty string is appended to the iteration list (to
                   5965: prevent the syntax error) and filtered out later.</p>
                   5966: <pre class="programlisting">
                   5967: EGFILES=        # empty
1.87      wiz      5968: 
1.299     rillig   5969: install-examples:
                   5970: .for egfile in ${EGFILES}
                   5971:         echo "Installing ${egfile}"
                   5972: .endfor
1.100     rillig   5973: </pre>
1.299     rillig   5974: <p>If one of the filenames contains special characters, it should be
                   5975: enclosed in single or double quotes.</p>
                   5976: <p>To have a shell command test whether a make variable is empty, use
                   5977: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5978: </div>
1.344     gutterid 5979: <div class="sect2">
                   5980: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5981: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
1.344     gutterid 5982: <p>When a variable can have the values <code class="literal">yes</code> or
                   5983: <code class="literal">no</code>, use the following pattern to test the variable:</p>
                   5984: <pre class="programlisting">
                   5985: .if ${VAR:U:tl} == "yes"
                   5986: # do something
                   5987: .endif
                   5988: </pre>
                   5989: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
                   5990: can be undefined. If the variable is guaranteed to be defined, the
                   5991: <code class="literal">:U</code> can be omitted.</p>
                   5992: <p>The <code class="literal">:tl</code> modifier converts the variable value to
                   5993: lowercase, allowing for the values <code class="literal">yes</code>,
                   5994: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
                   5995: </div>
1.299     rillig   5996: </div>
                   5997: </div>
                   5998: <div class="chapter">
                   5999: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6000: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.299     rillig   6001: <div class="toc">
                   6002: <p><b>Table of Contents</b></p>
                   6003: <dl class="toc">
                   6004: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   6005: <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>
                   6006: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   6007: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   6008: </dl>
1.75      rillig   6009: </div>
1.299     rillig   6010: <p>Many packages have the ability to be built to support different
                   6011: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6012: in pkgsrc that provides generic handling of those options that
                   6013: determine different ways in which the packages can be built.  It's
                   6014: possible for the user to specify exactly which sets of options will be
                   6015: built into a package or to allow a set of global default options
                   6016: apply.</p>
                   6017: <p>There are two broad classes of behaviors that one might want to
                   6018: control via options.  One is whether some particular feature is
                   6019: enabled in a program that will be built anyway, often by including or
                   6020: not including a dependency on some other package.  The other is
                   6021: whether or not an additional program will be built as part of the
                   6022: package.  Generally, it is better to make a split package for such
                   6023: additional programs instead of using options, because it enables
                   6024: binary packages to be built which can then be added separately.  For
                   6025: example, the foo package might have minimal dependencies (those
                   6026: packages without which foo doesn't make sense), and then the foo-gfoo
                   6027: package might include the GTK frontend program gfoo.  This is better
                   6028: than including a gtk option to foo that adds gfoo, because either that
                   6029: option is default, in which case binary users can't get foo without
                   6030: gfoo, or not default, in which case they can't get gfoo.  With split
                   6031: packages, they can install foo without having GTK, and later decide to
                   6032: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6033: source users too, avoiding the need for rebuilds.</p>
                   6034: <p>Plugins with widely varying dependencies should usually be split
                   6035: instead of options.</p>
                   6036: <p>It is often more work to maintain split packages, especially if
                   6037: the upstream package does not support this.  The decision of split
                   6038: vs. option should be made based on the likelihood that users will want
                   6039: or object to the various pieces, the size of the dependencies that are
                   6040: included, and the amount of work.</p>
                   6041: <p>A further consideration is licensing.  Non-free parts, or parts
                   6042: that depend on non-free dependencies (especially plugins) should
                   6043: almost always be split if feasible.</p>
                   6044: <div class="sect1">
                   6045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6046: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.299     rillig   6047: <p>Global default options are listed in
                   6048: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6049: that should be built into every package if that option is supported.
                   6050: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6051: </div>
1.148     asau     6052: <div class="sect1">
1.75      rillig   6053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6054: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.299     rillig   6055: </h2></div></div></div>
                   6056: <p>The following example shows how
                   6057: <code class="filename">bsd.options.mk</code> should be used
                   6058: by the hypothetical ``wibble'' package, either in the package
                   6059: <code class="filename">Makefile</code>, or in a file,
                   6060: e.g. <code class="filename">options.mk</code>, that is included by the
                   6061: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6062: <pre class="programlisting">
1.299     rillig   6063: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6064: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6065: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6066: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6067: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6068: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6069: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6070: 
                   6071: .include "../../mk/bsd.prefs.mk"
                   6072: 
                   6073: # this package was previously named wibble2
                   6074: .if defined(PKG_OPTIONS.wibble2)
                   6075: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6076: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6077:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6078: .endif
                   6079: 
                   6080: .include "../../mk/bsd.options.mk"
                   6081: 
                   6082: # Package-specific option-handling
1.100     rillig   6083: 
1.299     rillig   6084: ###
                   6085: ### FOO support
                   6086: ###
                   6087: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6088: CONFIGURE_ARGS+=    --enable-foo
                   6089: .endif
1.100     rillig   6090: 
1.299     rillig   6091: ###
                   6092: ### LDAP support
                   6093: ###
                   6094: .if !empty(PKG_OPTIONS:Mldap)
                   6095: .  include "../../databases/openldap-client/buildlink3.mk"
                   6096: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6097: .endif
1.100     rillig   6098: 
1.299     rillig   6099: ###
                   6100: ### database support
                   6101: ###
                   6102: .if !empty(PKG_OPTIONS:Mmysql)
                   6103: .  include "../../mk/mysql.buildlink3.mk"
                   6104: .endif
                   6105: .if !empty(PKG_OPTIONS:Mpgsql)
                   6106: .  include "../../mk/pgsql.buildlink3.mk"
                   6107: .endif
                   6108: </pre>
                   6109: <p>The first section contains the information about which build
                   6110: options are supported by the package, and any default options settings
                   6111: if needed.</p>
                   6112: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6113: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.378     leot     6114: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299     rillig   6115: options.  It should be set to
                   6116: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6117: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6118: at the point where the options are processed.</p></li>
                   6119: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6120: build options supported by the package.</p></li>
                   6121: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6122: list of names of groups of mutually exclusive options.  The options in
                   6123: each group are listed in
                   6124: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6125: The most specific setting of any option from the group takes
                   6126: precedence over all other options in the group.  Options from the
                   6127: groups will be automatically added to
                   6128: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6129: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6130: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6131: packages will fail if no option from the group is
                   6132: selected.</p></li>
                   6133: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6134: of names of sets of options.  At least one option from each set must
                   6135: be selected.  The options in each set are listed in
                   6136: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6137: Options from the sets will be automatically added to
                   6138: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6139: fail if no option from the set is selected.</p></li>
                   6140: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6141: build options which are enabled by default.</p></li>
                   6142: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6143: of
1.385     leot     6144: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.299     rillig   6145: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   6146: their option counterparts.  Pairs should be added with
1.385     leot     6147: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables.  A
1.299     rillig   6148: warning will be issued if the user uses a legacy
                   6149: variable.</p></li>
                   6150: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6151: of
1.385     leot     6152: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.299     rillig   6153: pairs that map options that have been renamed to their new
1.385     leot     6154: counterparts.  Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.299     rillig   6155: the listing of global legacy options.  A warning will be issued if
                   6156: the user uses a legacy option.</p></li>
                   6157: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6158: options implied by deprecated variables used.  This can be used for
                   6159: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6160: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6161: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6162: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6163: a list of warnings about deprecated variables or options used, and
                   6164: what to use instead.</p></li>
                   6165: </ol></div>
                   6166: <p>A package should never modify
                   6167: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6168: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6169: To suggest a default set of options, use
                   6170: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6171: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6172: including <code class="filename">bsd.options.mk</code>.  If none of
                   6173: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6174: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6175: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6176: happen with platform-specific options if none of them is supported on
                   6177: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6178: empty list and the package is otherwise treated as not using the
                   6179: options framework.</p>
                   6180: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6181: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6182: build options, properly filtered to remove unsupported and duplicate
                   6183: options.</p>
                   6184: <p>The remaining sections contain the logic that is specific to
                   6185: each option.  The correct way to check for an option is to check
                   6186: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6187: <pre class="programlisting">
                   6188: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   6189: </pre>
1.75      rillig   6190: </div>
1.299     rillig   6191: <div class="sect1">
                   6192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6193: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.299     rillig   6194: <p>Options that enable similar features in different packages (like
                   6195: optional support for a library) should use a common name in all
                   6196: packages that support it (like the name of the library).  If another
                   6197: package already has an option with the same meaning, use the same
                   6198: name.</p>
                   6199: <p>Options that enable features specific to one package, where it's
                   6200: unlikely that another (unrelated) package has the same (or a similar)
                   6201: optional feature, should use a name prefixed with
                   6202: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6203: <p>If a group of related packages share an optional feature
                   6204: specific to that group, prefix it with the name of the
1.385     leot     6205: <span class="quote">“<span class="quote">main</span>”</span> package
1.299     rillig   6206: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6207: <p>For new options, add a line to
                   6208: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6209: fields, separated by tab.  The first field is the option name, the
                   6210: second its description.  The description should be a whole sentence
                   6211: (starting with an uppercase letter and ending with a period) that
1.385     leot     6212: describes what enabling the option does.  E. g. <span class="quote">“<span class="quote">Enable ispell
                   6213: support.</span>”</span> The file is sorted by option names.</p>
1.299     rillig   6214: </div>
                   6215: <div class="sect1">
                   6216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6217: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.299     rillig   6218: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   6219: different dependencies based on the options with which the package was
                   6220: built. For querying these options, the file
                   6221: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6222: typical example looks like this:</p>
1.87      wiz      6223: <pre class="programlisting">
1.299     rillig   6224: pkgbase := libpurple
                   6225: .include "../../mk/pkg-build-options.mk"
                   6226: 
                   6227: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6228: ...
                   6229: .endif
1.229     sevan    6230: </pre>
1.299     rillig   6231: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6232: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6233: options of the libpurple package, which can then be queried like
                   6234: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6235: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6236: details.</p>
1.75      rillig   6237: </div>
                   6238: </div>
1.148     asau     6239: <div class="chapter">
1.75      rillig   6240: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6241: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6242: <div class="toc">
                   6243: <p><b>Table of Contents</b></p>
1.210     leot     6244: <dl class="toc">
1.299     rillig   6245: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   6246: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   6247: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6248: </dl>
                   6249: </div>
1.299     rillig   6250: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6251: by pkgsrc and also for individual packages to define what commands
                   6252: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6253: or for later run-time of an installed packaged (such as
                   6254: <code class="varname">DEPENDS</code>).
                   6255: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6256: package will not be used.</p>
                   6257: <p>When building a package, the replacement tools are
                   6258: made available in a directory (as symlinks or wrapper scripts)
                   6259: that is early in the executable search path. Just like the buildlink
                   6260: system, this helps with consistent builds.</p>
                   6261: <p>A tool may be needed to help build a specific package. For example,
                   6262: perl, GNU make (gmake) or yacc may be needed.</p>
                   6263: <p>Also a tool may be needed, for example, because the native system's supplied
                   6264: tool may be inefficient for building a package with pkgsrc.
                   6265: For example, a package may need GNU awk, bison (instead of
                   6266: yacc) or a better sed.</p>
                   6267: <p>The tools used by a package can be listed by running
                   6268: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6269: <div class="sect1">
1.75      rillig   6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6271: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.299     rillig   6272: <p>The default set of tools used by pkgsrc is defined in
                   6273: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6274: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6275: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6276: These can be seen by running:
                   6277: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6278: <p>If a package needs a specific program to build
                   6279: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6280: to define the tools needed.</p>
1.75      rillig   6281: </div>
1.299     rillig   6282: <div class="sect1">
                   6283: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6284: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.299     rillig   6285: <p>In the following examples, the :run means that it is needed at
                   6286: run-time (and becomes a DEPENDS).
                   6287: The default is a build dependency which can be set with
                   6288: :build. (So in this example, it is the same as gmake:build
                   6289: and pkg-config:build.)</p>
1.75      rillig   6290: <pre class="programlisting">
1.299     rillig   6291: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6292: </pre>
1.299     rillig   6293: <p>When using the tools framework, a
                   6294: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6295: which contains the full path to the appropriate tool. For example,
1.385     leot     6296: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.299     rillig   6297: on Linux systems.</p>
                   6298: <p>If you always need a pkgsrc version of the
                   6299: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6300: </p>
1.75      rillig   6301: </div>
1.299     rillig   6302: <div class="sect1">
                   6303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6304: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.299     rillig   6305: <p>When improving or porting pkgsrc to a new platform, have a look
                   6306: at (or create) the corresponding platform specific make file fragment under
                   6307: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6308: the name of the common tools. For example:</p>
1.75      rillig   6309: <pre class="programlisting">
1.299     rillig   6310: .if exists(/usr/bin/bzcat)
                   6311: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6312: .elif exists(/usr/bin/bzip2)
                   6313: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6314: .endif
                   6315: 
                   6316: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6317: </pre>
1.75      rillig   6318: </div>
                   6319: </div>
1.299     rillig   6320: <div class="chapter">
                   6321: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6322: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
1.299     rillig   6323: <div class="toc">
                   6324: <p><b>Table of Contents</b></p>
                   6325: <dl class="toc">
                   6326: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6327: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6328: <dd><dl>
                   6329: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6330: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6331:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6332:       and
                   6333:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6334:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6335: </dl></dd>
                   6336: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355     rillig   6337: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299     rillig   6338: </dl>
1.75      rillig   6339: </div>
1.299     rillig   6340: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6341:   are seen by a package's configure and build processes.  This is implemented
                   6342:   in a two step process:</p>
                   6343: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6344: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6345:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6346:       of <code class="varname">WRKDIR</code>.</p></li>
                   6347: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6348:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6349:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6350:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6351:       native compiler on some operating systems look like GCC, so that
                   6352:       packages that expect GCC won't require modifications to build with
                   6353:       those native compilers.</p></li>
                   6354: </ol></div>
                   6355: <p>This normalizes the environment in which a package is built so that the
                   6356:   package may be built consistently despite what other software may be
                   6357:   installed. Please note that the normal system header and library paths,
                   6358:   e.g. <code class="filename">/usr/include</code>,
                   6359:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6360:   designed to insulate the package build from non-system-supplied
                   6361:   software.</p>
1.148     asau     6362: <div class="sect1">
1.75      rillig   6363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6364: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
1.299     rillig   6365: <p>The process of converting packages to use the buildlink3
1.385     leot     6366:     framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.299     rillig   6367:     The things to keep in mind are:</p>
1.128     wiz      6368: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6369: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6370:        instead of the actual toolchain.  Some packages are tricky,
                   6371:        and the only way to know for sure is the check
                   6372:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6373:        wrappers are being invoked.</p></li>
                   6374: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6375:        the package Makefile, e.g. Java VMs, standalone shells,
                   6376:        etc., because the code to symlink files into
                   6377:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.385     leot     6378:        relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.299     rillig   6379:        </p></li>
                   6380: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6381:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6382:        package's Makefile are added as dependencies for that package.
                   6383:        </p></li>
                   6384: </ol></div>
                   6385: <p>If a dependency on a particular package is required for its libraries and
                   6386:     headers, then we replace:</p>
                   6387: <pre class="programlisting">
                   6388: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6389: </pre>
                   6390: <p>with</p>
                   6391: <pre class="programlisting">
                   6392: .include "../../category/foo/buildlink3.mk"
                   6393: </pre>
                   6394: <p>The buildlink3.mk files usually define the required dependencies.
                   6395:     If you need a newer version of the dependency when using buildlink3.mk
                   6396:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6397: <pre class="programlisting">
1.299     rillig   6398: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6399: .include "../../category/foo/buildlink3.mk"
1.1       grant    6400: </pre>
1.299     rillig   6401: <p>There are several <code class="filename">buildlink3.mk</code>
                   6402:     files in <code class="filename">pkgsrc/mk</code>
                   6403:     that handle special package issues:</p>
                   6404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6405: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6406:        the native or a pkgsrc Berkeley DB implementation based on
                   6407:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6408:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6409: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6410:        comes with neither Curses nor NCurses, this will take care
1.322     leot     6411:        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   6412: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6413:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6414:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6415:        require a Kerberos 5 implementation.</p></li>
                   6416: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6417:        system-provided Motif installation or adds a dependency on
1.388     wiz      6418:        <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
                   6419:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span> or
                   6420:        <span class="quote">“<span class="quote">motif</span>”</span> to choose which Motif version will be
                   6421:        used.</p></li>
1.299     rillig   6422: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6423:        system-provided GNU readline or editline (libedit) installation,
1.322     leot     6424:        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>,
                   6425:        <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   6426:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6427:        If your package really needs GNU readline library, its Makefile
                   6428:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6429:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6430: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6431:        variables that may be used by packages that use the
                   6432:        Open Sound System (OSS) API.</p></li>
                   6433: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6434:        any of the Postgres versions in the variable
                   6435:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6436:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6437:        the file for more information.</p></li>
                   6438: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6439:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322     leot     6440:        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   6441: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6442:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6443:        library.</p></li>
                   6444: </ul></div>
                   6445: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6446:     files provide a more complete
                   6447:     description of how to use them properly.</p>
1.75      rillig   6448: </div>
1.148     asau     6449: <div class="sect1">
1.75      rillig   6450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6451: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.299     rillig   6452: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6453:     included by Makefiles to indicate the need to compile and link
                   6454:     against header files and libraries provided by the package.  A
                   6455:     <code class="filename">buildlink3.mk</code> file should always provide
                   6456:     enough information to add the correct type of dependency
                   6457:     relationship and include any other
                   6458:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6459:     headers and libraries that it needs in turn.</p>
                   6460: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322     leot     6461:     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   6462:     package is highly recommended.  For most packages, the following
                   6463:     command will generate a good starting point for
                   6464:     <code class="filename">buildlink3.mk</code> files:</p>
                   6465: <pre class="screen">
                   6466: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6467: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6468:     </pre>
1.148     asau     6469: <div class="sect2">
1.75      rillig   6470: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6471: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.299     rillig   6472: <p>The following real-life example
                   6473:       <code class="filename">buildlink3.mk</code> is taken
                   6474:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6475: <pre class="programlisting">
1.299     rillig   6476: BUILDLINK_TREE+=        tiff
                   6477: 
                   6478: .if !defined(TIFF_BUILDLINK3_MK)
                   6479: TIFF_BUILDLINK3_MK:=
                   6480: 
                   6481: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6482: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6483: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6484: 
                   6485: .include "../../devel/zlib/buildlink3.mk"
                   6486: .include "../../graphics/jpeg/buildlink3.mk"
                   6487: .endif # TIFF_BUILDLINK3_MK
                   6488: 
                   6489: BUILDLINK_TREE+=        -tiff
1.1       grant    6490: </pre>
1.299     rillig   6491: <p>The header and footer manipulate
                   6492:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6493:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6494:       the dependency tree.</p>
                   6495: <p>The main section is protected from multiple inclusion
                   6496:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6497:       added.  Several important variables are set in the section:</p>
                   6498: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6499: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6500:          is the dependency version recorded in the installed
1.299     rillig   6501:          package; this should always be set using
                   6502:          <span class="command"><strong>+=</strong></span> to ensure that
                   6503:          we're appending to any pre-existing list of values.  This
1.300     wiz      6504:          variable should be set to the last version of the
1.299     rillig   6505:          package that had an backwards-incompatible API change.
                   6506:          </p></li>
                   6507: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6508:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6509:          pkgsrc directory.</p></li>
                   6510: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6511:          (not shown above) controls whether we use
1.350     gutterid 6512:          <code class="varname">BUILD_DEPENDS</code> or
1.299     rillig   6513:          <code class="varname">DEPENDS</code> to add the dependency on
                   6514:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6515:          selected by setting
                   6516:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6517:          to <span class="quote">“<span class="quote">build</span>”</span>.  By default, the full dependency is
1.299     rillig   6518:          used.</p></li>
                   6519: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6520:            and
                   6521:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6522:            (not shown above) are lists of subdirectories of
                   6523:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6524:            to add to the header and library search paths.  These
1.385     leot     6525:            default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.299     rillig   6526:          respectively.</p></li>
                   6527: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6528:            (not shown above) is the list of preprocessor flags to add
                   6529:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.385     leot     6530:            configure and build phases.  The <span class="quote">“<span class="quote">-I</span>”</span> option
1.299     rillig   6531:            should be avoided and instead be handled using
                   6532:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6533:          above.</p></li>
                   6534: </ul></div>
                   6535: <p>The following variables are all optionally defined within
                   6536:       this second section (protected against multiple inclusion) and
                   6537:       control which package files are symlinked into
                   6538:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6539:       transformed during the symlinking:</p>
                   6540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6541: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6542:            (not shown above) is a shell glob pattern relative to
                   6543:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6544:            to be symlinked into
                   6545:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6546:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6547: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6548:            (not shown above) is a shell pipeline that
                   6549:            outputs to stdout a list of files relative to
                   6550:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6551:            The resulting files are to be symlinked
                   6552:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6553:            this takes the <code class="filename">+CONTENTS</code> of a
                   6554:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6555:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6556: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6557:            (not shown above) is a filter command that filters
                   6558:            <code class="filename">+CONTENTS</code> input into a list of files
                   6559:            relative to
                   6560:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6561:            on stdout.  By default,
                   6562:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6563:            outputs the contents of the <code class="filename">include</code>
                   6564:            and <code class="filename">lib</code> directories in the package
                   6565:            <code class="filename">+CONTENTS</code>.</p></li>
                   6566: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6567:            (not shown above) is a list of sed arguments used to
                   6568:            transform the name of the source filename into a
                   6569:            destination filename, e.g. <span class="command"><strong>-e
                   6570:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6571: </ul></div>
                   6572: <p>This section can additionally include any
                   6573:       <code class="filename">buildlink3.mk</code> needed for
                   6574:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6575:       Including these <code class="filename">buildlink3.mk</code> files
                   6576:       means that the headers and libraries for these
                   6577:       dependencies are also symlinked into
                   6578:       <code class="filename">${BUILDLINK_DIR}</code>
                   6579:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6580:       <code class="filename">buildlink3.mk</code>
                   6581:       file is included. Dependencies are only added for directly
                   6582:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6583: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6584:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6585:       please only add necessary ones, i.e., those whose libraries or
                   6586:       header files are automatically exposed when the package is
                   6587:       use.</p>
                   6588: <p>In particular, if only an executable
                   6589:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6590:       library does not need to be propagated in the
                   6591:       <code class="filename">buildlink3.mk</code> file.</p>
                   6592: <p>The following steps should help you decide if a
                   6593:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6594:       </p>
                   6595: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6596: <li class="listitem"><p>Look at the installed header files: What
                   6597:        headers do they include? The packages providing these files
                   6598:        must be buildlinked.</p></li>
                   6599: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6600:        libraries and look against what other libraries they link.
                   6601:        Some of the packages providing these probably need to be
                   6602:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6603:        some systems pulls in the X libraries, so they will show up in
                   6604:        the <code class="filename">ldd</code> output, while on others (like OS
                   6605:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6606:        used as a hint.</p></li>
                   6607: </ul></div>
                   6608: <p>
                   6609:       </p>
                   6610: </div>
1.148     asau     6611: <div class="sect2">
1.75      rillig   6612: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6613: <a name="updating-buildlink-depends"></a>18.2.2. Updating
1.299     rillig   6614:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6615:       and
                   6616:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6617:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6618: <p>Both variables set lower bounds for a version of this package.
                   6619:       The two variables differ in that one describes source
1.299     rillig   6620:       compatibility (API) and the other binary compatibility (ABI).
                   6621:       The difference is that a change in the API breaks compilation of
                   6622:       programs while changes in the ABI stop compiled programs from
                   6623:       running.</p>
1.300     wiz      6624: <p>The
                   6625:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6626:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6627:       changed very rarely.  (One possible scenario: If all packages
                   6628:       using this package need a higher version than defined in the
                   6629:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6630:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6631:       could be updated to that higher version.)</p>
                   6632: <p>On the other hand, changes to
1.299     rillig   6633:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6634:       are more common.  The variable will need to be updated every
                   6635:       time the major version of one of its shared libraries is changed,
                   6636:       or any other change where a binary built against the previous
                   6637:       version of the package will not run against the new version any
                   6638:       longer.</p>
                   6639: <p>In such a case, the package's
1.299     rillig   6640:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6641:       must be increased to require the new package version.  Then the
                   6642:       <code class="varname">PKGREVISION</code> of all packages
                   6643:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6644:       to be increased, and if they have
                   6645:       <code class="filename">buildlink3.mk</code> files,
                   6646:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6647:       in their <code class="filename">buildlink3.mk</code> files must be
                   6648:       increased to the new version as well. This is required so that a
                   6649:       package will pull in the versions of the packages that use the
                   6650:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6651:       uniquely identify the packages built against the new ABI. The
1.322     leot     6652:       <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      6653:       help with these updates.</p>
1.385     leot     6654: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
1.300     wiz      6655:       about dependencies on other packages, including the
                   6656:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6657: <p>Please take careful consideration before adjusting
                   6658:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6659:       or
                   6660:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6661:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6662:       cause unneeded package deletions and rebuilds.  In many cases,
                   6663:       new versions of packages work just fine with older
                   6664:       dependencies.</p>
1.326     gutterid 6665: <p>Also, it is not needed to set
1.299     rillig   6666:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6667:       when it is identical to
1.326     gutterid 6668:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6669: <p>Note there is also the distinction that users are able to disable
                   6670:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6671:       variable, but there is no equivalent option for API dependencies.</p>
1.75      rillig   6672: </div>
                   6673: </div>
1.148     asau     6674: <div class="sect1">
1.75      rillig   6675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6676: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.299     rillig   6677: <p>Some packages in pkgsrc install headers and libraries that
                   6678:       coincide with headers and libraries present in the base system.
                   6679:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6680:       packages should also include a <code class="filename">builtin.mk</code>
                   6681:       file that includes the necessary checks to decide whether using
                   6682:       the built-in software or the pkgsrc software is
                   6683:     appropriate.</p>
                   6684: <p>The only requirements of a builtin.mk file for
                   6685:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6686: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6687: <li class="listitem"><p>It should set
                   6688:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6689:        to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.299     rillig   6690:        after it is included.</p></li>
                   6691: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6692:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6693:        which is already set before the
                   6694:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6695: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6696:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6697:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6698: </ol></div>
                   6699: <div class="sect2">
                   6700: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6701: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.299     rillig   6702: <p>The following is the recommended template for builtin.mk
                   6703:       files:</p>
1.75      rillig   6704: <pre class="programlisting">
1.299     rillig   6705: .if !defined(IS_BUILTIN.foo)
                   6706: #
                   6707: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6708: # genuinely exists in the system or not.
                   6709: #
                   6710: IS_BUILTIN.foo?=        no
1.100     rillig   6711: 
1.299     rillig   6712: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6713: # version can be determined.
                   6714: #
                   6715: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6716: BUILTIN_PKG.foo?=       foo-1.0
                   6717: .  endif
                   6718: .endif  # IS_BUILTIN.foo
1.100     rillig   6719: 
1.299     rillig   6720: .if !defined(USE_BUILTIN.foo)
                   6721: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6722: .  if defined(BUILTIN_PKG.foo)
                   6723: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6724: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6725: USE_BUILTIN.foo!=                                                       \
                   6726:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6727:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6728: .      endif
                   6729: .    endfor
                   6730: .  endif
                   6731: .endif  # USE_BUILTIN.foo
1.100     rillig   6732: 
1.299     rillig   6733: CHECK_BUILTIN.foo?=     no
                   6734: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6735: #
                   6736: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6737: # "yes" or "no".
                   6738: #
                   6739: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6740: </pre>
1.299     rillig   6741: <p>The first section sets
                   6742:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6743:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6744:       in the base system.  This should not be a base system software
                   6745:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.385     leot     6746:       it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.299     rillig   6747:       included as part of the base system.  This variable is only
                   6748:       used internally within the <code class="filename">builtin.mk</code>
                   6749:       file.</p>
                   6750: <p>The second section sets
                   6751:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6752:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6753:       system if it exists (if
                   6754:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6755:       is <span class="quote">“<span class="quote">yes</span>”</span>).  This variable is only used internally
1.299     rillig   6756:       within the <code class="filename">builtin.mk</code> file.</p>
                   6757: <p>The third section sets
                   6758:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6759:       and is <span class="emphasis"><em>required</em></span> in all
                   6760:       <code class="filename">builtin.mk</code> files.  The code in this
                   6761:       section must make the determination whether the built-in
                   6762:       software is adequate to satisfy the dependencies listed in
                   6763:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6764:       This is typically done by comparing
                   6765:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6766:       against each of the dependencies in
                   6767:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6768:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6769:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6770:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6771:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6772:       may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.299     rillig   6773:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6774:       is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.299     rillig   6775:       that the built-in version of the software is similar enough to
                   6776:       be used as a replacement.</p>
                   6777: <p>The last section is guarded by
                   6778:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6779:       and includes code that uses the value of
                   6780:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6781:       set in the previous section.  This typically includes, e.g.,
                   6782:       adding additional dependency restrictions and listing additional
                   6783:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6784:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6785: </div>
1.107     rillig   6786: </div>
1.75      rillig   6787: </div>
1.148     asau     6788: <div class="chapter">
1.75      rillig   6789: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6790: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6791: <div class="toc">
                   6792: <p><b>Table of Contents</b></p>
1.210     leot     6793: <dl class="toc">
1.299     rillig   6794: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6795: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6796: <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>
                   6797: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6798: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6799: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6800: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6801: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6802: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6803: </dl>
                   6804: </div>
1.299     rillig   6805: <p>The <code class="filename">PLIST</code> file contains a package's
1.385     leot     6806:   <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.299     rillig   6807:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6808:   directory it's been installed in) plus some additional statements
1.378     leot     6809:   - see the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6810:   This chapter addresses some issues that need attention when
                   6811:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6812:   below!).</p>
1.148     asau     6813: <div class="sect1">
1.75      rillig   6814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6815: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
1.299     rillig   6816: <p>Be sure to add a RCS ID line as the first thing in any
                   6817:     <code class="filename">PLIST</code> file you write:</p>
                   6818: <pre class="programlisting">
                   6819: @comment $NetBSD $
                   6820: </pre>
                   6821: <p>An artificial space has been added between NetBSD and $, this is a
                   6822: workaround here to prevent CVS expanding to the filename of the guide. When
                   6823: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6824: </div>
1.148     asau     6825: <div class="sect1">
1.75      rillig   6826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6827: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.299     rillig   6828: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6829:     to output a PLIST that matches any new files since the package
1.385     leot     6830:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
1.299     rillig   6831:     more information on this target.</p>
1.75      rillig   6832: </div>
1.148     asau     6833: <div class="sect1">
1.75      rillig   6834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6835: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.299     rillig   6836: </h2></div></div></div>
                   6837: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6838:     of AWK patterns and actions that are used to filter the output of
                   6839:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6840:     scripting you like to it, but be careful with quoting.</p>
                   6841: <p>For example, to get all files inside the
                   6842:     <code class="filename">libdata/foo</code> directory removed from the
                   6843:     resulting PLIST:</p>
1.88      wiz      6844: <pre class="programlisting">
1.299     rillig   6845: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6846: </pre>
1.300     wiz      6847: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6848:     evaluated after the file list and directory list are sorted.
                   6849:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6850:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6851:     list and directory list are sorted.</p>
1.299     rillig   6852: </div>
                   6853: <div class="sect1">
                   6854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6855: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
1.299     rillig   6856: <p>A number of variables are substituted automatically in
                   6857:     PLISTs when a package is installed on a system. This includes the
                   6858:     following variables:</p>
                   6859: <div class="variablelist"><dl class="variablelist">
                   6860: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6861: <dd>
                   6862: <p>Some packages like emacs and perl embed information
                   6863:          about which architecture they were built on into the
                   6864:          pathnames where they install their files. To handle this
                   6865:          case, PLIST will be preprocessed before actually used, and
                   6866:          the symbol
1.385     leot     6867:          <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.299     rillig   6868:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6869:          same is done if the string
                   6870:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6871:          PLIST somewhere - use this on packages that have GNU
                   6872:          autoconf-created configure scripts.</p>
                   6873: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6874: <h3 class="title">Legacy note</h3>
                   6875: <p>There used to be a symbol
1.385     leot     6876:            <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.299     rillig   6877:            was replaced by the output of <span class="command"><strong>uname
                   6878:            -m</strong></span>, but that's no longer supported and has
                   6879:            been removed.</p>
                   6880: </div>
                   6881: </dd>
                   6882: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6883: <dd>
                   6884: <p>Some packages want to embed the OS name and version
                   6885:          into some paths.  To do this, use these variables in the
                   6886:          <code class="filename">PLIST</code>:
                   6887:          </p>
                   6888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.385     leot     6889: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
                   6890: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
                   6891: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.299     rillig   6892: </ul></div>
                   6893: </dd>
                   6894: </dl></div>
                   6895: <p>For a list of values which are replaced by
                   6896:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6897: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6898: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6899: <p>If you want to change other variables not listed above, you
                   6900:     can add variables and their expansions to this variable in the
1.385     leot     6901:     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, “Optional files”</a>):</p>
1.81      rillig   6902: <pre class="programlisting">
1.299     rillig   6903: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6904: </pre>
1.385     leot     6905: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.299     rillig   6906:     in the <code class="filename">PLIST</code> with
1.385     leot     6907:     <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.299     rillig   6908: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6909:     the common case of conditionally including some
                   6910:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6911:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6912:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6913:     to <code class="literal">yes</code> if the entry should be included.
1.385     leot     6914:     This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.299     rillig   6915:     in the <code class="filename">PLIST</code> with either
1.385     leot     6916:     <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
                   6917:     <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.299     rillig   6918:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6919: <pre class="programlisting">
1.299     rillig   6920: PLIST_VARS+=    foo
                   6921: .if <em class="replaceable"><code>condition</code></em>
                   6922: PLIST.foo=      yes
                   6923: .else
1.174     asau     6924: </pre>
1.299     rillig   6925: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6926: <pre class="programlisting">
1.299     rillig   6927: @comment $NetBSD $
                   6928: bin/bar
                   6929: man/man1/bar.1
                   6930: ${PLIST.foo}bin/foo
                   6931: ${PLIST.foo}man/man1/foo.1
                   6932: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6933: </pre>
1.299     rillig   6934: <p>An artificial space has been added between NetBSD and $, this is a
                   6935: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6936: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6937: </div>
1.299     rillig   6938: <div class="sect1">
                   6939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6940: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
1.299     rillig   6941: <p>Man pages should be installed in compressed form if
                   6942:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6943:     and uncompressed otherwise. To handle this in the
1.385     leot     6944:     <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.299     rillig   6945:     appended/removed automatically for man pages according to
                   6946:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6947:     or not, see above for details. This modification of the
                   6948:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6949:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6950: </div>
1.148     asau     6951: <div class="sect1">
1.75      rillig   6952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6953: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.299     rillig   6954: </h2></div></div></div>
                   6955: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6956:     in generating the binary package, set the variable
                   6957:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.378     leot     6958:     The files are later concatenated using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6959:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6960:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6961: </div>
1.148     asau     6962: <div class="sect1">
1.75      rillig   6963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6964: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.299     rillig   6965: <p>Some packages decide to install a different set of files based on
                   6966:     the operating system being used. These differences can be
                   6967:     automatically handled by using the following files:</p>
                   6968: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6969: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6970: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6971: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6972: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6973: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6974: </ul></div>
1.75      rillig   6975: </div>
1.148     asau     6976: <div class="sect1">
1.75      rillig   6977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6978: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
1.299     rillig   6979: <p>Some packages decide to generate hard-to-guess file names
                   6980:     during installation that are hard to wire down.</p>
                   6981: <p>In such cases, you can set the
                   6982:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6983:     terminated (with a semicolon) that will output PLIST entries which
                   6984:     will be appended to the PLIST</p>
                   6985: <p>You can find one example in editors/xemacs:</p>
                   6986: <pre class="programlisting">
                   6987: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6988: </pre>
                   6989: <p>which will append something like
                   6990:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6991:     <code class="filename">PLIST</code>.
                   6992:     </p>
1.75      rillig   6993: </div>
1.148     asau     6994: <div class="sect1">
1.75      rillig   6995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6996: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6997: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.299     rillig   6998:     multiple (and unrelated) packages install files.  These
                   6999:     directories were problematic because you had to add special
                   7000:     tricks in the PLIST to conditionally remove them, or have some
                   7001:     centralized package handle them.</p>
                   7002: <p>In pkgsrc, it is now easy: Each package should create
                   7003:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   7004:     will remove any directories left empty after uninstalling a
                   7005:     package.</p>
                   7006: <p>If a package needs an empty directory to work, create
                   7007:     the directory during installation as usual, and also add an
                   7008:     entry to the PLIST:
                   7009: 
                   7010: </p>
                   7011: <pre class="programlisting">
                   7012: @pkgdir path/to/empty/directory
                   7013: </pre>
                   7014: <p>
                   7015: 
                   7016:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   7017:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      7018:     </p>
1.75      rillig   7019: </div>
1.299     rillig   7020: </div>
                   7021: <div class="chapter">
                   7022: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     7023: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
1.299     rillig   7024: <div class="toc">
                   7025: <p><b>Table of Contents</b></p>
                   7026: <dl class="toc">
                   7027: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   7028: <dd><dl>
                   7029: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   7030: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   7031: </dl></dd>
                   7032: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   7033: <dd><dl>
                   7034: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   7035: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353     dholland 7036: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   7037: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   7038: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   7039: </dl></dd>
                   7040: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   7041: <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>
                   7042: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   7043: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   7044: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   7045: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   7046: <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>
                   7047: </dl>
                   7048: </div>
                   7049: <p>This chapter describes the framework known as
                   7050: <code class="literal">pkginstall</code>, whose key features are:</p>
                   7051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7052: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   7053:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   7054: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   7055:     provided that packages are correctly designed.</p></li>
                   7056: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   7057: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   7058: <li class="listitem"><p>Registration of system shells.</p></li>
                   7059: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   7060: </ul></div>
                   7061: <p>The following sections inspect each of the above points in detail.</p>
                   7062: <p>You may be thinking that many of the things described here could be
                   7063: easily done with simple code in the package's post-installation target
                   7064: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   7065: as the code in them is only executed when building from source.  Machines
                   7066: using binary packages could not benefit from it at all (as the code itself
                   7067: could be unavailable).  Therefore, the only way to achieve any of the items
                   7068: described above is by means of the installation scripts, which are
                   7069: automatically generated by pkginstall.</p>
1.148     asau     7070: <div class="sect1">
1.75      rillig   7071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7072: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
1.299     rillig   7073: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   7074: of files and directories that belong to a package.  The names used in it
                   7075: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   7076: which means that it cannot register files outside this directory (absolute
                   7077: path names are not allowed).  Despite this restriction, some packages need
                   7078: to install files outside this location; e.g., under
                   7079: <code class="filename">${VARBASE}</code> or
                   7080: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   7081: is to create such files during installation time by using
                   7082: installation scripts.</p>
                   7083: <p>The generic installation scripts are shell scripts that can
                   7084: contain arbitrary code.  The list of scripts to execute is taken from
                   7085: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   7086: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   7087: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   7088: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   7089: commands, so they have the potential to create and manage files
                   7090: anywhere in the file system.</p>
                   7091: <p>Using these general installation files is not recommended, but
                   7092: may be needed in some special cases.  One reason for avoiding them is
                   7093: that the user has to trust the packager that there is no unwanted or
                   7094: simply erroneous code included in the installation script. Also,
                   7095: previously there were many similar scripts for the same functionality,
                   7096: and fixing a common error involved finding and changing all of
                   7097: them.</p>
                   7098: <p>The pkginstall framework offers another, standardized way.  It
                   7099: provides generic scripts to abstract the manipulation of such files
                   7100: and directories based on variables set in the package's
                   7101: <code class="filename">Makefile</code>.  The rest of this section describes
                   7102: these variables.</p>
                   7103: <div class="sect2">
                   7104: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7105: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
1.299     rillig   7106: <p>The following variables can be set to request the creation of
                   7107: directories anywhere in the file system:</p>
                   7108: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7109: <li class="listitem">
                   7110: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   7111:     contain a list of directories that should be created and should attempt
                   7112:     to be destroyed by the installation scripts.  The difference between
                   7113:     the two is that the latter prompts the administrator to remove any
                   7114:     directories that may be left after deinstallation (because they were
                   7115:     not empty), while the former does not.  Example:</p>
                   7116: <pre class="programlisting">
                   7117: MAKE_DIRS+=             ${VARBASE}/foo/private
                   7118: </pre>
                   7119: </li>
                   7120: <li class="listitem">
                   7121: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   7122:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   7123:     which directories should be created and should attempt to be destroyed
                   7124:     by the installation scripts.  Each tuple holds the following values,
                   7125:     separated by spaces: the directory name, its owner, its group and its
                   7126:     numerical mode.  For example:</p>
                   7127: <pre class="programlisting">
                   7128: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   7129:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   7130: </pre>
                   7131: <p>The difference between the two is exactly the same as their
                   7132:     non-<code class="varname">PERMS</code> counterparts.</p>
                   7133: </li>
                   7134: </ul></div>
1.75      rillig   7135: </div>
1.299     rillig   7136: <div class="sect2">
                   7137: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7138: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
1.299     rillig   7139: <p>Creating non-empty files outside the installation prefix is tricky
                   7140: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.353     dholland 7141: To overcome this problem, the only solution is to extract the file in a
1.299     rillig   7142: known place (i.e., inside the installation prefix) and copy it to the
                   7143: appropriate location during installation (done by the installation scripts
1.353     dholland 7144: generated by pkginstall).  We will call the former the <span class="emphasis"><em>reference
1.299     rillig   7145: file</em></span> in the following paragraphs, which describe the variables
                   7146: that can be used to automatically and consistently handle files outside the
                   7147: installation prefix:</p>
                   7148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.353     dholland 7149: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
                   7150:     and target files.  At installation time, the reference file is copied
                   7151:     to the target if and only if the latter does not exist.  Upon
                   7152:     deinstallation, the reference file is removed provided that it was
                   7153:     not modified by the installation.</p></li>
1.299     rillig   7154: <li class="listitem">
1.353     dholland 7155: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
                   7156:     reference files and targets, including owner, group, and numeric
                   7157:     permissions that should be set. For example:</p>
1.88      wiz      7158: <pre class="programlisting">
1.299     rillig   7159: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   7160:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   7161: </pre>
1.299     rillig   7162: </li>
1.353     dholland 7163: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
                   7164:     <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
                   7165:     <code class="varname">REQD_FILES</code> and
                   7166:     <code class="varname">REQD_FILES_PERMS</code> respectively.  The difference
                   7167:     is that these variables are specifically intended for handling
                   7168:     configuration files, for which additional conventions and
1.385     leot     7169:     constraints apply.  See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
1.353     dholland 7170:     discussion.  Note in particular that while handling of
1.385     leot     7171:     configuration files can be disabled by the user (see <a class="xref" href="#conf-files-disable" title="20.2.5. Disabling handling of configuration files">Section 20.2.5, “Disabling handling of configuration files”</a>), this setting does not affect
1.353     dholland 7172:     <code class="varname">REQD_FILES</code> and
                   7173:     <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.299     rillig   7174: </ul></div>
1.353     dholland 7175: <p>To install an empty file, one can use these macros and
                   7176:   <code class="filename">/dev/null</code> as the reference file.</p>
1.299     rillig   7177: </div>
1.75      rillig   7178: </div>
1.148     asau     7179: <div class="sect1">
1.75      rillig   7180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7181: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.353     dholland 7182: <p>There are two principles that govern the handling of
                   7183: configuration files in pkgsrc: first, the user's configuration must
                   7184: not be lost or overwritten by upgrades or reinstallations; and second,
                   7185: the default configuration should always be available for reference.
                   7186: To that end, pkgsrc has a framework specifically for handling
                   7187: configuration files.  In general, configuration files are installed
                   7188: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
                   7189: there to the pertinent <code class="filename">etc</code> directory as a
                   7190: separate step and only as needed.</p>
                   7191: <p>To make this work, there are three things that need to happen,
                   7192: any of which may require patching.  First, the package must be told to
                   7193: read its configuration from the correct place at runtime; this place
                   7194: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
                   7195: of it) which is often but not always
                   7196: <code class="filename">${PREFIX}/etc</code>.  Second, the package must be
                   7197: taught to install its default configuration files in
                   7198: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
                   7199: point at which patching often becomes required because it is not the
                   7200: same place as the runtime location.  Third, the configuration files
                   7201: need to be declared in the package makefile; this is the easy part.
                   7202: </p>
                   7203: <p>With those elements in place, the right things will happen: the
                   7204: package install phase and resulting binary package will not touch
                   7205: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
                   7206: will be copied into place by the pkgsrc framework only if not already
                   7207: present.  Similarly, upon deinstall the configuration will not be
                   7208: removed if it has been modified.  (This means that in the case of
                   7209: reinstallation and upgrades, unmodified configuration files are
                   7210: updated but modifications are never discarded.)</p>
                   7211: <p>The following sections describe how to make these things happen
                   7212: and document other relevant knobs available in the pkgsrc
                   7213: infrastructure.</p>
1.299     rillig   7214: <div class="sect2">
                   7215: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7216: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.299     rillig   7217: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7218: specifies where configuration files shall be installed.  Its contents are
                   7219: set based upon the following variables:</p>
                   7220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7221: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7222:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.353     dholland 7223:     be overridden by the user to point to their preferred location (e.g.,
1.299     rillig   7224:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7225:     Packages must not use it directly.</p></li>
                   7226: <li class="listitem">
                   7227: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7228:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7229:     for the package being built shall be installed.  The definition of this
                   7230:     variable only makes sense in the package's
                   7231:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7232: <p>As an example, consider the Apache package,
1.322     leot     7233:     <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   7234:     configuration files under the
                   7235:     <code class="filename">httpd/</code> subdirectory of
                   7236:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7237:     Makefile.</p>
                   7238: </li>
                   7239: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7240:     variable that holds this package's configuration directory (if
                   7241:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7242:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7243:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7244: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7245:     directory where the configuration files for the package identified by
                   7246:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7247: </ul></div>
                   7248: <p>Based on the above variables, pkginstall determines the value of
                   7249: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.353     dholland 7250: variable that may be used within a package to refer to its configuration
1.299     rillig   7251: directory.  The algorithm used to set its value is basically the
                   7252: following:</p>
                   7253: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7254: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7255:     its value is used.</p></li>
                   7256: <li class="listitem"><p>If the previous variable is not defined but
                   7257:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7258:     <code class="filename">Makefile</code>, the resulting value is
                   7259:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7260: <li class="listitem"><p>Otherwise, it is set to
                   7261:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7262: </ol></div>
                   7263: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.353     dholland 7264: automatically added to <code class="filename">OWN_DIRS</code>.  This causes it
1.385     leot     7265: to be automatically created if needed.  See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> for further details.  This does not apply to
1.353     dholland 7266: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
                   7267: created with <code class="varname">OWN_DIRS</code> or
                   7268: <code class="varname">MAKE_DIRS</code>.</p>
1.299     rillig   7269: </div>
                   7270: <div class="sect2">
                   7271: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7272: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
1.299     rillig   7273: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.353     dholland 7274: known place, you need to teach each package where to install its files.  In
                   7275: some cases you will have to patch the package Makefiles to achieve it.  If
                   7276: you are lucky, though, it may be as easy as passing an extra flag to the
                   7277: configuration script.  This is the case for packages using GNU
                   7278: autoconf:</p>
1.75      rillig   7279: <pre class="programlisting">
1.299     rillig   7280: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7281: </pre>
1.299     rillig   7282: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.353     dholland 7283: for</em></span> its configuration files, not where they will be installed.
                   7284: Fortunately, there is a different way to specify the latter, as seen
1.354     gutterid 7285: in the next section, although the combination is rather confusing at
1.353     dholland 7286: first glance.</p>
1.75      rillig   7287: </div>
1.299     rillig   7288: <div class="sect2">
                   7289: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7290: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
1.353     dholland 7291: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.299     rillig   7292: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7293: directly</strong></span>.  Bad news is that many software installation scripts
                   7294: will, out of the box, mess with the contents of that directory.  So what is
                   7295: the correct procedure to fix this issue?</p>
                   7296: <p>You must teach the package (usually by manually patching it) to
                   7297: install any configuration files under the examples hierarchy,
                   7298: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7299: <code class="filename">PLIST</code> registers them and the administrator always
                   7300: has the original copies available.</p>
1.353     dholland 7301: <p>It turns out that for packages using GNU autoconf it is possible
                   7302: to create the desired effect by setting <code class="varname">sysconfdir</code>
                   7303: on the make command line at install time.  Consider this example taken
                   7304: from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a>:</p>
                   7305: <pre class="programlisting">
                   7306: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7307: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
                   7308: </pre>
                   7309: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
                   7310: used for this purpose, is local to that package and has no meaning
                   7311: outside it.</p>
                   7312: </div>
                   7313: <div class="sect2">
                   7314: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7315: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.299     rillig   7316: <p>Once the required configuration files are in place (i.e., under the
1.353     dholland 7317: examples hierarchy), the pkginstall framework can use them as reference copies
1.299     rillig   7318: during the package installation to update what is in
                   7319: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7320: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.385     leot     7321: used.  Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for further
1.353     dholland 7322: information about their syntax and their purpose.  Here is an example,
                   7323: taken from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
                   7324: <pre class="programlisting">
                   7325: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7326: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7327: </pre>
                   7328: <p>Note that (as in the previous section's example) the
                   7329: <code class="varname">EGDIR</code> variable is specific to the package and has
                   7330: no meaning outside it.</p>
                   7331: <p>For reference, the complete example from Mutt is as follows:</p>
1.88      wiz      7332: <pre class="programlisting">
1.353     dholland 7333: CONFIGURE_ARGS+=        --sysconfdir=${PKG_SYSCONFDIR}
                   7334: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7335: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7336: INSTALLATION_DIRS+=     ${EGDIR}
                   7337: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.100     rillig   7338: </pre>
1.75      rillig   7339: </div>
1.299     rillig   7340: <div class="sect2">
                   7341: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7342: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.299     rillig   7343: <p>The automatic copying of config files can be toggled by setting the
                   7344: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7345: installation.</p>
1.88      wiz      7346: </div>
1.75      rillig   7347: </div>
1.148     asau     7348: <div class="sect1">
1.75      rillig   7349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7350: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
1.299     rillig   7351: <p>System startup scripts are special files because they must be
                   7352: installed in a place known by the underlying OS, usually outside the
1.385     leot     7353: 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, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.299     rillig   7354: can be used.  However, pkginstall provides a special mechanism to handle
                   7355: these files.</p>
                   7356: <p>In order to provide system startup scripts, the package has
                   7357: to:</p>
                   7358: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7359: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7360:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.338     nia      7361:     <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
                   7362:     has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299     rillig   7363: <li class="listitem">
                   7364: <p>Tell pkginstall to handle it, appending the name of the script,
                   7365:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7366:     Continuing the previous example:</p>
                   7367: <pre class="programlisting">
                   7368: RCD_SCRIPTS+=   cupsd
                   7369: </pre>
                   7370: </li>
                   7371: </ol></div>
                   7372: <p>Once this is done, pkginstall will do the following steps for each
                   7373: script in an automated fashion:</p>
                   7374: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7375: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7376:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7377:     variable.</p></li>
                   7378: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7379:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.353     dholland 7380:     that this reference file must be explicitly registered in the
1.299     rillig   7381:     <code class="filename">PLIST</code>.</p></li>
                   7382: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7383:     from the examples hierarchy into the system-wide startup scripts
                   7384:     directory.</p></li>
                   7385: </ol></div>
                   7386: <div class="sect2">
                   7387: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7388: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.299     rillig   7389: <p>The automatic copying of config files can be toggled by setting the
                   7390: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7391: installation.  Note that the scripts will be always copied inside the
                   7392: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7393: matter what the value of this variable is.</p>
1.75      rillig   7394: </div>
                   7395: </div>
1.299     rillig   7396: <div class="sect1">
                   7397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7398: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
1.299     rillig   7399: <p>If a package needs to create special users and/or groups during
                   7400: installation, it can do so by using the pkginstall framework.</p>
                   7401: <p>Users can be created by adding entries to the
                   7402: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7403: syntax:</p>
                   7404: <pre class="programlisting">
                   7405: user:group
                   7406: </pre>
                   7407: <p>Further specification of user details may be done by setting
                   7408: per-user variables.
                   7409: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7410: numeric UID for the user.
                   7411: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7412: user's description or comment.
                   7413: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7414: user's home directory, and defaults to
                   7415: <code class="filename">/nonexistent</code> if not specified.
                   7416: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7417: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7418: not specified.</p>
                   7419: <p>Similarly, groups can be created by adding entries to the
                   7420: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7421: <pre class="programlisting">
                   7422: group
                   7423: </pre>
                   7424: <p>The numeric GID of the group may be set by defining
                   7425: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7426: <p>If a package needs to create the users and groups at an earlier
                   7427: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7428: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7429: <code class="literal">pre-install</code> to indicate the phase before which the
                   7430: users and groups are created. In this case, the numeric UIDs and GIDs
                   7431: of the created users and groups are automatically hardcoded into the
                   7432: final installation scripts.</p>
1.75      rillig   7433: </div>
1.148     asau     7434: <div class="sect1">
1.75      rillig   7435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7436: <a name="shells"></a>20.5. System shells</h2></div></div></div>
1.299     rillig   7437: <p>Packages that install system shells should register them in the shell
                   7438: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7439: administrator.  This must be done from the installation scripts to keep
                   7440: binary packages working on any system.  pkginstall provides an easy way to
                   7441: accomplish this task.</p>
                   7442: <p>When a package provides a shell interpreter, it has to set the
                   7443: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7444: add some hooks to the installation scripts to handle it.  Consider the
1.322     leot     7445: 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   7446: <pre class="programlisting">
                   7447: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7448: </pre>
                   7449: <div class="sect2">
                   7450: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7451: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
1.299     rillig   7452: <p>The automatic registration of shell interpreters can be disabled by
                   7453: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7454: environment variable to <code class="literal">NO</code>.</p>
                   7455: </div>
1.75      rillig   7456: </div>
1.148     asau     7457: <div class="sect1">
1.75      rillig   7458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7459: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
1.299     rillig   7460: <p>Packages that install X11 fonts should update the database files
                   7461: that index the fonts within each fonts directory.  This can easily be
                   7462: accomplished within the pkginstall framework.</p>
                   7463: <p>When a package installs X11 fonts, it must list the directories in
                   7464: which fonts are installed in the
                   7465: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.385     leot     7466: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
                   7467: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.  This will add hooks to the
1.299     rillig   7468: installation scripts to run the appropriate commands to update the fonts
                   7469: database files within each of those directories.  For convenience, if the
                   7470: directory path is relative, it is taken to be relative to the package's
1.322     leot     7471: 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   7472: <pre class="programlisting">
1.299     rillig   7473: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7474: </pre>
1.299     rillig   7475: <div class="sect2">
                   7476: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7477: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.299     rillig   7478: <p>The automatic update of fonts databases can be disabled by
                   7479: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7480: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7481: </div>
                   7482: </div>
                   7483: </div>
1.148     asau     7484: <div class="chapter">
1.75      rillig   7485: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     7486: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7487: <div class="toc">
                   7488: <p><b>Table of Contents</b></p>
1.210     leot     7489: <dl class="toc">
1.267     rillig   7490: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7491: <dd><dl>
1.267     rillig   7492: <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>
                   7493: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7494: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7495: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7496: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7497: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7498: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7499: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7500: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7501: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7502: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7503: </dl></dd>
                   7504: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7505: <dd><dl>
                   7506: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7507: <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>
                   7508: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7509: </dl></dd>
                   7510: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7511: <dd><dl>
                   7512: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7513: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7514: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      7515: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      7516: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   7517: </dl></dd>
                   7518: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7519: <dd><dl>
                   7520: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7521: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      7522: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      7523: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   7524: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   7525: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   7526: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   7527: </dl></dd>
                   7528: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7529: <dd><dl>
                   7530: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7531: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7532: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot     7533: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.287     rillig   7534: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7535: </dl></dd>
                   7536: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7537: <dd><dl>
                   7538: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7539: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7540: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7541: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7542: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      7543: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      7544: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   7545: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   7546: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   7547: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   7548: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   7549: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   7550: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   7551: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   7552: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   7553: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      7554:     emulation</a></span></dt>
1.369     wiz      7555: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   7556: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.75      rillig   7557: </dl></dd>
1.267     rillig   7558: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7559: </dl>
                   7560: </div>
1.148     asau     7561: <div class="sect1">
1.75      rillig   7562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7563: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7564: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7565:   different platforms. As a result, it is important to ensure,
                   7566:   where possible, that packages in pkgsrc are portable. This
                   7567:   chapter mentions some particular details you should pay
                   7568:   attention to while working on pkgsrc.</p>
1.148     asau     7569: <div class="sect2">
1.78      rillig   7570: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7571: <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   7572: </h3></div></div></div>
1.78      rillig   7573: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7574:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7575:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7576:     want to use those variables in the preprocessor directives of
1.378     leot     7577:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7578:     <code class="literal">.for</code>), you need to include the file
                   7579:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7580:     loads the user preferences.</p>
1.78      rillig   7581: <p>But note that some variables may not be completely defined
1.219     rillig   7582:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7583:     included, as they may contain references to variables that are
                   7584:     not yet defined. In shell commands (the lines in
                   7585:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7586:     is no problem, since variables are only expanded when they are
                   7587:     used. But in the preprocessor directives mentioned above and in
                   7588:     dependency lines (of the form <code class="literal">target:
                   7589:     dependencies</code>) the variables are expanded at load
                   7590:     time.</p>
1.148     asau     7591: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7592: <h3 class="title">Note</h3>
1.218     rillig   7593: <p>To check whether a variable can be used at load time,
                   7594:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7595: </div>
                   7596: </div>
1.148     asau     7597: <div class="sect2">
1.78      rillig   7598: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7599: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7600: <p>Occasionally, packages require interaction from the user,
                   7601:     and this can be in a number of ways:</p>
1.148     asau     7602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7603: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7604:        interaction such as entering username/password or accepting a
                   7605:        license on a web page.</p></li>
1.128     wiz      7606: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7607:        passwords.</p></li>
1.128     wiz      7608: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7609: <li class="listitem"><p>help during the build process</p></li>
                   7610: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7611: </ul></div>
1.218     rillig   7612: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7613:     variable to define which stages need interaction. This should be
                   7614:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7615: <pre class="programlisting">
1.100     rillig   7616: INTERACTIVE_STAGE=      configure install
1.222     sevan    7617: </pre>
1.88      wiz      7618: <p>The user can then decide to skip this package by setting the
1.218     rillig   7619:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7620:     are also excluded from bulk builds.</p>
1.75      rillig   7621: </div>
1.148     asau     7622: <div class="sect2">
1.75      rillig   7623: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7624: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7625: <p>Authors of software can choose the licence under which software
                   7626:     can be copied.  The Free Software Foundation has declared some
                   7627:     licenses "Free", and the Open Source Initiative has a definition of
                   7628:     "Open Source".</p>
                   7629: <p>By default, pkgsrc allows packages with Free or Open Source
                   7630:     licenses to be built.  To allow packages with other licenses to be
                   7631:     built as well, the pkgsrc user needs to add these licenses to the
                   7632:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7633:     that this variable only affects which packages may be
                   7634:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7635:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7636: <p>One might want to only install packages with a BSD license,
1.218     rillig   7637:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7638:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7639:     user can override the default by setting the
                   7640:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7641:     of "+=".  The licenses accepted by default are defined in the
                   7642:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7643:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7644: <p>The license tag mechanism is intended to address
1.87      wiz      7645:     copyright-related issues surrounding building, installing and
                   7646:     using a package, and not to address redistribution issues (see
                   7647:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7648:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7649:     Packages with redistribution restrictions should set these
                   7650:     tags.</p>
1.98      wiz      7651: <p>Denoting that a package may be copied according to a
                   7652:     particular license is done by placing the license in
1.87      wiz      7653:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7654:     <code class="varname">LICENSE</code> variable to a string identifying the
1.322     leot     7655:     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      7656: <pre class="programlisting">
1.100     rillig   7657: LICENSE=        xv-license
1.222     sevan    7658: </pre>
1.87      wiz      7659: <p>When trying to build, the user will get a notice that the
1.98      wiz      7660:     package is covered by a license which has not been placed in the
                   7661:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7662: <pre class="programlisting">
1.100     rillig   7663: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7664: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7665: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7666: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7667: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7668: *** Error code 1
1.222     sevan    7669: </pre>
1.379     wiz      7670: <p>In case a package requires multiple licenses, you can add all of
                   7671:     them to the LICENSE variable, connected with the upper-case keyword
                   7672:     <code class="varname">AND</code>. If the user has a choice between multiple
                   7673:     licenses, you can add them connected with the upper-case keyword
                   7674:     <code class="varname">OR</code>, for example:</p>
                   7675: <pre class="programlisting">
                   7676: LICENSE=        isc AND apache-2.0
                   7677: LICENSE=        2-clause-bsd OR ruby-license
                   7678: </pre>
1.110     hubertf  7679: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7680:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7681:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7682:     convey to pkgsrc that it should not in the future fail because of
                   7683:     that license:</p>
1.78      rillig   7684: <pre class="programlisting">
1.100     rillig   7685: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7686: </pre>
                   7687: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7688:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7689:     is deprecated because it does not crisply refer to a particular
                   7690:     license text.  Another problem with such usage is that it does not
                   7691:     enable a user to tell pkgsrc to proceed for a single package
                   7692:     without also telling pkgsrc to proceed for all packages with that
                   7693:     tag.</p>
                   7694: <div class="sect3">
                   7695: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     7696: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7697: <p>When adding a package with a new license, the following steps
                   7698:     are required:</p>
                   7699: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7700: <li class="listitem">
1.284     rillig   7701: <p>Check whether the license qualifies as Free or Open Source by
                   7702:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7703:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7704:     Open Source Initiative</a>.  If this is the case, the filename in
                   7705:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7706:     <code class="filename">-license</code> suffix, and the license name should be
                   7707:     added to:</p>
1.154     rodent   7708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7709: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7710:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7711: <li class="listitem"><p>default_acceptable_licenses in
                   7712:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7713: </ul></div>
                   7714: </li>
1.284     rillig   7715: <li class="listitem"><p>The license text should be added to
                   7716:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7717:     licenses can be seen in this directory.</p></li>
1.154     rodent   7718: </ol></div>
1.222     sevan    7719: </div>
                   7720: <div class="sect3">
                   7721: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     7722: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7723: <p>When the license changes (in a way other than formatting),
1.222     sevan    7724:     make sure that the new license has a different name (e.g.,
1.98      wiz      7725:     append the version number if it exists, or the date).  Just
                   7726:     because a user told pkgsrc to build programs under a previous
                   7727:     version of a license does not mean that pkgsrc should build
1.99      rillig   7728:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7729:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7730:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7731:     approved by either of two bodies (FSF or OSI).</p>
                   7732: </div>
1.75      rillig   7733: </div>
1.148     asau     7734: <div class="sect2">
1.75      rillig   7735: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7736: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7737: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7738:     By declaring the restrictions, package tools can
1.98      wiz      7739:     automatically refrain from e.g. placing binary packages on FTP
                   7740:     sites.</p>
1.222     sevan    7741: <p>There are four possible restrictions, which are
1.98      wiz      7742:     the cross product of sources (distfiles) and binaries not being
                   7743:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7744:     language in any license, and because non-Free licenses tend to be
                   7745:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7746:     CD-ROM.
                   7747: 
                   7748:     "FTP" means making the source or binary file available over the
                   7749:     Internet at no charge.
                   7750: 
                   7751:     "CD-ROM" means making the source or binary available on some kind of
                   7752:     media, together with other source and binary packages, which is sold
                   7753:     for a distribution charge.
1.98      wiz      7754:     </p>
                   7755: <p>In order to encode these restrictions, the package system
1.87      wiz      7756:     defines five make variables that can be set to note these
                   7757:     restrictions:</p>
1.148     asau     7758: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7759: <li class="listitem">
1.75      rillig   7760: <p><code class="varname">RESTRICTED</code></p>
                   7761: <p>This variable should be set whenever a restriction
1.87      wiz      7762:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7763:        string containing the reason for the restriction.  It should
                   7764:        be understood that those wanting to understand the restriction
                   7765:        will have to read the license, and perhaps seek advice of
                   7766:        counsel.</p>
1.75      rillig   7767: </li>
1.128     wiz      7768: <li class="listitem">
1.75      rillig   7769: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7770: <p>Binaries may not be placed on CD-ROM containing other
                   7771:        binary packages, for which a distribution charge may be made.
                   7772:        In this case, set this variable to
                   7773:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7774: </li>
1.128     wiz      7775: <li class="listitem">
1.75      rillig   7776: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7777: <p>Binaries may not made available on the Internet without
                   7778:        charge.  In this case, set this variable to
                   7779:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7780:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7781: </li>
1.128     wiz      7782: <li class="listitem">
1.75      rillig   7783: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7784: <p>Distfiles may not be placed on CD-ROM, together with
                   7785:        other distfiles, for which a fee may be charged.  In this
                   7786:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7787:        </p>
1.75      rillig   7788: </li>
1.128     wiz      7789: <li class="listitem">
1.75      rillig   7790: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7791: <p>Distfiles may not made available via FTP at no charge.
                   7792:        In this case, set this variable to
                   7793:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7794:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7795: </li>
                   7796: </ul></div>
1.222     sevan    7797: <p>Please note that packages will be removed from pkgsrc when the
                   7798:     distfiles are not distributable and cannot be obtained for a period
                   7799:     of one full quarter branch. Packages with manual/interactive fetch
                   7800:     must have a maintainer and it is his/her responsibility to ensure
                   7801:     this.</p>
1.75      rillig   7802: </div>
1.148     asau     7803: <div class="sect2">
1.75      rillig   7804: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7805: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7806: <p>Your package may depend on some other package being present,
                   7807:     and there are various ways of expressing this dependency.
                   7808:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7809:     <code class="varname">BUILD_DEPENDS</code>,
                   7810:     <code class="varname">TOOL_DEPENDS</code>, and
                   7811:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7812:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7813:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7814:     to handle dependencies, and which uses the variables named above.
1.385     leot     7815:     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 7816: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7817:     definition registers that pre-requisite in the binary package so it
                   7818:     will be pulled in when the binary package is later installed, whilst
                   7819:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7820:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7821:     dependency that is only needed for building or testing the resulting
1.385     leot     7822:     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   7823: <p>This means that if you only need a package present whilst
1.290     gutterid 7824:     you are building or testing, it should be noted as a
                   7825:     <code class="varname">TOOL_DEPENDS</code>,
                   7826:     <code class="varname">BUILD_DEPENDS</code>, or
                   7827:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7828:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7829:     packages, i.e. packages for the architecture where the package
                   7830:     is built;
                   7831:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7832:     packages, i.e., packages for the architecture for which the package
1.269     leot     7833:     is built.</p>
1.290     gutterid 7834: <p>The format for a <code class="varname">DEPENDS</code>,
                   7835:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7836:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7837: <pre class="programlisting">
1.100     rillig   7838: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7839: </pre>
1.385     leot     7840: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87      wiz      7841:     may include any of the wildcard version numbers recognized by
1.378     leot     7842:     <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7843: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7844: <li class="listitem">
1.75      rillig   7845: <p>If your package needs another package's binaries or
1.160     wiz      7846:        libraries to build and run, and if that package has a
1.87      wiz      7847:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7848: <pre class="programlisting">
1.100     rillig   7849: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7850: </pre>
1.75      rillig   7851: </li>
1.128     wiz      7852: <li class="listitem">
1.160     wiz      7853: <p>If your package needs another package's binaries or
                   7854:        libraries only for building, and if that package has a
                   7855:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7856: <pre class="programlisting">
                   7857: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7858: </pre>
1.160     wiz      7859: <p>but set
                   7860:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7861:        to make it a build dependency only. This case is rather
                   7862:        rare.</p>
                   7863: </li>
                   7864: <li class="listitem">
1.132     spz      7865: <p>If your package needs binaries from another package to build,
1.269     leot     7866:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7867: <pre class="programlisting">
1.269     leot     7868: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7869: </pre>
1.75      rillig   7870: </li>
1.269     leot     7871: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7872:        files to include, etc. from another package to build,
                   7873:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7874: <li class="listitem"><p>If your package needs a library with which to link and
                   7875:        there is no <code class="filename">buildlink3.mk</code> file
                   7876:        available, create one. Using
                   7877:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7878:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7879: <li class="listitem">
1.132     spz      7880: <p>If your package needs some executable to be able to run
                   7881:        correctly and if there's no
                   7882:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7883:        using the <code class="varname">DEPENDS</code> variable. The
1.322     leot     7884:        <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      7885:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7886:        when it runs, and that is specified:</p>
1.75      rillig   7887: <pre class="programlisting">
1.242     wiz      7888: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7889: </pre>
1.132     spz      7890: </li>
1.290     gutterid 7891: <li class="listitem"><p>If your package includes a test suite that has extra
                   7892:         dependencies only required for this purpose (frequently this
1.385     leot     7893:         can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
1.290     gutterid 7894:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7895: <li class="listitem">
                   7896: <p>You can use wildcards in package dependencies. Note that
                   7897:        such wildcard dependencies are retained when creating binary
                   7898:        packages. The dependency is checked when installing the binary
                   7899:        package and any package which matches the pattern will be
                   7900:        used. Wildcard dependencies should be used with care.</p>
1.385     leot     7901: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
                   7902:        <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
                   7903:        such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
                   7904:        <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7905: <p>Wildcards can also be used to specify that a package
1.87      wiz      7906:        will only build against a certain minimum version of a
                   7907:        pre-requisite:</p>
1.75      rillig   7908: <pre class="programlisting">
1.132     spz      7909: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7910: </pre>
1.132     spz      7911: <p>This means that the package will build using version 6.0
                   7912:        of ImageMagick or newer. Such a dependency may be warranted
                   7913:        if, for example, the command line options of an executable
                   7914:        have changed.</p>
                   7915: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7916:        set
                   7917:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7918:        to the appropriate pattern before including its
                   7919:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7920: <pre class="programlisting">
                   7921: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7922: .include "../../graphics/jpeg/buildlink3.mk"
                   7923: </pre>
1.75      rillig   7924: <p>For security fixes, please update the package
1.385     leot     7925:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.87      wiz      7926:        information.</p>
1.75      rillig   7927: </li>
                   7928: </ol></div>
                   7929: <p>If your package needs files from another package to build,
1.87      wiz      7930:     add the relevant distribution files to
                   7931:     <code class="varname">DISTFILES</code>, so they will be extracted
1.322     leot     7932:     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      7933:     (It relies on the jpeg sources being present in source form
                   7934:     during the build.)</p>
1.75      rillig   7935: </div>
1.148     asau     7936: <div class="sect2">
1.75      rillig   7937: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7938: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341     gutterid 7939: <p>Your package may conflict with other packages users might
                   7940:     already have installed on their system, e.g., if your package
1.88      wiz      7941:     installs the same set of files as another package in the pkgsrc
1.342     wiz      7942:     tree.</p>
1.322     leot     7943: <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>
                   7944:     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     7945:     install the same shared library, thus you set in
                   7946:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7947: <pre class="programlisting">
                   7948: CONFLICTS=      Xaw-Xpm-[0-9]*
1.352     wiz      7949: </pre>
1.255     leot     7950: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7951: <pre class="programlisting">
                   7952: CONFLICTS=      libXaw3d-[0-9]*
1.352     wiz      7953: </pre>
1.378     leot     7954: <p><a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7955:     that conflict with existing packages and abort. However, in many
                   7956:     situations this is too late in the process. Binary package managers
                   7957:     will not know about the conflict until they attempt to install the
                   7958:     package after already downloading it and all its dependencies.
                   7959:     Users may also waste time building a package and its dependencies
                   7960:     only to find out at the end that it conflicts with another package
                   7961:     they have installed.</p>
                   7962: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7963:     should be added in all cases where it is known that packages conflict
                   7964:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.378     leot     7965:     exported in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7966:     managers to inform users that packages cannot be installed onto
                   7967:     the target system.</p>
1.75      rillig   7968: </div>
1.148     asau     7969: <div class="sect2">
1.75      rillig   7970: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7971: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7972: <p>There are several reasons why a package might be
1.88      wiz      7973:     instructed to not build under certain circumstances.  If the
1.87      wiz      7974:     package builds and runs on most platforms, the exceptions
1.193     dholland 7975:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7976:     the package builds and runs on a small handful of platforms,
                   7977:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7978:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7979:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7980:     (OS-version-platform) that can use glob-style
                   7981:     wildcards.</p>
                   7982: <p>If a package is not appropriate for some platforms (as
1.225     maya     7983:     opposed to merely broken), a different set of variables should be
1.193     dholland 7984:     used as this affects failure reporting and statistics.
                   7985:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7986:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7987:     the package is appropriate for only a small handful of platforms
                   7988:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7989:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7990:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7991:     (OS-version-platform) that can use glob-style
                   7992:     wildcards.</p>
1.88      wiz      7993: <p>Some packages are tightly bound to a specific version of an
1.322     leot     7994:     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      7995:     backwards compatible with other versions of the OS, and should be
                   7996:     uploaded to a version specific directory on the FTP server.  Mark
                   7997:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.385     leot     7998:     <span class="quote">“<span class="quote">yes</span>”</span>.  This variable is not currently used by any of
1.88      wiz      7999:     the package system internals, but may be used in the
                   8000:     future.</p>
1.75      rillig   8001: <p>If the package should be skipped (for example, because it
1.87      wiz      8002:     provides functionality already provided by the system), set
1.88      wiz      8003:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8004:     the package should fail because some preconditions are not met,
                   8005:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8006:     message.</p>
1.75      rillig   8007: </div>
1.148     asau     8008: <div class="sect2">
1.75      rillig   8009: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8010: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8011: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8012:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8013:     be set in the package Makefile. This will be carried into any
                   8014:     binary package that is made from this pkgsrc entry. A
1.385     leot     8015:     <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.378     leot     8016:     not be deleted using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.385     leot     8017:     <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75      rillig   8018: </div>
1.148     asau     8019: <div class="sect2">
1.75      rillig   8020: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8021: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8022: <p>When a vulnerability is found, this should be noted in
1.361     wiz      8023:     <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.320     wiz      8024:     Entries in that file consist of three parts:</p>
                   8025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8026: <li class="listitem"><p>package version pattern</p></li>
                   8027: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   8028: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   8029: </ul></div>
                   8030: <p>For the package version pattern please always use `&lt;' to
                   8031:     mark an upper bound (not `&lt;='!). This will avoid possible
                   8032:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   8033:     related to security fixes. Lower bounds can be added too, using
                   8034:     '&gt;' or '&gt;='. For example,
1.385     leot     8035:     <span class="quote">“<span class="quote"><code class="literal">foo&gt;=1&lt;1.2</code></span>”</span> would mark
1.320     wiz      8036:     versions 1.0 (included) to 1.2 (excluded) of
1.385     leot     8037:     <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
1.320     wiz      8038:     issue.</p>
                   8039: <p>Entries should always be added at the bottom of the file.</p>
                   8040: <p>When fixing packages, please modify the upper bound of the
                   8041:     corresponding entry. To continue the previous example, if a fix
                   8042:     was backported to version 1.1nb2, change the previous pattern to
1.385     leot     8043:     <span class="quote">“<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>”</span>.</p>
1.320     wiz      8044: <p>To locally test a package version pattern against a
                   8045:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   8046:     pmatch</strong></span> command.</p>
                   8047: <p>The URL should be as permanent as possible and provide as
                   8048:     much information about the issue as possible.  CVE entries are
                   8049:     preferred.</p>
                   8050: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138     wiz      8051:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   8052: <p>After fixing the vulnerability by a patch, its
1.138     wiz      8053:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8054:     course not necessary if the problem is fixed by using a newer
                   8055:     release of the software), and the pattern in the
                   8056:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   8057: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8058:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8059: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8060:     semi-automatically by a weekly cron job.</p>
1.320     wiz      8061: <p>In case a security issue is disputed, please contact
                   8062:     pkgsrc-security@NetBSD.org.</p>
1.75      rillig   8063: </div>
1.148     asau     8064: <div class="sect2">
1.75      rillig   8065: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8066: <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   8067: <p>When making fixes to an existing package it can be useful
1.87      wiz      8068:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8069:     avoid conflicting with future versions by the original author, a
1.385     leot     8070:     <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87      wiz      8071:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.385     leot     8072:     (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
                   8073:     <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87      wiz      8074: <pre class="programlisting">
1.100     rillig   8075: DISTNAME=       foo-17.42
                   8076: PKGREVISION=    9
1.222     sevan    8077: </pre>
1.75      rillig   8078: <p>will result in a <code class="varname">PKGNAME</code> of
1.385     leot     8079:     <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
                   8080:     value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87      wiz      8081:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8082:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8083: <p>When a new release of the package is released, the
1.87      wiz      8084:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8085:     minor release of the above package, things should be like:</p>
1.75      rillig   8086: <pre class="programlisting">
1.100     rillig   8087: DISTNAME=       foo-17.43
1.222     sevan    8088: </pre>
1.87      wiz      8089: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8090:     non-trivial change in the resulting binary package.  Without a
                   8091:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8092:     version installed has no way of knowing that their package is out
                   8093:     of date.  Thus, changes without increasing
                   8094:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8095:     trivial that no reasonable person would want to upgrade", and this
                   8096:     is the rough test for when increasing
                   8097:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8098:     changes that do not merit increasing
                   8099:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     8100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8101: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   8102:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   8103:       comments in Makefile.</p></li>
                   8104: <li class="listitem"><p>Changing build variables if the resulting binary
                   8105:       package is the same.</p></li>
                   8106: <li class="listitem"><p>Changing
                   8107:       <code class="filename">DESCR</code>.</p></li>
                   8108: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   8109:       default options don't change.</p></li>
1.100     rillig   8110: </ul></div>
1.87      wiz      8111: <p>Examples of changes that do merit an increase to
                   8112:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     8113: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   8114: <li class="listitem"><p>Security fixes</p></li>
                   8115: <li class="listitem"><p>Changes or additions to a patch
                   8116:       file</p></li>
                   8117: <li class="listitem"><p>Changes to the
                   8118:       <code class="filename">PLIST</code></p></li>
                   8119: <li class="listitem"><p>A dependency is changed or
                   8120:       renamed.</p></li>
1.100     rillig   8121: </ul></div>
1.78      rillig   8122: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8123:     changes.</p>
1.75      rillig   8124: </div>
1.148     asau     8125: <div class="sect2">
1.79      rillig   8126: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8127: <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   8128: <p>When you want to replace the same text in multiple files, or
                   8129: multiple times in the same file, it is cumbersome to maintain a patch
                   8130: file for this. This is where the SUBST framework steps in. It provides an
                   8131: easy-to-use interface for replacing text in files. It just needs the
                   8132: following information:</p>
                   8133: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8134: <li class="listitem"><p>In which phase of the package build cycle should the
                   8135: replacement happen?</p></li>
                   8136: <li class="listitem"><p>In which files should the replacement
1.287     rillig   8137: happen?</p></li>
1.295     rillig   8138: <li class="listitem"><p>Which text should be replaced with
                   8139: what?</p></li>
1.287     rillig   8140: </ul></div>
                   8141: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   8142: variables. A minimal example is:</p>
                   8143: <pre class="programlisting">
                   8144: SUBST_CLASSES+=         paths
                   8145: SUBST_STAGE.paths=      pre-configure
                   8146: SUBST_FILES.paths=      src/*.c
                   8147: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   8148: </pre>
                   8149: <p>Translated into English, it means: In the pre-configure stage (that
                   8150: is, after applying the patches from the patches/ directory and before
                   8151: running the configure script and the portability check), replace the text
                   8152: <code class="literal">/usr/local</code> with the content of the variable
                   8153: <code class="varname">PREFIX</code>.</p>
                   8154: <p>Each SUBST block starts by appending an identifier to
                   8155: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   8156: identifier can be chosen freely by the package. If there should ever be
                   8157: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   8158: early, so don't worry about name collisions.</p>
                   8159: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   8160: SUBST block are parameterized using this identifier. In the remainder of
                   8161: this section, these parameterized variables are written as
                   8162: <code class="varname">SUBST_STAGE.*</code>.</p>
                   8163: <pre class="programlisting">
                   8164: SUBST_CLASSES+=         paths
                   8165: SUBST_STAGE.paths=      pre-configure
                   8166: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   8167: SUBST_FILES.paths=      src/*.c
                   8168: SUBST_FILES.paths+=     scripts/*.sh
                   8169: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   8170: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   8171: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   8172: </pre>
                   8173: <p>To get a complete picture about the SUBST substitutions, run
                   8174: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   8175: expected, run pkglint on the package, which detects several typical
                   8176: mistakes surrounding the SUBST blocks. For any questions that might
                   8177: remain after this, have a look at
                   8178: <code class="filename">mk/subst.mk</code>.</p>
                   8179: <div class="sect3">
                   8180: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8181: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
1.295     rillig   8182: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   8183: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   8184: <code class="literal">pre-configure</code> is used most often, by far. The most
                   8185: popular stages are, in chronological order:</p>
                   8186: <div class="variablelist"><dl class="variablelist">
                   8187: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   8188: <dd>
                   8189: <p>The substitutions are applied immediately after the
                   8190: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   8191: package will leave no traces of the original files.</p>
                   8192: <p>When the substitution applies to files for which there is also a
                   8193: patch in the <code class="filename">patches/</code> directory, this means that the
                   8194: patches will be computed based on the result of the substitution. When
                   8195: these patches are sent to the upstream maintainer later, to be fixed in
                   8196: the upstream package, these patches may no longer match what the upstream
                   8197: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   8198: often a better choice.</p>
                   8199: </dd>
                   8200: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   8201: <dd>
                   8202: <p>The substitutions are applied after the patches from the
                   8203: <code class="filename">patches/</code> directory. This makes it possible to run
                   8204: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322     leot     8205: 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   8206: <p>When updating the patches, it is helpful to explicitly separate the
                   8207: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   8208: configure</strong></span>, and to only edit the patches between these commands.
                   8209: Otherwise the substitutions from the SUBST block will end up in the patch
                   8210: file. When this happens in really obvious ways, pkglint will complain
                   8211: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   8212: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   8213: can only detect these really obvious
                   8214: cases.</p>
                   8215: </dd>
                   8216: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   8217: <dd><p>This stage should only be used if the package defines a
                   8218: <code class="literal">pre-configure</code> action itself, and the substitution must
                   8219: happen after that. Typical examples are packages that use the
                   8220: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   8221: script from
                   8222: <code class="filename">configure.ac</code>.</p></dd>
                   8223: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   8224: <dd><p>This stage is used to fix up any mistakes by the
                   8225: configure stage.</p></dd>
                   8226: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   8227: <dd><p>This stage should only be used for substitutions that are
                   8228: clearly related to building the package, not for fixing the
                   8229: configuration. Substitutions for pathnames (such as replacing
                   8230: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   8231: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   8232: actual username) belong in pre-configure or post-configure
                   8233: instead.</p></dd>
                   8234: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   8235: <dd>
                   8236: <p>Just as with pre-build, this stage should only be used
                   8237: for substitutions that are clearly related to building the package, not
                   8238: for fixing the configuration. Substitutions for pathnames (such as
                   8239: replacing <code class="filename">/usr/local</code> with
                   8240: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   8241: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   8242: pre-configure or post-configure instead.</p>
                   8243: <p>A typical use is to update pkg-config files to include the rpath
                   8244: compiler options.</p>
                   8245: </dd>
                   8246: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8247: <dd><p>In general, the install phase should be as simple as
                   8248: possible. As with the pre-build and post-build stages, it should not be
                   8249: used to fix pathnames or user names, these belong in pre-configure
                   8250: instead. There are only few legitimate use cases for applying
                   8251: substitutions in this stage.</p></dd>
                   8252: </dl></div>
                   8253: </div>
                   8254: <div class="sect3">
                   8255: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8256: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   8257: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8258: filename patterns. These patterns are relative to
                   8259: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8260: A typical example is:</p>
                   8261: <pre class="programlisting">
                   8262: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8263: </pre>
                   8264: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8265: implementation checks that each filename pattern that is mentioned here
                   8266: has an effect. For example, if none of the
                   8267: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8268: and substituted, that filename pattern is redundant and should be left
1.296     rillig   8269: out. By default, the SUBST framework will complain with an error message.
                   8270: If the text to be substituted occurs in some of the files from a single
                   8271: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   8272: framework will only print an INFO message for those files.</p>
                   8273: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   8274: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   8275: <p>Another popular way of choosing the files for the substitutions is
                   8276: via a shell command, like this:</p>
                   8277: <pre class="programlisting">
1.296     rillig   8278: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8279: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8280: </pre>
                   8281: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8282: freely chosen and independent of the SUBST framework.</p>
                   8283: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8284: lists each file individually. Thereby chances are higher that there are
                   8285: filename patterns in which no substitution happens. Since the SUBST
                   8286: framework cannot know whether the filename patterns in
                   8287: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8288: Makefile (where any redundant filename pattern would be suspicious) or
                   8289: been generated by a shell command (in which redundant filename patterns
                   8290: are more likely and to be expected), it will complain about these
                   8291: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8292: command to generate the list of filename patterns often need to set
                   8293: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8294: </div>
                   8295: <div class="sect3">
                   8296: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8297: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
1.295     rillig   8298: <p>In most cases, the substitutions are given using one or more
1.378     leot     8299: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8300: <pre class="programlisting">
                   8301: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8302: </pre>
                   8303: <p>Each of the sed commands needs to be preceded by the
                   8304: <code class="literal">-e</code> option and should be specified on a line of its
                   8305: own, to avoid hiding short sed commands at the end of a line.</p>
                   8306: <p>Since the sed commands often contain shell metacharacters as the
                   8307: separator (the <code class="literal">|</code> in the above example), it is common
                   8308: to enclose them in single quotes.</p>
                   8309: <p>A common substitution is to replace placeholders of the form
                   8310: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8311: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8312: <pre class="programlisting">
                   8313: SUBST_VARS.path=        PREFIX
                   8314: </pre>
                   8315: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8316: scripts during the do-configure stage, but in some cases these need to be
                   8317: overridden. The same pattern is also used when a package defines patches
                   8318: that replace previously hard-coded paths like
                   8319: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8320: placeholder first, which then gets substituted by the actual
                   8321: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8322: cases, it works equally well to just use the SUBST framework to directly
                   8323: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8324: thereby omitting the intermediate patch file.</p>
1.295     rillig   8325: <p>If the above is not flexible enough, it is possible to not use sed
                   8326: at all for the substitution but to specify an entirely different command,
                   8327: like this:</p>
1.87      wiz      8328: <pre class="programlisting">
1.295     rillig   8329: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8330: </pre>
                   8331: <p>This is used for the few remaining packages in which the
                   8332: distributed files use Windows-style line endings that need to be
                   8333: converted to UNIX-style line endings.</p>
                   8334: </div>
                   8335: <div class="sect3">
                   8336: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8337: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
1.295     rillig   8338: <p>When a SUBST block is applied during a package build, a message is
                   8339: logged. The default message is fine for most purposes but can be
                   8340: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8341: message.</p>
                   8342: </div>
1.79      rillig   8343: </div>
1.75      rillig   8344: </div>
1.148     asau     8345: <div class="sect1">
1.75      rillig   8346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8347: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8348: <div class="sect2">
1.75      rillig   8349: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8350: <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   8351: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8352:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8353:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8354:     with the name of each file to download as an argument, expecting
                   8355:     it to output the URL of the directory from which to download
1.322     leot     8356:     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      8357:     example of this usage.</p>
1.75      rillig   8358: <p>If the download can't be automated, because the user must
1.87      wiz      8359:     submit personal information to apply for a password, or must pay
                   8360:     for the source, or whatever, you can set
                   8361:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8362:     displayed to the user before aborting the build. Example:</p>
                   8363: <pre class="programlisting">
1.100     rillig   8364: FETCH_MESSAGE=  "Please download the files"
                   8365: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8366: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8367: </pre>
1.75      rillig   8368: </div>
1.148     asau     8369: <div class="sect2">
1.75      rillig   8370: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8371: <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   8372: <p>Sometimes authors of a software package make some
1.87      wiz      8373:     modifications after the software was released, and they put up a
                   8374:     new distfile without changing the package's version number. If a
                   8375:     package is already in pkgsrc at that time, the checksum will
                   8376:     no longer match. The contents of the new distfile should be
                   8377:     compared against the old one before changing anything, to make
                   8378:     sure the distfile was really updated on purpose, and that
                   8379:     no trojan horse or so crept in.
1.97      rillig   8380:     Please mention that the distfiles were compared and what was found
1.159     rodent   8381:     in your commit message.</p>
1.220     wiz      8382: <p>Then, the correct way to work around this is to set
                   8383:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8384:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8385:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8386:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8387:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.385     leot     8388:     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, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.87      wiz      8389:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8390:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8391:     be appended, like
                   8392:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8393: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8394:     name does not contain a version and the distfile is apt to change. In
                   8395:     cases where the likelihood of this is very small,
                   8396:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8397:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8398:     distfile name changes, even if a package is being moved or
                   8399:     renamed.</p>
1.159     rodent   8400: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8401:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8402:     path in the filenames.
1.159     rodent   8403:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8404:     Furthermore, a mail to the package's authors seems appropriate
                   8405:     telling them that changing distfiles after releases without
                   8406:     changing the file names is not good practice.</p>
1.75      rillig   8407: </div>
1.199     tnn      8408: <div class="sect2">
                   8409: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8410: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8411: <p>Helper methods exist for packages hosted on github.com which
                   8412:     will often have distfile names that clash with other packages, for
                   8413:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8414:     from below:</p>
1.199     tnn      8415: <div class="sect3">
                   8416: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8417: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8418: <p>If your distfile URL looks similar to
1.303     bacon    8419:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8420:       then you are packaging a tagged release.</p>
1.199     tnn      8421: <pre class="programlisting">
1.303     bacon    8422: DISTNAME=       example-1.0
1.200     tnn      8423: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8424: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8425: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8426: EXTRACT_SUFX=   .zip
                   8427: </pre>
1.345     gutterid 8428: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
                   8429:     file fetching infrastructure to save the resulting file locally as
                   8430:     <code class="literal">example-1.0.zip</code>.</p>
1.199     tnn      8431: </div>
                   8432: <div class="sect3">
                   8433: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8434: <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>
1.303     bacon    8435: <p>If your distfile looks similar to
                   8436:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8437:       release, then set the package version to 0.0.0.N, where N is the number
                   8438:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8439:       This will (almost) ensure that the first tagged release will have a
                   8440:       version greater than this one so that package upgrades will function
                   8441:       properly.</p>
                   8442: <pre class="programlisting">
                   8443: DISTNAME=       example-0.0.0.347
                   8444: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8445: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8446: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8447: </pre>
                   8448: </div>
                   8449: <div class="sect3">
                   8450: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8451: <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>
1.303     bacon    8452: <p>If your distfile looks similar to
                   8453:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8454:       then include the last release version and the commit count since that
                   8455:       release in the package version and set GITHUB_TAG to the commit hash.
                   8456:       The latest release and commit count are shown in the output of
                   8457:       "git describe --tags":
                   8458:       </p>
                   8459: <pre class="screen">
                   8460: # git clone https://github.com/username/example
                   8461: # cd example
                   8462: # git describe --tags
                   8463: 1.2.3-5-g988881a
                   8464: </pre>
1.199     tnn      8465: <pre class="programlisting">
1.303     bacon    8466: DISTNAME=       example-1.2.3.5
                   8467: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8468: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8469: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8470: </pre>
1.199     tnn      8471: </div>
                   8472: <div class="sect3">
                   8473: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8474: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8475: <p>If your distfile URL looks similar to
1.303     bacon    8476:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8477:       then you are packaging a release.</p>
1.199     tnn      8478: <pre class="programlisting">
                   8479: DISTNAME=       offensive-1.6
1.200     tnn      8480: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8481: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8482: GITHUB_PROJECT= example
1.200     tnn      8483: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8484: EXTRACT_SUFX=   .zip
1.222     sevan    8485: </pre>
1.199     tnn      8486: </div>
                   8487: </div>
1.75      rillig   8488: </div>
1.148     asau     8489: <div class="sect1">
1.75      rillig   8490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8491: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8492: <div class="sect2">
1.75      rillig   8493: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8494: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8495: <p>pkgsrc supports many different machines, with different
1.87      wiz      8496:     object formats like a.out and ELF, and varying abilities to do
                   8497:     shared library and dynamic loading at all. To accompany this,
                   8498:     varying commands and options have to be passed to the
                   8499:     compiler, linker, etc. to get the Right Thing, which can be
                   8500:     pretty annoying especially if you don't have all the machines
                   8501:     at your hand to test things.  The
1.322     leot     8502:     <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.385     leot     8503:     can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87      wiz      8504:     both static and dynamic libraries from a set of source files,
                   8505:     thus being platform-independent.</p>
                   8506: <p>Here's how to use libtool in a package in seven simple
                   8507:     steps:</p>
1.128     wiz      8508: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8509: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8510:        Makefile.</p></li>
1.385     leot     8511: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
                   8512:        ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87      wiz      8513:        add it to the definition of <code class="varname">CC</code>, if only
                   8514:        libraries are being built in a given Makefile. This one command
                   8515:        will build both PIC and non-PIC library objects, so you need not
                   8516:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8517: <li class="listitem">
1.75      rillig   8518: <p>For the linking of the library, remove any
1.385     leot     8519:        <span class="quote">“<span class="quote">ar</span>”</span>, <span class="quote">“<span class="quote">ranlib</span>”</span>, and <span class="quote">“<span class="quote">ld
                   8520:        -Bshareable</span>”</span> commands, and instead use:</p>
1.75      rillig   8521: <pre class="programlisting">
1.100     rillig   8522: ${LIBTOOL} --mode=link \
                   8523:     ${CC} -o ${.TARGET:.a=.la} \
                   8524:         ${OBJS:.o=.lo} \
                   8525:         -rpath ${PREFIX}/lib \
                   8526:         -version-info major:minor
1.222     sevan    8527: </pre>
1.75      rillig   8528: <p>Note that the library is changed to have a
1.87      wiz      8529:        <code class="filename">.la</code> extension, and the objects are
                   8530:        changed to have a <code class="filename">.lo</code>
                   8531:        extension. Change <code class="varname">OBJS</code> as
                   8532:        necessary. This automatically creates all of the
                   8533:        <code class="filename">.a</code>,
                   8534:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8535:        necessary) in the build directory. Be sure to include
1.385     leot     8536:        <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87      wiz      8537:        minor are zero, as libtool will otherwise strip off the
                   8538:        shared library version.</p>
1.75      rillig   8539: <p>From the libtool manual:</p>
                   8540: <pre class="programlisting">
1.100     rillig   8541: So, libtool library versions are described by three integers:
1.69      rillig   8542: 
1.100     rillig   8543: CURRENT
                   8544: The most recent interface number that this library implements.
1.69      rillig   8545: 
1.100     rillig   8546: REVISION
                   8547: The implementation number of the CURRENT interface.
1.69      rillig   8548: 
1.100     rillig   8549: AGE
                   8550: The difference between the newest and oldest interfaces that
                   8551: this library implements.  In other words, the library implements
                   8552: all the interface numbers in the range from number `CURRENT -
                   8553: AGE' to `CURRENT'.
1.1       grant    8554: 
1.100     rillig   8555: If two libraries have identical CURRENT and AGE numbers, then the
                   8556: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8557: </pre>
1.385     leot     8558: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87      wiz      8559:        different results for a.out and ELF (excluding symlinks)
                   8560:        in only one case. An ELF library of the form
1.385     leot     8561:        <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87      wiz      8562:        will have a symlink of
1.385     leot     8563:        <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87      wiz      8564:        on an a.out platform. This is handled
                   8565:        automatically.</p>
1.385     leot     8566: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87      wiz      8567:        directory of the library being built.</p>
1.76      rillig   8568: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8569:        <code class="filename">.la</code> file, the other files will be
                   8570:        added automatically.</p>
1.75      rillig   8571: </li>
1.128     wiz      8572: <li class="listitem">
1.76      rillig   8573: <p>When linking shared object (<code class="filename">.so</code>)
1.378     leot     8574:        files, i.e. files that are loaded via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.385     leot     8575:        shared libraries, use <span class="quote">“<span class="quote">-module
                   8576:        -avoid-version</span>”</span> to prevent them getting version
1.87      wiz      8577:        tacked on.</p>
1.76      rillig   8578: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8579:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8580: </li>
1.128     wiz      8581: <li class="listitem">
1.75      rillig   8582: <p>When linking programs that depend on these libraries
1.87      wiz      8583:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.385     leot     8584:        the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
                   8585:        --mode=link</span>”</span>, and it will find the correct
1.87      wiz      8586:        libraries (static or shared), but please be aware that
                   8587:        libtool will not allow you to specify a relative path in
1.385     leot     8588:        -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87      wiz      8589:        expects you to change that argument to be the
                   8590:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8591: <pre class="programlisting">
1.100     rillig   8592: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8593: </pre>
1.75      rillig   8594: <p>should be changed to:</p>
                   8595: <pre class="programlisting">
1.100     rillig   8596: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8597: </pre>
1.75      rillig   8598: <p>and it will do the right thing with the libraries.</p>
                   8599: </li>
1.128     wiz      8600: <li class="listitem">
1.378     leot     8601: <p>When installing libraries, preface the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
1.385     leot     8602:        or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
                   8603:        --mode=install</span>”</span>, and change the library name to
1.87      wiz      8604:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8605: <pre class="programlisting">
1.126     jakllsch 8606: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8607: </pre>
1.76      rillig   8608: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8609:        shared library, any needed symlinks, and run
1.378     leot     8610:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8611: </li>
1.128     wiz      8612: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8613:        the <code class="filename">.la</code>
                   8614:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8615: </ol></div>
                   8616: </div>
1.148     asau     8617: <div class="sect2">
1.75      rillig   8618: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8619: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8620: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8621:     package Makefile. This will override the package's own libtool
                   8622:     in most cases.  For older libtool using packages,  libtool is
                   8623:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8624:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8625:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8626: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8627:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.385     leot     8628:     default, it is set to <span class="quote">“<span class="quote">libtool */libtool
                   8629:     */*/libtool</span>”</span>.  If this does not match the location of the
1.87      wiz      8630:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8631: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8632:     libraries built and installed, then use
                   8633:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8634: <p>If your package makes use of the platform-independent library
1.87      wiz      8635:     for loading dynamic shared objects, that comes with libtool
                   8636:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8637: <p>Some packages use libtool incorrectly so that the package
                   8638:     may not work or build in some circumstances. Some of the more
                   8639:     common errors are:</p>
1.148     asau     8640: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8641: <li class="listitem">
1.75      rillig   8642: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8643:        executable or library. This in itself isn't a problem if one of two things
                   8644:        has been done:</p>
1.128     wiz      8645: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8646: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8647:            <code class="filename">libfoo.la</code>, not
                   8648:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8649: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8650: </ol></div>
                   8651: </li>
1.128     wiz      8652: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8653:        The function lt_dlinit() should be called and the macro
                   8654:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8655:        executables.</p></li>
1.75      rillig   8656: </ul></div>
                   8657: </div>
1.148     asau     8658: <div class="sect2">
1.75      rillig   8659: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8660: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8661: <p>If a package needs GNU autoconf or automake to be executed
1.338     nia      8662:     to regenerate the
                   8663:     <code class="filename">configure</code>
                   8664:     script and <code class="filename">Makefile.in</code> makefile
                   8665:     templates from <code class="filename">configure.ac</code> and
                   8666:     <code class="filename">Makefile.am</code>,
                   8667:     then they should be executed in a pre-configure target:</p>
1.75      rillig   8668: <pre class="programlisting">
1.338     nia      8669: USE_TOOLS+=    autoconf automake autoreconf
                   8670: GNU_CONFIGURE= yes
1.100     rillig   8671: ...
1.1       grant    8672: 
1.100     rillig   8673: pre-configure:
1.338     nia      8674:         set -e; cd ${WRKSRC} &amp;&amp; autoreconf -fi
1.100     rillig   8675: ...
1.222     sevan    8676: </pre>
1.338     nia      8677: <p>Packages which use GNU Automake will sometimes
                   8678:     require GNU Make (<code class="literal">gmake</code> in
                   8679:     <code class="varname">USE_TOOLS</code>),
                   8680:     but not always.  Note that autoreconf
                   8681:     only needs to be executed if <code class="filename">configure.ac</code>
                   8682:     or Makefiles are modified, or <code class="filename">configure</code>
                   8683:     is not present.</p>
1.75      rillig   8684: <p>There are times when the configure process makes
1.87      wiz      8685:     additional changes to the generated files, which then causes
                   8686:     the build process to try to re-execute the automake sequence.
                   8687:     This is prevented by touching various files in the configure
                   8688:     stage. If this causes problems with your package you can set
                   8689:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8690:     Makefile.</p>
1.75      rillig   8691: </div>
1.338     nia      8692: <div class="sect2">
                   8693: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8694: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
1.338     nia      8695: <p>Packages using Meson to configure need to include:
                   8696: 
                   8697: </p>
                   8698: <pre class="programlisting">
                   8699: .include "../../devel/meson/build.mk"
                   8700: </pre>
                   8701: <p>In nearly all cases (any program with dependencies),
                   8702:     pkg-config needs to be added to
                   8703:     <code class="varname">USE_TOOLS</code>.  If the package installs
                   8704:     translation files for non-English languages, also
                   8705:     add msgfmt and xgettext:
                   8706: 
                   8707: </p>
                   8708: <pre class="programlisting">
                   8709: USE_TOOLS+=    pkg-config msgfmt xgettext
                   8710: </pre>
                   8711: <p>If any options need to be passed to Meson, use
                   8712:     <code class="varname">MESON_ARGS</code> instead of
                   8713:     <code class="varname">CONFIGURE_ARGS</code>:
                   8714: 
                   8715: </p>
                   8716: <pre class="programlisting">
                   8717: MESON_ARGS+=   -Dx11=false
                   8718: </pre>
                   8719: </div>
1.379     wiz      8720: <div class="sect2">
                   8721: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8722: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
1.379     wiz      8723: <p>To determine the endianness of the target platform,
                   8724:     have a look at <code class="filename">mk/endian.mk</code>.</p>
                   8725: </div>
1.75      rillig   8726: </div>
1.148     asau     8727: <div class="sect1">
1.75      rillig   8728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8729: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8730: <div class="sect2">
1.87      wiz      8731: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8732: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.358     gutterid 8733: <p>Compilers for the C and C++ languages come with
1.87      wiz      8734:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8735:     is written in C and will hide all other compilers (via the wrapper
1.385     leot     8736:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.357     gutterid 8737: <p>To declare which languages should be made available through
                   8738:     pkgsrc's compiler wrappers, use 
1.87      wiz      8739:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327     wiz      8740:     currently are:
1.352     wiz      8741: </p>
1.327     wiz      8742: <pre class="programlisting">
1.358     gutterid 8743: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.352     wiz      8744: </pre>
1.327     wiz      8745: <p>
                   8746:     (and any combination).  The default is
1.385     leot     8747:     <span class="quote">“<span class="quote">c</span>”</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8748:     written in C++, usually need a C compiler for the configure
1.358     gutterid 8749:     phase.</p>
1.364     jnemeth  8750: <p>To declare which features a package requires from the
1.357     gutterid 8751:     compiler, set either <code class="varname">USE_CC_FEATURES</code>
                   8752:     or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
                   8753:     <code class="varname">USE_CC_FEATURES</code> are currently:
                   8754: </p>
                   8755: <pre class="programlisting">
                   8756: c11, c99, has_include
                   8757: </pre>
                   8758: <p>
                   8759:     Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
                   8760:     currently:
                   8761: </p>
                   8762: <pre class="programlisting">
                   8763: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
                   8764: charconv, parallelism_ts, unique_ptr, put_time,
                   8765: is_trivially_copy_constructible
                   8766: </pre>
                   8767: <p>
1.365     gutterid 8768:     Note at present these variables only affect use of GCC, not other
                   8769:     compilers.
1.357     gutterid 8770:     </p>
1.358     gutterid 8771: <p>Language variants like <code class="literal">gnu99</code> and
                   8772:     <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
                   8773:     and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
                   8774:     <code class="literal">-std=...</code> when compiling (i.e. the package
                   8775:     assumes the compiler defaults to C++11 or some other standard).
                   8776:     This is a common bug in upstream build systems.</p>
                   8777: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
                   8778:     currently:
                   8779: </p>
                   8780: <pre class="programlisting">
                   8781: c90, c99, c11, gnu90, gnu99, gnu11
                   8782: </pre>
                   8783: <p>
                   8784:     </p>
                   8785: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
                   8786:     currently:
                   8787: </p>
                   8788: <pre class="programlisting">
                   8789: c++03, c++11, c++14, c++17, c++20,
                   8790: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
                   8791: </pre>
                   8792: <p>
1.365     gutterid 8793:     Note at present these variables only affect use of GCC and Clang.
1.358     gutterid 8794:     </p>
1.87      wiz      8795: </div>
1.148     asau     8796: <div class="sect2">
1.87      wiz      8797: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8798: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8799: <p>If a program is written in Java, use the Java framework in
                   8800:     pkgsrc.  The package must include
                   8801:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8802:     provides the following variables:</p>
1.148     asau     8803: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8804: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8805:       dependency on the JDK is added.  If
1.385     leot     8806:       <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87      wiz      8807:       there is only a runtime dependency on the JDK.  The default is
1.385     leot     8808:       <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87      wiz      8809:       JDK.</p></li>
1.128     wiz      8810: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8811:       a package needs a Java2 implementation.  The supported values
1.385     leot     8812:       are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
                   8813:       <span class="quote">“<span class="quote">1.5</span>”</span>.  <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
                   8814:       implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
                   8815:       above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87      wiz      8816:       above. This variable is not set by default.</p></li>
1.130     wiz      8817: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8818:       automatically set to the runtime location of the used Java
                   8819:       implementation dependency. It may be used to set
                   8820:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8821:       needs this variable to be defined.
                   8822:       </p></li>
1.87      wiz      8823: </ul></div>
                   8824: </div>
1.148     asau     8825: <div class="sect2">
1.87      wiz      8826: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8827: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
1.320     wiz      8828: <p>If a program is written in Go and has any dependencies on
                   8829:     other Go modules, have the package include
                   8830:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8831: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8832: <li class="listitem"><p>Generate a list of those dependencies with
                   8833:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8834:       go-modules.mk</strong></span>.</p></li>
1.338     nia      8835: <li class="listitem"><p>Prepend
                   8836:       <code class="literal">.include "go-modules.mk"</code> to any other
                   8837:       <code class="literal">.include</code>s.</p></li>
                   8838: <li class="listitem"><p>Incorporate these modules in
                   8839:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8840:       makesum</strong></span>.</p></li>
                   8841: </ol></div>
                   8842: </div>
                   8843: <div class="sect2">
                   8844: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8845: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
1.338     nia      8846: <p>If a program is written in Rust and uses Cargo to build,
                   8847:     have the package include
                   8848:     <code class="filename">../../lang/rust/cargo.mk</code>.</p>
                   8849: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8850: <li class="listitem"><p>Generate a list of those dependencies with
                   8851:       <span class="command"><strong>make CARGO_ARGS="build --release" build &amp;&amp;
                   8852:       make print-cargo-depends &gt; cargo-depends.mk</strong></span>.</p></li>
                   8853: <li class="listitem"><p>Prepend
                   8854:       <code class="literal">.include "cargo-depends.mk"</code> to any other
                   8855:       <code class="literal">.include</code>s.</p></li>
1.320     wiz      8856: <li class="listitem"><p>Incorporate these modules in
                   8857:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8858:       makesum</strong></span>.</p></li>
                   8859: </ol></div>
                   8860: </div>
                   8861: <div class="sect2">
                   8862: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8863: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318     nia      8864: <p>If your package contains interpreted Perl scripts, add
1.385     leot     8865:     <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8866:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8867:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8868:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8869:     that you want adjusted. Every occurrence of
                   8870:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325     gutterid 8871:     replaced with the full path to the Perl executable.</p>
                   8872: <p>If a particular version of Perl is needed, set the
1.87      wiz      8873:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.385     leot     8874:     default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
                   8875: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing Perl modules">Section 21.6.6, “Packages installing Perl modules”</a> for information
1.325     gutterid 8876:     about handling Perl modules.</p>
                   8877: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8878:     for the language now known as Raku.</p>
1.87      wiz      8879: </div>
1.148     asau     8880: <div class="sect2">
1.87      wiz      8881: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8882: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8883: <p><code class="varname">REPLACE_SH</code>,
                   8884:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8885:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340     gutterid 8886:     she-bangs in files. Please use the appropriate one, preferring
                   8887:     <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183     wiz      8888:     Each should contain a list of scripts, relative to
                   8889:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8890:     occurrence of the matching shell in a she-bang line will be
                   8891:     replaced with the full path to the shell executable.
1.147     wiz      8892:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8893:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8894: </div>
1.148     asau     8895: <div class="sect2">
1.147     wiz      8896: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8897: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325     gutterid 8898: <p>There are further similar REPLACE variables available, e.g.,
                   8899:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8900:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326     gutterid 8901:     noted above, have their actions defined centrally in
1.325     gutterid 8902:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326     gutterid 8903:     languages define the actions of these variables within their own
                   8904:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.359     gutterid 8905:     actioned in <code class="filename">lang/php/replace.mk</code>, and
1.326     gutterid 8906:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325     gutterid 8907:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8908:     consult the mk files found within their specific directories (the
1.331     gutterid 8909:     naming convention varies), or check the list found in
1.385     leot     8910:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325     gutterid 8911: <p>Currently, special handling for other languages varies
1.87      wiz      8912:     in pkgsrc.  If a compiler package provides a
                   8913:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8914:     just add a (build) dependency on the appropriate compiler
                   8915:     package.</p>
                   8916: </div>
                   8917: </div>
1.148     asau     8918: <div class="sect1">
1.87      wiz      8919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8920: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8921: <p>The most common failures when building a package are that
                   8922:        some platforms do not provide certain header files, functions or
                   8923:        libraries, or they provide the functions in a library that the
                   8924:        original package author didn't know. To work around this, you
                   8925:        can rewrite the source code in most cases so that it does not
                   8926:        use the missing functions or provides a replacement function.</p>
1.148     asau     8927: <div class="sect2">
1.77      rillig   8928: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8929: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8930: <p>If a package already comes with a GNU configure script, the
                   8931:        preferred way to fix the build failure is to change the
                   8932:        configure script, not the code. In the other cases, you can
                   8933:        utilize the C preprocessor, which defines certain macros
                   8934:        depending on the operating system and hardware architecture it
                   8935:        compiles for. These macros can be queried using for example
                   8936:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8937:        system, hardware architecture and compiler has its own macro.
                   8938:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8939:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8940:        are all defined, you know that you are using NetBSD on an i386
                   8941:        compatible CPU, and your compiler is GCC.</p>
                   8942: <p>The list of the following macros for hardware and
                   8943:        operating system depends on the compiler that is used. For
                   8944:        example, if you want to conditionally compile code on Solaris,
                   8945:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8946:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8947: <div class="sect3">
1.75      rillig   8948: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8949: <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      8950: <p>To distinguish between specific NetBSD versions,
                   8951:         you should use the following code.</p>
                   8952: <pre class="programlisting">
                   8953: #ifdef __NetBSD__
                   8954: #include &lt;sys/param.h&gt;
                   8955: #if __NetBSD_Prereq__(9,99,17)
                   8956: /* use a newer feature */
                   8957: #else
                   8958: /* older code */
                   8959: #endif
                   8960: #endif
                   8961: 
                   8962: #ifndef _WIN32
                   8963: /* Unix-like specific code */
                   8964: #endif
                   8965: </pre>
1.75      rillig   8966: <p>To distinguish between 4.4 BSD-derived systems and the
                   8967:         rest of the world, you should use the following code.</p>
                   8968: <pre class="programlisting">
1.100     rillig   8969: #include &lt;sys/param.h&gt;
                   8970: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8971: /* BSD-specific code goes here */
                   8972: #else
                   8973: /* non-BSD-specific code goes here */
                   8974: #endif
1.75      rillig   8975: </pre>
1.338     nia      8976: <p>You can also test for the following macros:</p>
1.75      rillig   8977: <pre class="programlisting">
1.151     obache   8978: Cygwin      __CYGWIN__
                   8979: DragonFly   __DragonFly__
1.100     rillig   8980: FreeBSD     __FreeBSD__
1.151     obache   8981: Haiku       __HAIKU__
1.100     rillig   8982: IRIX        __sgi (TODO: get a definite source for this)
1.338     nia      8983: Linux       __linux
1.193     dholland 8984: Mac OS X    __APPLE__
1.151     obache   8985: Minix3      __minix
1.100     rillig   8986: NetBSD      __NetBSD__
                   8987: OpenBSD     __OpenBSD__
                   8988: Solaris     sun, __sun
1.75      rillig   8989: </pre>
                   8990: </div>
1.148     asau     8991: <div class="sect3">
1.75      rillig   8992: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8993: <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   8994: <pre class="programlisting">
1.100     rillig   8995: i386        i386, __i386, __i386__
1.338     nia      8996: x86-64      __amd64__, __x86_64__
                   8997: ARM         __arm__
1.100     rillig   8998: MIPS        __mips
                   8999: SPARC       sparc, __sparc
1.338     nia      9000: PowerPC     __powerpc
1.75      rillig   9001: </pre>
                   9002: </div>
1.148     asau     9003: <div class="sect3">
1.75      rillig   9004: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9005: <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   9006: <pre class="programlisting">
1.100     rillig   9007: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   9008: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   9009: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   9010: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   9011: </pre>
                   9012: </div>
                   9013: </div>
1.148     asau     9014: <div class="sect2">
1.78      rillig   9015: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9016: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   9017: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      9018:         combinations of compiler version and architecture and almost
                   9019:         always relation to optimisation being enabled.  Common symptoms
                   9020:         are gcc internal errors or never finishing compiling a
1.78      rillig   9021:        file.</p>
                   9022: <p>Typically, a workaround involves testing the
                   9023:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   9024:         optimisation for that combination of file,
1.198     tnn      9025:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   9026: <p>This used to be a big problem in the past, but is rarely
                   9027:        needed now as compiler technology has matured. If you still need
                   9028:        to add a compiler specific workaround, please do so in the file
                   9029:        <code class="filename">hacks.mk</code> and describe the symptom and
                   9030:        compiler version as detailed as possible.</p>
1.78      rillig   9031: </div>
1.148     asau     9032: <div class="sect2">
1.78      rillig   9033: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9034: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
1.287     rillig   9035: <p>Compilation sometimes fails with an error message like this:</p>
                   9036: <pre class="programlisting">
                   9037: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   9038:     fatal error: pango/pango.h: No such file or directory
                   9039: </pre>
                   9040: <p>The proper way to fix this problem depends on the type of the
                   9041: header, which is described in the following sections.</p>
                   9042: <div class="sect3">
                   9043: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9044: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
1.287     rillig   9045: <p>If the header name looks like it comes from a different package,
                   9046: that other package should be included via the buildlink3
                   9047: framework.</p>
                   9048: <p>First, look whether the header is somewhere in the buildlink3
                   9049: directory below <code class="varname">WRKDIR</code>. In the above case of
                   9050: the missing Pango header:</p>
                   9051: <pre class="programlisting">
                   9052: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   9053: </pre>
                   9054: <p>In the case of Pango, the output is:</p>
                   9055: <pre class="programlisting">
                   9056: work/.buildlink/include/pango-1.0/pango/pango.h
                   9057: </pre>
                   9058: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   9059: in the <code class="filename">.buildlink</code> directory, it would have been
                   9060: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   9061: path component though, which means that the compiler command line must
                   9062: contain an option of the form
                   9063: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   9064: most cases this option is generated by the configure script, which can be examined using:</p>
                   9065: <pre class="programlisting">
                   9066: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   9067: -I/usr/pkg/include/pango-1.0
                   9068: -I/usr/pkg/include/pango-1.0
                   9069: -I/usr/pkg/include/pango-1.0
                   9070: -I/usr/pkg/include/pango-1.0
                   9071: -I/usr/pkg/include/pango-1.0
                   9072: </pre>
                   9073: <p>This looks good. These options are transformed by the buildlink
                   9074: wrapper to refer to the correct path inside
                   9075: <code class="filename">work/.buildlink</code>.</p>
                   9076: <p>Since the compilation fails though, examine the compiler command
                   9077: lines in <code class="filename">work/.work.log</code> to see whether the
                   9078: <code class="literal">-I</code> option is included in the particular command
                   9079: line.</p>
                   9080: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   9081: build-env</strong></span>, which sets up an interactive, realistic environment
                   9082: including all the pkgsrc wrapper commands and environment variables. From
                   9083: there, try to compile some simple example programs that use the
                   9084: header.</p>
                   9085: </div>
                   9086: <div class="sect3">
                   9087: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9088: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
1.287     rillig   9089: <p>If the name of the header seems to come from the package itself,
                   9090: and if the build is run with parallel jobs, the package may have some
                   9091: undeclared dependencies between the <code class="filename">.c</code> and the
                   9092: <code class="filename">.h</code> files, and a C file is compiled before its
                   9093: required header is generated.</p>
                   9094: <p>To see whether the build runs with parallel jobs, run
                   9095: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   9096: like this:</p>
                   9097: <pre class="programlisting">
                   9098:   usr   MAKE_JOBS=              7
                   9099:   pkg   MAKE_JOBS_SAFE          # undefined
                   9100:   def   _MAKE_JOBS_N=           7
                   9101: </pre>
                   9102: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   9103: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   9104: package could have disabled parallel builds by setting
                   9105: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   9106: in this case it hasn't.</p>
                   9107: <p>To see whether the build failure is caused by parallel builds,
                   9108: first save the exact error message and a bit of context, maybe you need
                   9109: it later for reporting a bug. Next, run:</p>
                   9110: <pre class="programlisting">
                   9111: MAKE_JOBS_SAFE=no bmake clean build
                   9112: </pre>
                   9113: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   9114: report</a> against the pkgsrc package, including the exact error
                   9115: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   9116: </div>
1.288     rillig   9117: <div class="sect3">
                   9118: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9119: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
1.288     rillig   9120: <p>Pkgsrc does not work reliably if any of
                   9121: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   9122: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   9123: bootstrap program prevents installing pkgsrc in symlink-based
                   9124: directories. Existing pkgsrc installations are not checked for symlinks
                   9125: though.</p>
                   9126: <p>The "No such file or directory" error messages are a typical
                   9127: symptom of symlinks, and it's quite difficult to find out that this is
                   9128: the actual cause.</p>
                   9129: </div>
                   9130: <div class="sect3">
                   9131: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9132: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
1.288     rillig   9133: <p>When building a hierarchy of packages, it may happen that one
                   9134: package is built and then pkgsrc is updated. This situation can provoke
                   9135: various hard to diagnose build errors. To clean up the situation:</p>
                   9136: <pre class="programlisting">
1.338     nia      9137: <code class="prompt">$</code> (cd ../../ &amp;&amp; cat mk/bsd.pkg.mk &gt;/dev/null &amp;&amp; rm -rf */*/work)
1.288     rillig   9138: </pre>
1.338     nia      9139: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
                   9140: prevent running this command in the wrong directory.)</p>
1.288     rillig   9141: <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
                   9142: that directory as well.</p>
                   9143: </div>
                   9144: <div class="sect3">
                   9145: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9146: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
1.288     rillig   9147: <p>On platforms other than BSD, third-party packages are installed in
                   9148: <code class="filename">/usr/include</code>, together with the base system. This
                   9149: means that pkgsrc cannot distinguish between headers provided by the base
                   9150: system (which it needs) and headers from third-party packages (which are
                   9151: often included in pkgsrc as well). This can lead to subtle version
                   9152: mismatches.</p>
                   9153: <p>In pkgsrc installations that have been active for several years, it
                   9154: may happen that some files are manually deleted. To exclude this unlikely
                   9155: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   9156: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   9157: check/fix dependencies.</p>
1.385     leot     9158: <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>
1.288     rillig   9159: for contact information. Be prepared to describe what you have tried so
                   9160: far and what any error messages were.</p>
                   9161: </div>
1.287     rillig   9162: </div>
                   9163: <div class="sect2">
                   9164: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9165: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128     wiz      9166: </h3></div></div></div>
1.92      rillig   9167: <p>This error message often means that a package did not
1.78      rillig   9168:        link to a shared library it needs. The following functions are
                   9169:        known to cause this error message over and over.</p>
                   9170: <div class="informaltable">
1.216     tnn      9171: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   9172: <colgroup>
                   9173: <col>
                   9174: <col>
                   9175: <col>
                   9176: </colgroup>
                   9177: <thead><tr>
                   9178: <th>Function</th>
                   9179: <th>Library</th>
                   9180: <th>Affected platforms</th>
                   9181: </tr></thead>
                   9182: <tbody>
                   9183: <tr>
                   9184: <td>accept, bind, connect</td>
                   9185: <td>-lsocket</td>
                   9186: <td>Solaris</td>
                   9187: </tr>
                   9188: <tr>
                   9189: <td>crypt</td>
                   9190: <td>-lcrypt</td>
                   9191: <td>DragonFly, NetBSD</td>
                   9192: </tr>
                   9193: <tr>
                   9194: <td>dlopen, dlsym</td>
                   9195: <td>-ldl</td>
                   9196: <td>Linux</td>
                   9197: </tr>
                   9198: <tr>
                   9199: <td>gethost*</td>
                   9200: <td>-lnsl</td>
                   9201: <td>Solaris</td>
                   9202: </tr>
                   9203: <tr>
                   9204: <td>inet_aton</td>
                   9205: <td>-lresolv</td>
                   9206: <td>Solaris</td>
                   9207: </tr>
                   9208: <tr>
                   9209: <td>nanosleep, sem_*, timer_*</td>
                   9210: <td>-lrt</td>
                   9211: <td>Solaris</td>
                   9212: </tr>
                   9213: <tr>
                   9214: <td>openpty</td>
                   9215: <td>-lutil</td>
                   9216: <td>Linux</td>
                   9217: </tr>
                   9218: </tbody>
                   9219: </table>
                   9220: </div>
1.338     nia      9221: <p>To fix these linker errors, it is often sufficient to add
1.87      wiz      9222:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   9223:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338     nia      9224:     <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87      wiz      9225:     bmake</strong></span>.</p>
1.148     asau     9226: <div class="sect3">
1.92      rillig   9227: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9228: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92      rillig   9229: <p>When you are using the SunPro compiler, there is another
                   9230: possibility. That compiler cannot handle the following code:</p>
                   9231: <pre class="programlisting">
1.100     rillig   9232: extern int extern_func(int);
1.93      rillig   9233: 
1.100     rillig   9234: static inline int
                   9235: inline_func(int x)
                   9236: {
1.92      rillig   9237:         return extern_func(x);
1.100     rillig   9238: }
1.93      rillig   9239: 
1.100     rillig   9240: int main(void)
                   9241: {
1.92      rillig   9242:         return 0;
1.100     rillig   9243: }
1.92      rillig   9244: </pre>
                   9245: <p>It generates the code for <code class="function">inline_func</code> even if
                   9246: that function is never used. This code then refers to
                   9247: <code class="function">extern_func</code>, which can usually not be resolved. To
                   9248: solve this problem you can try to tell the package to disable inlining
                   9249: of functions.</p>
                   9250: </div>
1.343     gutterid 9251: <div class="sect3">
                   9252: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9253: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
1.343     gutterid 9254: <p>When building for older machine architectures (e.g., i386, PowerPC),
                   9255:   builds may fail because the package expects modern 64-bit atomic functions
                   9256:   which the underlying hardware either doesn't support, or will only support
                   9257:   with specific compiler flags. This is generally handled via inclusion of
                   9258:   mk/atomic64.mk.</p>
                   9259: </div>
1.87      wiz      9260: </div>
1.148     asau     9261: <div class="sect2">
1.87      wiz      9262: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9263: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      9264: <p>Sometimes packages fail to build because the compiler runs
                   9265:     into an operating system specific soft limit.  With the
                   9266:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338     nia      9267:     to unlimit the resources.  The allowed values are any combination of
1.385     leot     9268:     <span class="quote">“<span class="quote">cputime</span>”</span>,
                   9269:     <span class="quote">“<span class="quote">datasize</span>”</span>,
                   9270:     <span class="quote">“<span class="quote">memorysize</span>”</span>,
                   9271:     <span class="quote">“<span class="quote">stacksize</span>”</span> and
                   9272:     <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.87      wiz      9273:     Setting this variable is similar to running the shell builtin
1.110     hubertf  9274:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      9275:     segment size or maximum stack size of a process, respectively, to
                   9276:     their hard limits.</p>
1.78      rillig   9277: </div>
1.75      rillig   9278: </div>
1.148     asau     9279: <div class="sect1">
1.75      rillig   9280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9281: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     9282: <div class="sect2">
1.75      rillig   9283: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9284: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  9285: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      9286:     with some operating systems cannot create more than one
                   9287:     directory at a time. As such, you should call
                   9288:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9289: <pre class="programlisting">
1.100     rillig   9290: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9291: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    9292: </pre>
1.338     nia      9293: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
1.385     leot     9294:     directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
                   9295:     dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
1.338     nia      9296:     variable, which will automatically do the right thing.</p>
1.75      rillig   9297: </div>
1.148     asau     9298: <div class="sect2">
1.75      rillig   9299: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9300: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      9301: <p>In general, documentation should be installed into
1.87      wiz      9302:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338     nia      9303:     <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87      wiz      9304:     includes the version number of the package).</p>
1.84      wiz      9305: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      9306:     directory where HTML documentation is installed with the
1.385     leot     9307:     <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
1.338     nia      9308:     needed because otherwise the documentation ends up in
                   9309:     <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
                   9310:     pkgsrc, the HTML documentation should go into the package-specific
                   9311:     directory, just like any other documentation.</p>
1.87      wiz      9312: <p>An exception to the above is that library API documentation
1.322     leot     9313:     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      9314:     browsers (devhelp) should be left at their default location, which
                   9315:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9316:     documentation can be recognized from files ending in
                   9317:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9318:     (It is also acceptable to install such files in
                   9319:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9320:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9321:     <code class="filename">.devhelp*</code> file must be directly in that
                   9322:     directory then, no additional subdirectory level is allowed in
                   9323:     this case. This is usually achieved by using
1.385     leot     9324:     <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87      wiz      9325:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9326:     though.)</p>
1.75      rillig   9327: </div>
1.148     asau     9328: <div class="sect2">
1.75      rillig   9329: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9330: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   9331: <p>Certain packages, most of them in the games category, install
1.87      wiz      9332:     a score file that allows all users on the system to record their
                   9333:     highscores.  In order for this to work, the binaries need to be
                   9334:     installed setgid and the score files owned by the appropriate
1.142     wiz      9335:     group and/or owner (traditionally the "games" user/group).  Set
                   9336:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      9337:     following variables, documented in more detail in
                   9338:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      9339:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9340:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     9341:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   9342:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   9343:     <code class="varname">GAMEDATA_PERMS</code> and
                   9344:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   9345: <p>An example that illustrates some of the variables described above is
                   9346:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   9347:     used to properly set directory permissions of the directory where the
                   9348:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   9349:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   9350:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   9351:     binary:</p>
                   9352: <pre class="programlisting">
1.223     rillig   9353: USE_GAMESGROUP=         yes
1.210     leot     9354: 
1.223     rillig   9355: BUILD_DEFS+=            VARBASE
1.210     leot     9356: 
1.223     rillig   9357: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   9358: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9359: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    9360: </pre>
1.210     leot     9361: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9362:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9363:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9364:     needed to be accessed by setgid games and
                   9365:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 9366: <p>A package should therefore never hard code file ownership or
1.210     leot     9367:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9368:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9369:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9370:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   9371: </div>
1.148     asau     9372: <div class="sect2">
1.75      rillig   9373: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9374: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9375: <p><code class="varname">DESTDIR</code> support means that a package
                   9376:     installs into a staging directory, not the final location of the
                   9377:     files. Then a binary package is created which can be used for
                   9378:     installation as usual. There are two ways: Either the package must
1.385     leot     9379:     install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
                   9380:     install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148     asau     9381: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9382: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.385     leot     9383:       set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
1.224     leot     9384:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.385     leot     9385:       is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
1.145     wiz      9386:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9387:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9388:       the inclusion.</p></li>
1.128     wiz      9389: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9390:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9391: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9392:       automatically. Many manual rules and pre/post-install often are
                   9393:       incorrect; fix them.</p></li>
1.128     wiz      9394: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9395:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9396: <li class="listitem"><p>In general, packages should support
1.103     wiz      9397:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9398:       DESTDIR.</p></li>
                   9399: </ul></div>
                   9400: </div>
1.148     asau     9401: <div class="sect2">
1.103     wiz      9402: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9403: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9404: <p>Your package may also contain scripts with hardcoded paths to
1.318     nia      9405:       other interpreters besides (or as well as) Perl.  To correct the
1.87      wiz      9406:       full pathname to the script interpreter, you need to set the
                   9407:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9408:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9409: <pre class="programlisting">
1.100     rillig   9410: REPLACE_INTERPRETER+=   tcl
                   9411: REPLACE.tcl.old=        .*/bin/tclsh
                   9412: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9413: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9414: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    9415: </pre>
1.75      rillig   9416: </div>
1.148     asau     9417: <div class="sect2">
1.75      rillig   9418: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9419: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75      rillig   9420: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9421:     the Makefile fragment
                   9422:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9423:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9424:     configuration for such modules as well as various hooks to tune
                   9425:     this configuration.  See comments in this file for
                   9426:     details.</p>
1.75      rillig   9427: <p>Perl5 modules will install into different places depending
1.87      wiz      9428:     on the version of perl used during the build process.  To
                   9429:     address this, pkgsrc will append lines to the
                   9430:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9431:     the installed <code class="filename">.packlist</code> file generated by
                   9432:     most perl5 modules.  This is invoked by defining
                   9433:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9434:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9435:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9436:     e.g.:</p>
1.75      rillig   9437: <pre class="programlisting">
1.153     wiz      9438: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9439: </pre>
1.153     wiz      9440: <p>The perl5 config variables
                   9441:     <code class="varname">installarchlib</code>,
                   9442:     <code class="varname">installscript</code>,
                   9443:     <code class="varname">installvendorbin</code>,
                   9444:     <code class="varname">installvendorscript</code>,
                   9445:     <code class="varname">installvendorarch</code>,
                   9446:     <code class="varname">installvendorlib</code>,
                   9447:     <code class="varname">installvendorman1dir</code>, and
                   9448:     <code class="varname">installvendorman3dir</code> represent those
                   9449:     locations in which components of perl5 modules may be installed,
                   9450:     provided as variable with uppercase and prefixed with
                   9451:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9452:     and may be used by perl5 packages that don't have a packlist.
                   9453:     These variables are also substituted for in the
                   9454:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9455:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9456: </div>
1.148     asau     9457: <div class="sect2">
1.75      rillig   9458: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9459: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
1.369     wiz      9460: <p>Some packages, usually those providing libraries, install
                   9461:     pkg-config files so that their headers and libraries can easily be
                   9462:     found.  The file names end with <code class="filename">.pc</code>.</p>
                   9463: <p>Most of the time, these files only provide the linker flags
                   9464:     for the library, but do not include the flags for setting the
                   9465:     rpath so the libraries can also be found at runtime. Since this is
                   9466:     so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
                   9467:     for this. Many packages generate the <code class="filename">.pc</code> from
                   9468:     <code class="filename">.pc.in</code>, in that case add those files to the
                   9469:     <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
                   9470: <pre class="programlisting">
                   9471: PKGCONFIG_OVERRIDE+=   foo.pc.in
                   9472:     </pre>
                   9473: <p>For packages using meson, the files are generated during
                   9474:     build and you also need to change the phase in which the
                   9475:     replacement is done. For example:</p>
                   9476: <pre class="programlisting">
                   9477: PKGCONFIG_OVERRIDE+=            output/meson-private/foo.pc
                   9478: PKGCONFIG_OVERRIDE_STAGE=       post-build
                   9479:     </pre>
                   9480: </div>
                   9481: <div class="sect2">
                   9482: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9483: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.75      rillig   9484: <p>Some packages install info files or use the
1.385     leot     9485:     <span class="quote">“<span class="quote">makeinfo</span>”</span>  or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87      wiz      9486:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9487:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9488:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9489:     handle registration of the info files in the Info directory
1.385     leot     9490:     file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87      wiz      9491:     files registration is either provided by the system, or by a
                   9492:     special purpose package automatically added as dependency if
                   9493:     needed.</p>
1.75      rillig   9494: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9495:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9496:     located. <code class="varname">PKGINFODIR</code> defaults to
1.385     leot     9497:     <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75      rillig   9498: <p>The info files for the package should be listed in the
1.87      wiz      9499:     package <code class="filename">PLIST</code>; however any split info files
                   9500:     need not be listed.</p>
1.385     leot     9501: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
                   9502:     at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87      wiz      9503:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.385     leot     9504:     version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87      wiz      9505:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9506:     variable in the package <code class="filename">Makefile</code>. By
                   9507:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9508:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9509:     does not match the required minimum, a build dependency on the
1.322     leot     9510:     <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      9511:     be added automatically.</p>
1.75      rillig   9512: <p>The build and installation process of the software provided
1.87      wiz      9513:     by the package should not use the
1.110     hubertf  9514:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9515:     info files is the task of the package
                   9516:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9517:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9518: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9519:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9520:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9521:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9522: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9523:     no effect except the logging of a message. The script overriding
1.110     hubertf  9524:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9525:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9526:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9527: </div>
1.148     asau     9528: <div class="sect2">
1.75      rillig   9529: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9530: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.81      rillig   9531: <p>All packages that install manual pages should install them
1.87      wiz      9532:     into the same directory, so that there is one common place to look
                   9533:     for them. In pkgsrc, this place is
                   9534:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9535:     should be used in packages. The default for
                   9536:     <code class="varname">PKGMANDIR</code> is
1.385     leot     9537:     <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
                   9538:     is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148     asau     9539: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9540: <h3 class="title">Note</h3>
1.87      wiz      9541: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9542:     is far from complete.</p>
1.75      rillig   9543: </div>
1.81      rillig   9544: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9545:     <code class="filename">man/</code> as the top level directory for the man
                   9546:     page file entries, and the pkgsrc framework will convert as
                   9547:     needed. In all other places, the correct
                   9548:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9549: <p>Packages that are
                   9550:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.385     leot     9551:     <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87      wiz      9552:     <code class="filename">./configure</code>
                   9553:     --mandir switch to set where the man pages should be installed.
                   9554:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9555:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9556: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9557:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.385     leot     9558:     to <span class="quote">“<span class="quote">no</span>”</span>.
1.87      wiz      9559:     Or if the <code class="filename">./configure</code> script uses
                   9560:     a non-standard use of --mandir, you can set
                   9561:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.385     leot     9562: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.87      wiz      9563:     information on installation of compressed manual pages.</p>
1.75      rillig   9564: </div>
1.148     asau     9565: <div class="sect2">
1.75      rillig   9566: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9567: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9568: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9569:     the fonts database in the directory where they get installed at
                   9570:     installation and deinstallation time.  This can be automatically
                   9571:     done by using the pkginstall framework.</p>
1.75      rillig   9572: <p>You can list the directories where fonts are installed in the
1.87      wiz      9573:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9574:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.385     leot     9575:     <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87      wiz      9576:     Also make sure that the database file
                   9577:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9578: <p>Note that you should not create new directories for fonts;
1.87      wiz      9579:     instead use the standard ones to avoid that the user needs to
                   9580:     manually configure his X server to find them.</p>
1.75      rillig   9581: </div>
1.148     asau     9582: <div class="sect2">
1.75      rillig   9583: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9584: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9585: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9586:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9587:     etc.), you need to take some extra steps:</p>
1.128     wiz      9588: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9589: <li class="listitem"><p>Include
1.87      wiz      9590:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9591:        your <code class="filename">Makefile</code>, which takes care of
                   9592:        registering those files in system-wide catalogs at
                   9593:        installation and deinstallation time.</p></li>
1.128     wiz      9594: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9595:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9596: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9597:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9598: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9599:        to be added to the SGML catalog.  These come in groups of
                   9600:        three strings; see xmlcatmgr(1) for more information
                   9601:        (specifically, arguments recognized by the 'add' action).
                   9602:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9603: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9604:        to be added to the XML catalog.  These come in groups of three
                   9605:        strings; see xmlcatmgr(1) for more information (specifically,
                   9606:        arguments recognized by the 'add' action).  Note that you will
                   9607:        normally not use this variable.</p></li>
1.75      rillig   9608: </ol></div>
                   9609: </div>
1.148     asau     9610: <div class="sect2">
1.75      rillig   9611: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9612: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9613: <p>If a package provides extensions to the MIME database by
1.87      wiz      9614:     installing <code class="filename">.xml</code> files inside
                   9615:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9616:     need to take some extra steps to ensure that the database is kept
                   9617:     consistent with respect to these new files:</p>
1.128     wiz      9618: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9619: <li class="listitem"><p>Include
1.87      wiz      9620:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9621:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9622:        this same directory, which is reserved for inclusion from
                   9623:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9624:        care of rebuilding the MIME database at installation and
                   9625:        deinstallation time, and disallows any access to it directly
                   9626:        from the package.</p></li>
1.128     wiz      9627: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9628:        <code class="filename">share/mime</code> directory,
                   9629:        <span class="emphasis"><em>except</em></span> for files saved under
                   9630:        <code class="filename">share/mime/packages</code>.  The former are
                   9631:        handled automatically by
                   9632:        the update-mime-database program, but the latter are
                   9633:        package-dependent and must be removed by the package that
                   9634:        installed them in the first place.</p></li>
1.128     wiz      9635: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9636:        from the PLIST.  They will be handled by the shared-mime-info
                   9637:        package.</p></li>
1.75      rillig   9638: </ol></div>
                   9639: </div>
1.148     asau     9640: <div class="sect2">
1.75      rillig   9641: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9642: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.93      rillig   9643: <p>If a package uses intltool during its build, add
                   9644:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9645:     which forces it to use the intltool package provided by pkgsrc,
                   9646:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9647: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9648:     latest available version; this way, the package benefits of any
                   9649:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9650: </div>
1.148     asau     9651: <div class="sect2">
1.75      rillig   9652: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9653: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.374     wiz      9654: <p>If a package contains an rc.d script, it won't be copied into
                   9655:     the startup directory (<code class="filename">/etc/rc.d</code>) by default,
                   9656:     but you can enable copying by setting the option
                   9657:     <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9658:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  With <code class="varname">PKG_RCD_SCRIPTS=YES</code>, rc.d scripts
                   9659:     will be copied into <code class="filename">/etc/rc.d</code> when a package
                   9660:     is installed, but only if the target does not already exist.
                   9661:     Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
                   9662:     only if they have not been modified.
                   9663:     </p>
                   9664: <p>Note that this alone does not enable the service: It must still be
                   9665:     added to <code class="filename">/etc/rc.conf</code>.</p>
1.75      rillig   9666: </div>
1.148     asau     9667: <div class="sect2">
1.75      rillig   9668: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9669: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9670: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9671:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9672:     updated.</p>
1.148     asau     9673: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9674: <h3 class="title">Note</h3>
1.125     wiz      9675: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9676:     packages should install files
1.125     wiz      9677:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9678:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9679: </div>
1.128     wiz      9680: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9681: <li class="listitem"><p>Include
1.125     wiz      9682:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9683:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9684:       database at installation and deinstallation time.</p></li>
1.128     wiz      9685: <li class="listitem">
1.75      rillig   9686: <p>If your package installs files into a texmf
1.87      wiz      9687:       tree other than the one
1.125     wiz      9688:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9689:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9690:       trees that need database update.</p>
1.75      rillig   9691: <p>If your package also installs font map files that need
1.110     hubertf  9692:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9693:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9694:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9695:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9696:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9697:       be run automatically at installation/deinstallation to
                   9698:       enable/disable font map files for TeX output
                   9699:       drivers.</p>
1.75      rillig   9700: </li>
1.128     wiz      9701: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9702:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9703:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9704: </ol></div>
                   9705: </div>
1.148     asau     9706: <div class="sect2">
1.85      jmmv     9707: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9708: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.87      wiz      9709:     emulation</h3></div></div></div>
                   9710: <p>There are some packages that provide libraries and
                   9711:     executables for running binaries from a one operating system
                   9712:     on a different one (if the latter supports it).  One example
                   9713:     is running Linux binaries on NetBSD.</p>
1.322     leot     9714: <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      9715:     helps in extracting and packaging Linux rpm packages.</p>
                   9716: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9717:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9718:     if all libraries for each installed executable can be found by
                   9719:     the dynamic linker.  Since the standard dynamic linker is run,
                   9720:     this fails for emulation packages, because the libraries used
                   9721:     by the emulation are not in the standard directories.</p>
                   9722: </div>
1.299     rillig   9723: <div class="sect2">
                   9724: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9725: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.299     rillig   9726: <p>If a package installs images under the
                   9727:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9728:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9729:     database, you need to take some extra steps to make sure that the
                   9730:     shared theme directory is handled appropriately and that the cache
                   9731:     database is rebuilt:</p>
                   9732: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9733: <li class="listitem"><p>Include
                   9734:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9735: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9736:        entry that refers to the theme cache.</p></li>
                   9737: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9738:          directories from the <code class="filename">share/icons/hicolor</code>
                   9739:          hierarchy because they will be handled automatically.</p></li>
                   9740: </ol></div>
                   9741: <p>The best way to verify that the PLIST is correct with
                   9742:       respect to the last two points is to regenerate it using
                   9743:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9744: </div>
                   9745: <div class="sect2">
                   9746: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9747: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.299     rillig   9748: <p>If a package installs <code class="filename">.desktop</code> files
                   9749:       under <code class="filename">share/applications</code> and these include
                   9750:       MIME information (MimeType key), you need to take extra steps to
                   9751:       ensure that they are registered into the MIME database:</p>
                   9752: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9753: <li class="listitem"><p>Include
                   9754:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9755: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9756:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9757:          It will be handled automatically.</p></li>
                   9758: </ol></div>
                   9759: <p>The best way to verify that the PLIST is correct with
                   9760:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9761:       print-PLIST</strong></span>.</p>
                   9762: </div>
                   9763: </div>
                   9764: <div class="sect1">
                   9765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9766: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.299     rillig   9767: <p>In some cases one does not have the time to solve a problem
                   9768:   immediately. In this case, one can plainly mark a package as broken.  For
                   9769:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9770:   reason why the package is broken (similar to the
                   9771:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9772:   the package will immediately be shown this message, and the build
                   9773:   will not be even tried.</p>
                   9774: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9775:   intervals.</p>
                   9776: </div>
                   9777: </div>
                   9778: <div class="chapter">
                   9779: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     9780: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.299     rillig   9781: <div class="toc">
                   9782: <p><b>Table of Contents</b></p>
                   9783: <dl class="toc">
                   9784: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9785: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9786: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9787: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9788: </dl>
                   9789: </div>
                   9790: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9791: site</a>:</p>
                   9792: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9793:   environment, an intuitive and attractive desktop for users, and the
                   9794:   GNOME development platform, an extensive framework for building
                   9795:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9796: <p>pkgsrc provides a seamless way to automatically build and install
                   9797: a complete GNOME environment <span class="emphasis"><em>under many different
                   9798: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9799: the most advanced build and packaging systems for GNOME due to its
                   9800: included technologies buildlink3, the wrappers and tools framework and
                   9801: automatic configuration file management.  Lots of efforts are put into
                   9802: achieving a completely clean deinstallation of installed software
                   9803: components.</p>
                   9804: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9805: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9806: under this operating system.</p>
1.299     rillig   9807: <p>This chapter is aimed at pkgsrc developers and other people
                   9808: interested in helping our GNOME porting and packaging efforts.  It
                   9809: provides instructions on how to manage the existing packages and some
                   9810: important information regarding their internals.</p>
                   9811: <div class="sect1">
                   9812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9813: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.299     rillig   9814: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9815: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     9816: <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   9817:     the core GNOME desktop environment.  It only includes the necessary
                   9818:     bits to get it to boot correctly, although it may lack important
                   9819:     functionality for daily operation.  The idea behind this package is
                   9820:     to let end users build their own configurations on top of this one,
                   9821:     first installing this meta package to achieve a functional setup and
                   9822:     then adding individual applications.</p></li>
1.322     leot     9823: <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   9824:     complete installation of the GNOME platform and desktop as defined
                   9825:     by the GNOME project; this is based on the components distributed in
                   9826:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9827:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9828:     official FTP server.  Developer-only tools found in those
                   9829:     directories are not installed unless required by some other
                   9830:     component to work properly.  Similarly, packages from the bindings
                   9831:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9832:     in unless required as a dependency for an end-user component.  This
1.322     leot     9833:     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>
                   9834: <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   9835:     Installs all the tools required to build a GNOME component when
                   9836:     fetched from the CVS repository.  These are required to let the
                   9837:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9838: </ul></div>
                   9839: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9840: sorted in a way that eases updates: a package may depend on other
                   9841: packages listed before it but not on any listed after it.  It is very
                   9842: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9843: change it to alphabetical sorting!</em></span></p>
                   9844: </div>
                   9845: <div class="sect1">
                   9846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9847: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.299     rillig   9848: <p>Almost all GNOME applications are written in C and use a common
                   9849: set of tools as their build system.  Things get different with the new
                   9850: bindings to other languages (such as Python), but the following will
                   9851: give you a general idea on the minimum required tools:</p>
                   9852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9853: <li class="listitem">
                   9854: <p>Almost all GNOME applications use the GNU Autotools as their
                   9855:     build system.  As a general rule you will need to tell this to your
                   9856:     package:</p>
                   9857: <pre class="programlisting">
1.338     nia      9858: GNU_CONFIGURE=  yes
                   9859: USE_LIBTOOL=    yes
                   9860: USE_TOOLS+=     gmake
1.299     rillig   9861: </pre>
                   9862: </li>
                   9863: <li class="listitem">
                   9864: <p>If the package uses pkg-config to detect dependencies, add this
                   9865:     tool to the list of required utilities:</p>
                   9866: <pre class="programlisting">
1.338     nia      9867: USE_TOOLS+=     pkg-config
1.299     rillig   9868: </pre>
1.322     leot     9869: <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   9870:     the end of the build process to ensure that you did not miss to
                   9871:     specify any dependency in your package and that the version
                   9872:     requirements are all correct.</p>
                   9873: </li>
                   9874: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9875:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9876:     to handle dependencies and to force the package to use the latest
                   9877:     available version.</p></li>
                   9878: <li class="listitem">
                   9879: <p>If the package uses gtk-doc (a documentation generation
                   9880:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9881:     tool is rather big and the distfile should come with pregenerated
                   9882:     documentation anyway; if it does not, it is a bug that you ought to
                   9883:     report.  For such packages you should disable gtk-doc (unless it is
                   9884:     the default):</p>
                   9885: <pre class="programlisting">
1.338     nia      9886: CONFIGURE_ARGS+=        --disable-gtk-doc
1.299     rillig   9887: </pre>
                   9888: <p>The default location of installed HTML files
                   9889:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9890:     and should not be changed unless the package insists on installing
                   9891:     them somewhere else.  Otherwise programs as
                   9892:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9893:     do that with an entry similar to:</p>
                   9894: <pre class="programlisting">
1.338     nia      9895: CONFIGURE_ARGS+=        --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299     rillig   9896: </pre>
                   9897: </li>
                   9898: </ul></div>
                   9899: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9900: files under the installation prefix to maintain databases.  In this
                   9901: context, shared means that those exact same directories and files are
                   9902: used among several different packages, leading to conflicts in the
                   9903: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9904: handle the most common cases, so you have to forget about using
                   9905: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9906: omitting shared files from them.  If you find yourself doing those,
                   9907: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9908: <p>The following table lists the common situations that result in
                   9909: using shared directories or files.  For each of them, the appropriate
                   9910: solution is given.  After applying the solution be sure to
                   9911: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9912: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9913: <div class="table">
1.385     leot     9914: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.299     rillig   9915: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9916: <colgroup>
                   9917: <col>
                   9918: <col>
                   9919: </colgroup>
                   9920: <thead><tr>
                   9921: <th>If the package...</th>
                   9922: <th>Then...</th>
                   9923: </tr></thead>
                   9924: <tbody>
                   9925: <tr>
                   9926: <td>Installs icons under the
                   9927:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9928:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.385     leot     9929: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, “Packages installing hicolor icons”</a>.</td>
1.299     rillig   9930: </tr>
                   9931: <tr>
                   9932: <td>Installs files under
                   9933:         <code class="filename">share/mime/packages</code>.</td>
1.385     leot     9934: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, “Packages installing extensions to the MIME database”</a>.</td>
1.299     rillig   9935: </tr>
                   9936: <tr>
                   9937: <td>Installs <code class="filename">.desktop</code> files under
                   9938:         <code class="filename">share/applications</code> and these include MIME
                   9939:         information.</td>
1.385     leot     9940: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, “Packages installing desktop files”</a>.</td>
1.299     rillig   9941: </tr>
                   9942: </tbody>
                   9943: </table></div>
1.75      rillig   9944: </div>
1.299     rillig   9945: <br class="table-break">
1.75      rillig   9946: </div>
1.148     asau     9947: <div class="sect1">
1.87      wiz      9948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9949: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.299     rillig   9950: <p>When seeing GNOME as a whole, there are two kinds of
                   9951: updates:</p>
                   9952: <div class="variablelist"><dl class="variablelist">
                   9953: <dt><span class="term">Major update</span></dt>
                   9954: <dd>
                   9955: <p>Given that there is still a very long way for GNOME 3 (if it
                   9956:       ever appears), we consider a major update one that goes from a
                   9957:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9958:       where <code class="literal">Y</code> is even and greater than
                   9959:       <code class="literal">X</code>.  These are hard to achieve because they
                   9960:       introduce lots of changes in the components' code and almost all
                   9961:       GNOME distfiles are updated to newer versions.  Some of them can
                   9962:       even break API and ABI compatibility with the previous major
                   9963:       version series.  As a result, the update needs to be done all at
                   9964:       once to minimize breakage.</p>
                   9965: <p>A major update typically consists of around 80 package
                   9966:       updates and the addition of some new ones.</p>
                   9967: </dd>
                   9968: <dt><span class="term">Minor update</span></dt>
                   9969: <dd>
                   9970: <p>We consider a minor update one that goes from a
                   9971:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9972:       one where <code class="literal">Y</code> is greater than
                   9973:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9974:       not update all GNOME components, can be done in an incremental way
                   9975:       and do not break API nor ABI compatibility.</p>
                   9976: <p>A minor update typically consists of around 50 package
                   9977:       updates, although the numbers here may vary a lot.</p>
                   9978: </dd>
                   9979: </dl></div>
                   9980: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9981: release (either major or minor), the following steps should be
                   9982: followed:</p>
                   9983: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9984: <li class="listitem">
1.299     rillig   9985: <p>Get a list of all the tarballs that form the new release by
                   9986:     using the following commands.  These will leave the full list of the
                   9987:     components' distfiles into the <code class="filename">list.txt</code>
                   9988:     file:</p>
                   9989: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9990:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9991:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9992: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9993:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9994:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9995: </li>
1.299     rillig   9996: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9997:     bump their version to the release you are updating them to.  The
                   9998:     three meta packages should be always consistent with versioning.
                   9999:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10000:     in them.</p></li>
1.128     wiz      10001: <li class="listitem">
1.299     rillig   10002: <p>For each meta package, update all its
                   10003:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10004:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10005:     newer version (even if found in the FTP) because the meta packages
                   10006:     are supposed to list the exact versions that form a specific GNOME
                   10007:     release.  Exceptions are permitted here if a newer version solves a
                   10008:     serious issue in the overall desktop experience; these typically
                   10009:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10010:     from the developers.</p>
                   10011: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10012:     should be updated to the latest version available (if found in
                   10013:     pkgsrc).  This is the case, for example, of the dependencies on the
1.322     leot     10014:     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   10015: </li>
1.128     wiz      10016: <li class="listitem">
1.299     rillig   10017: <p>Generate a patch from the modified meta packages and extract the
                   10018:     list of "new" lines.  This will provide you an outline on what
                   10019:     packages need to be updated in pkgsrc and in what order:</p>
                   10020: <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   10021: </li>
1.299     rillig   10022: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   10023:     installed packages and start over from scratch at this point.</p></li>
                   10024: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   10025:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10026:     it in order.  For major desktop updates none of these should be
                   10027:     committed until the entire set is completed because there are chances
                   10028:     of breaking not-yet-updated packages.</p></li>
                   10029: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   10030:     the tree one by one with appropriate log messages.  At the end,
                   10031:     commit the three meta package updates and all the corresponding
                   10032:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10033:     <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>
                   10034: </ol></div>
                   10035: </div>
                   10036: <div class="sect1">
                   10037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10038: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.299     rillig   10039: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10040: packages.  Please, it is very important that you always, always,
                   10041: <span class="strong"><strong>always</strong></span> feed back any portability
1.385     leot     10042: 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, “Feedback to the author”</a>).  This is the only way to get
1.299     rillig   10043: their attention on portability issues and to ensure that future versions
                   10044: can be built out-of-the box on NetBSD.  The less custom patches in
                   10045: pkgsrc, the easier further updates are.  Those developers in charge of
                   10046: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 10047: <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
                   10048: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   10049: of them do.  Do not be short on your reports: always provide detailed
                   10050: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 10051: maximum portability and, if at all possible, provide a patch against the
                   10052: main Git branch.  The more verbose you are, the higher chances of your
                   10053: patch being accepted.</p>
1.299     rillig   10054: <p>Also, please avoid using preprocessor magic to fix portability
                   10055: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10056: GNOME to their operating system, the official GNOME sources are now
                   10057: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10058: and similar macros.  This hurts portability.  Please see our patching
1.385     leot     10059: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
1.299     rillig   10060: details.</p>
                   10061: </div>
1.75      rillig   10062: </div>
1.148     asau     10063: <div class="chapter">
1.75      rillig   10064: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10065: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   10066: <div class="toc">
                   10067: <p><b>Table of Contents</b></p>
1.210     leot     10068: <dl class="toc">
1.267     rillig   10069: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   10070: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   10071: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   10072: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   10073: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   10074: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   10075: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   10076: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   10077: </dl>
                   10078: </div>
1.148     asau     10079: <div class="sect1">
1.75      rillig   10080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10081: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   10082: <p>Our policy is that we accept binaries only from pkgsrc
                   10083:        developers to guarantee that the packages don't contain any
                   10084:        trojan horses etc. This is not to annoy anyone but rather to
                   10085:        protect our users! You're still free to put up your home-made
                   10086:        binary packages and tell the world where to get them. NetBSD
                   10087:        developers doing bulk builds and wanting to upload them please
1.385     leot     10088:        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     10089: builds)</i></a>.</p>
1.75      rillig   10090: </div>
1.148     asau     10091: <div class="sect1">
1.75      rillig   10092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10093: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333     nia      10094: <p>Firstly, you can import new packages into
1.385     leot     10095:        pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.333     nia      10096:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   10097:        for details.</p>
                   10098: <p>Next, check that your package is complete, compiles and
1.385     leot     10099:        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      10100:        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>
                   10101:        tool and fix any errors that appear.</p>
                   10102: <p>Finally, send a report to the pkgsrc bug tracking system,
1.378     leot     10103:        either with the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      10104:        that, go to the web page
1.289     leot     10105:        <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      10106:        which contains some instructions and a link to a form where you
                   10107:        can submit packages.  The
1.322     leot     10108:        <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      10109:        also available as a substitute for either of the above two tools.
                   10110:        </p>
1.87      wiz      10111: <p>In the form of the problem report, the category should be
1.385     leot     10112:        <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87      wiz      10113:        and version number, and the description field should contain a
                   10114:        short description of your package (contents of the COMMENT
1.333     nia      10115:        variable or DESCR file are OK).</p>
1.75      rillig   10116: </div>
1.148     asau     10117: <div class="sect1">
1.75      rillig   10118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10119: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   10120: <p>Please note all package additions, updates, moves, and
1.93      rillig   10121:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   10122:        important to keep this file up to date and conforming to the
                   10123:        existing format, because it will be used by scripts to
1.289     leot     10124:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   10125:        sites. Additionally, check the
1.76      rillig   10126:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   10127:        for the package you updated or removed, in case it was mentioned
                   10128:        there.</p>
                   10129: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   10130:        bumped, the change should appear in
1.93      rillig   10131:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   10132:        related or otherwise relevant. Mass bumps that result from a
                   10133:        dependency being updated should not be mentioned. In all other
                   10134:        cases it's the developer's decision.</p>
                   10135: <p>There is a make target that helps in creating proper
1.110     hubertf  10136:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   10137:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   10138:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   10139:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   10140:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  10141:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   10142:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   10143:   For new packages, or package moves or removals, set the
                   10144:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   10145:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  10146:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      10147:   not the same as your NetBSD login name. The target also automatically
                   10148:   removes possibly existing entries for the package in the
                   10149:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     10150:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 10151:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      10152:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   10153:   makes the cvs commands use the main repository.
                   10154:   </p>
1.75      rillig   10155: </div>
1.148     asau     10156: <div class="sect1">
1.75      rillig   10157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10158: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      10159: <p>For several years, there have been mirrors of pkgsrc in
1.375     jkoshy   10160:   fossil, git, and hg. Standard practice when using these tools is to
1.243     wiz      10161:   make the first line of a commit message function as a summary that
                   10162:   can be read without the rest, such as is commonly done with "git log
                   10163:   --oneline". For this reason, we have the following guidelines for
                   10164:   pkgsrc commit messages:</p>
                   10165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10166: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      10167:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      10168:     package, include the name of the package. For updates, include the
                   10169:     version to which it is updated.</p></li>
                   10170: <li class="listitem"><p>Leave the next line empty.</p></li>
                   10171: <li class="listitem"><p>Then come the details for the commit (changes in that
                   10172:     package, reason for a change) and any relevant PRs. Wrap this
                   10173:     section.</p></li>
                   10174: </ul></div>
                   10175: <p>Here is an example:
1.352     wiz      10176: </p>
1.243     wiz      10177: <pre class="programlisting">
1.352     wiz      10178: libxslt: update to 1.0.30
1.243     wiz      10179: 
1.352     wiz      10180: Changes since 1.0.29:
                   10181: ...
                   10182: </pre>
1.243     wiz      10183: <p>
                   10184:   </p>
                   10185: <p>Here is another example:
1.352     wiz      10186: </p>
1.243     wiz      10187: <pre class="programlisting">
1.352     wiz      10188: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.243     wiz      10189: 
1.352     wiz      10190: (rationale)
                   10191: </pre>
1.243     wiz      10192: <p>
                   10193:   </p>
1.385     leot     10194: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
1.243     wiz      10195:   allowed on the pkgsrc repository to change commit messages.</p>
                   10196: </div>
                   10197: <div class="sect1">
                   10198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10199: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      10200: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      10201:   access to the pkgsrc repository.</p>
1.385     leot     10202: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
1.140     wiz      10203: Start by adding the directory and then files in the directory. Don't
                   10204: forget to add the new package to the category's
                   10205: <code class="filename">Makefile</code>. Make sure you don't forget any files;
1.385     leot     10206: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
1.140     wiz      10207: <pre class="programlisting">
                   10208: <code class="prompt">$</code> cd .../pkgsrc/category
                   10209: <code class="prompt">$</code> cvs add pkgname
                   10210: <code class="prompt">$</code> cd pkgname
                   10211: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   10212: <code class="prompt">$</code> cvs add patches/p*
                   10213: <code class="prompt">$</code> cvs status | less
1.141     wiz      10214: <code class="prompt">$</code> cvs commit
1.140     wiz      10215: <code class="prompt">$</code> cd ..
1.350     gutterid 10216: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.141     wiz      10217: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     10218: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  10219: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      10220: </pre>
1.87      wiz      10221: <p>The commit message of the initial import should include part of the
1.76      rillig   10222:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      10223:   what the package is/does.</p>
1.140     wiz      10224: <p>Also mention the new package in
                   10225: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
1.385     leot     10226: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
                   10227: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75      rillig   10228: </div>
1.148     asau     10229: <div class="sect1">
1.75      rillig   10230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10231: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      10232: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   10233:   changes between old and new versions into the commit log when updating
1.87      wiz      10234:   a package. There are various reasons for this:</p>
1.148     asau     10235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10236: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      10237:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      10238: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      10239:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      10240: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   10241:   repository is very useful for people who read the pkgsrc-changes mailing
                   10242:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      10243:   the package.</p></li>
1.75      rillig   10244: </ul></div>
1.87      wiz      10245: <p>Please also recognize that, just because a new version of a package
1.75      rillig   10246:   has been released, it should not automatically be upgraded in the CVS
                   10247:   repository.  We prefer to be conservative in the packages that are
                   10248:   included in pkgsrc - development or beta packages are not really the
                   10249:   best thing for most places in which pkgsrc is used. Please use your
                   10250:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      10251:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   10252: </div>
1.148     asau     10253: <div class="sect1">
1.75      rillig   10254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10255: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     10256: <p>Renaming packages is not recommended.</p>
1.290     gutterid 10257: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     10258:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     10259: <p>
1.290     gutterid 10260:   Also, when renaming a package, please add
1.282     leot     10261:   the package name and version pattern(s) of the previous package
                   10262:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     10263:   This may be repeated for multiple renames.
                   10264:   The new package would be an exact replacement.
1.282     leot     10265:   Example:
1.122     reed     10266: </p>
1.282     leot     10267: <pre class="programlisting">
                   10268: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   10269: SUPERSEDES+=    optcomp-[0-9]*
                   10270: </pre>
1.385     leot     10271: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122     reed     10272:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   10273:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   10274:   not be an exact replacement but is a suggestion for the replaced
                   10275:   functionality.</p>
                   10276: </div>
1.148     asau     10277: <div class="sect1">
1.122     reed     10278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10279: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     10280: <p>It is preferred that packages are not renamed or moved, but if needed
                   10281:   please follow these steps.
                   10282: </p>
1.128     wiz      10283: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10284: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   10285: <li class="listitem">
1.75      rillig   10286: <p>Remove all CVS dirs.</p>
1.87      wiz      10287: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   10288: <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      10289: <p>and use that for further work.</p>
1.75      rillig   10290: </li>
1.128     wiz      10291: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
1.385     leot     10292: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
                   10293: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
1.128     wiz      10294: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     10295: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   10296: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   10297: for doing an update using pkgsrc building; for example, it can
1.378     leot     10298: search the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     10299: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   10300: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   10301: it may have multiple matches, so the tool should also check on the
                   10302: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   10303: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   10304: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.351     gutterid 10305: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.75      rillig   10306: place.</p></li>
1.128     wiz      10307: <li class="listitem">
1.75      rillig   10308: <p>Check if any package depends on it:
                   10309: </p>
                   10310: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   10311: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   10312: </li>
1.128     wiz      10313: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   10314: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   10315: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   10316: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   10317: <li class="listitem">
1.75      rillig   10318: <p>Commit the changed and removed files:</p>
                   10319: <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      10320: <p>(and any packages from step 5, of course).</p>
1.75      rillig   10321: </li>
                   10322: </ol></div>
                   10323: </div>
                   10324: </div>
1.148     asau     10325: <div class="chapter">
1.75      rillig   10326: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10327: <a name="policies"></a>Chapter 24. pkgsrc Policies</h2></div></div></div>
1.382     wiz      10328: <div class="toc">
                   10329: <p><b>Table of Contents</b></p>
                   10330: <dl class="toc">
                   10331: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   10332: <dd><dl>
                   10333: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   10334: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   10335: </dl></dd>
                   10336: </dl>
                   10337: </div>
                   10338: <div class="sect1">
                   10339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10340: <a name="stability"></a>24.1. Packages for which updating is restricted</h2></div></div></div>
1.382     wiz      10341: <p>In the past, some packages have caused more package failures than others, and we'd like to reduce this in the future.</p>
                   10342: <p>For this reason, pkgsrc-pmc marks some packages with <code class="varname">POLICY_UPDATE_LIMITED</code>. The possible values currently are:
                   10343: </p>
                   10344: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10345: <li class="listitem"><p><code class="literal">abi</code> for packages where ABI/API changes often broke the packages depending on them</p></li>
                   10346: <li class="listitem"><p><code class="literal">bootstrap</code> for packages that are used during the pkgsrc bootstrap</p></li>
                   10347: </ul></div>
                   10348: <p>
                   10349: <code class="filename">pkglint</code> will warn when committing updates to these packages.</p>
                   10350: <div class="sect2">
                   10351: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10352: <a name="stability.abi"></a>24.1.1. Limited Updates - ABI</h3></div></div></div>
1.382     wiz      10353: <p>Before committing non-micro version updates to packages marked
                   10354:   with <code class="varname">POLICY_UPDATE_LIMITED=abi</code>, a limited bulk
                   10355:   build of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/bulk-test-${PACKAGE}/index.html" target="_top"><code class="filename">meta-pkgs/bulk-test-${PACKAGE}</code></a> needs to be run
                   10356:   and the result posted to the tech-pkg mailing list, highlighting
                   10357:   what packages would stop building (if any).</p>
                   10358: <p>Depending on the result, pkgsrc-pmc then decides:
                   10359:   </p>
                   10360: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10361: <li class="listitem"><p>go ahead with the update</p></li>
                   10362: <li class="listitem"><p>wait for packages X, Y, Z to be fixed (upstream or
                   10363:     locally) with the updated version, which is put in wip in the
                   10364:     meantime</p></li>
                   10365: <li class="listitem"><p>In the second case, all pkgsrc developers are
                   10366:     encouraged to work on fixing this - it is not only the updater's
                   10367:     task to fix them.</p></li>
                   10368: </ul></div>
                   10369: <p>
                   10370:   </p>
                   10371: <p>The decision to wait for packages can be revisited.</p>
                   10372: </div>
                   10373: <div class="sect2">
                   10374: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10375: <a name="stability.bootstrap"></a>24.1.2. Limited Updates - Bootstrap</h3></div></div></div>
1.382     wiz      10376: <p>When updating packages used in the bootstrap, i.e. marked with
                   10377:   <code class="varname">POLICY_UPDATE_LIMITED=bootstrap</code>, test the
                   10378:   bootstrap process and preferably some basic packages and send the
                   10379:   patch to the tech-pkg mailing list so it can be tested on other
                   10380:   platforms as well. Give at least two weeks for feedback and testing
                   10381:   by others.</p>
                   10382: </div>
                   10383: </div>
                   10384: </div>
                   10385: <div class="chapter">
                   10386: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10387: <a name="devfaq"></a>Chapter 25. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   10388: <p>This section contains the answers to questions that may
                   10389:        arise when you are writing a package. If you don't find your
                   10390:        question answered here, first have a look in the other chapters,
                   10391:        and if you still don't have the answer, ask on the
                   10392:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     10393: <div class="qandaset">
1.289     leot     10394: <a name="devfaq.qandaset"></a><dl>
1.382     wiz      10395: <dt>25.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   10396:        MAKEFLAGS, .MAKEFLAGS and
                   10397:        MAKE_FLAGS?</a>
                   10398: </dt>
1.382     wiz      10399: <dt>25.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   10400:        MAKE, GMAKE and
                   10401:        MAKE_PROGRAM?</a>
                   10402: </dt>
1.382     wiz      10403: <dt>25.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   10404:        CC, PKG_CC and
                   10405:        PKGSRC_COMPILER?</a>
                   10406: </dt>
1.382     wiz      10407: <dt>25.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   10408:        VARNAME=BUILDLINK_PREFIX.foo
                   10409:        say it's empty?</a>
                   10410: </dt>
1.382     wiz      10411: <dt>25.5. <a href="#devfaq.master_sites">What does
1.78      rillig   10412:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   10413:        don't understand the := inside
                   10414:        it.</a>
                   10415: </dt>
1.382     wiz      10416: <dt>25.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   10417:        developers?</a>
                   10418: </dt>
1.382     wiz      10419: <dt>25.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   10420:        documentation?</a>
                   10421: </dt>
1.382     wiz      10422: <dt>25.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289     leot     10423: What shall I do?</a>
1.92      rillig   10424: </dt>
1.75      rillig   10425: </dl>
1.148     asau     10426: <table border="0" style="width: 100%;">
                   10427: <colgroup>
1.75      rillig   10428: <col align="left" width="1%">
1.128     wiz      10429: <col>
1.148     asau     10430: </colgroup>
1.75      rillig   10431: <tbody>
1.148     asau     10432: <tr class="question">
1.75      rillig   10433: <td align="left" valign="top">
1.382     wiz      10434: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>25.1.</b></p>
1.75      rillig   10435: </td>
                   10436: <td align="left" valign="top"><p>What is the difference between
                   10437:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10438:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10439: </tr>
                   10440: <tr class="answer">
1.91      rillig   10441: <td align="left" valign="top"></td>
1.338     nia      10442: <td align="left" valign="top">
                   10443: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.378     leot     10444:        to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.338     nia      10445: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
                   10446:        passed to the <code class="varname">MAKE_PROGRAM</code> when building the
                   10447:        package.</p>
                   10448: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
                   10449:        <span class="command"><strong>bmake</strong></span> and should not be used by
                   10450:        packages.</p>
                   10451: </td>
1.75      rillig   10452: </tr>
1.148     asau     10453: <tr class="question">
1.75      rillig   10454: <td align="left" valign="top">
1.382     wiz      10455: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>25.2.</b></p>
1.75      rillig   10456: </td>
                   10457: <td align="left" valign="top"><p>What is the difference between
                   10458:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10459:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10460: </tr>
                   10461: <tr class="answer">
1.91      rillig   10462: <td align="left" valign="top"></td>
1.338     nia      10463: <td align="left" valign="top">
                   10464: <p><code class="varname">MAKE</code> is the path to the
1.378     leot     10465:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.338     nia      10466:        infrastructure.</p>
                   10467: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
                   10468:        need to say <code class="varname">USE_TOOLS+=gmake</code> to use
                   10469:        that.</p>
                   10470: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
                   10471:        program that is used for building the package.</p>
                   10472: </td>
1.75      rillig   10473: </tr>
1.148     asau     10474: <tr class="question">
1.75      rillig   10475: <td align="left" valign="top">
1.382     wiz      10476: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>25.3.</b></p>
1.75      rillig   10477: </td>
                   10478: <td align="left" valign="top"><p>What is the difference between
                   10479:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10480:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10481: </tr>
                   10482: <tr class="answer">
1.91      rillig   10483: <td align="left" valign="top"></td>
1.75      rillig   10484: <td align="left" valign="top">
1.338     nia      10485: <p><code class="varname">CC</code> is the path to the real C
                   10486:        compiler, which can be configured by the pkgsrc user.</p>
                   10487: <p><code class="varname">PKG_CC</code> is the path to the compiler
                   10488:        wrapper.</p>
                   10489: <p><code class="varname">PKGSRC_COMPILER</code> is
                   10490:        <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
                   10491:        compiler that should be used. See
                   10492:        <code class="filename">mk/compiler.mk</code> for more information about
                   10493:        the latter variable.</p>
1.75      rillig   10494: </td>
                   10495: </tr>
1.148     asau     10496: <tr class="question">
1.75      rillig   10497: <td align="left" valign="top">
1.382     wiz      10498: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>25.4.</b></p>
1.75      rillig   10499: </td>
1.110     hubertf  10500: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10501:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10502:        say it's empty?</p></td>
                   10503: </tr>
                   10504: <tr class="answer">
1.91      rillig   10505: <td align="left" valign="top"></td>
1.75      rillig   10506: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.385     leot     10507:        available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
                   10508:        <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110     hubertf  10509:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10510:        command.</p></td>
                   10511: </tr>
1.148     asau     10512: <tr class="question">
1.78      rillig   10513: <td align="left" valign="top">
1.382     wiz      10514: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>25.5.</b></p>
1.78      rillig   10515: </td>
                   10516: <td align="left" valign="top"><p>What does
1.220     wiz      10517:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10518:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10519:        it.</p></td>
                   10520: </tr>
                   10521: <tr class="answer">
1.91      rillig   10522: <td align="left" valign="top"></td>
1.338     nia      10523: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
                   10524:        assignment operator, even though it may look like one.
1.78      rillig   10525:        Instead, it is a degenerate form of
1.220     wiz      10526:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.378     leot     10527:        which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10528:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10529:        case of <code class="varname">MASTER_SITE_*</code>,
                   10530:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10531:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10532:        <code class="code">package/</code>. That's where the
                   10533:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10534:        together.</p></td>
                   10535: </tr>
1.148     asau     10536: <tr class="question">
1.78      rillig   10537: <td align="left" valign="top">
1.382     wiz      10538: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>25.6.</b></p>
1.78      rillig   10539: </td>
                   10540: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10541:        developers?</p></td>
                   10542: </tr>
                   10543: <tr class="answer">
1.91      rillig   10544: <td align="left" valign="top"></td>
1.148     asau     10545: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10546: <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   10547: <dd><p>This is a list for technical discussions related
                   10548:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10549:        pkgsrc infrastructure, proposed new features, questions related
                   10550:        to porting pkgsrc to a new platform, advice for maintaining a
                   10551:        package, patches that affect many packages, help requests moved
                   10552:        from pkgsrc-users when an infrastructure bug is found,
                   10553:        etc.</p></dd>
1.289     leot     10554: <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   10555: <dd><p>All bug reports in category "pkg" sent with
1.378     leot     10556:        <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10557:        directly; use one of the other mailing
                   10558:        lists.</p></dd>
                   10559: </dl></div></td>
                   10560: </tr>
1.148     asau     10561: <tr class="question">
1.80      rillig   10562: <td align="left" valign="top">
1.382     wiz      10563: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>25.7.</b></p>
1.80      rillig   10564: </td>
                   10565: <td align="left" valign="top"><p>Where is the pkgsrc
                   10566:        documentation?</p></td>
                   10567: </tr>
                   10568: <tr class="answer">
1.91      rillig   10569: <td align="left" valign="top"></td>
1.80      rillig   10570: <td align="left" valign="top">
                   10571: <p>There are many places where you can find
                   10572:        documentation about pkgsrc:</p>
1.148     asau     10573: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10574: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10575:        of chapters that explain large parts of pkgsrc, but some
                   10576:        chapters tend to be outdated. Which ones they are is hard to
                   10577:        say.</p></li>
1.289     leot     10578: <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   10579:        about certain features, announcements of new parts of the pkgsrc
                   10580:        infrastructure and sometimes even announcements that a certain
                   10581:        feature has been marked as obsolete. The benefit here is that
                   10582:        each message has a date appended to it.</p></li>
1.128     wiz      10583: <li class="listitem"><p>Many of the files in the
1.80      rillig   10584:        <code class="filename">mk/</code> directory start with a comment that
                   10585:        describes the purpose of the file and how it can be used by the
1.92      rillig   10586:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10587:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10588:        help</strong></span>.</p></li>
1.128     wiz      10589: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10590:        information, but they tend to be highly abbreviated, especially
                   10591:        for actions that occur often. Some contain a detailed
                   10592:        description of what has changed, but they are geared towards the
                   10593:        other pkgsrc developers, not towards an average pkgsrc user.
                   10594:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10595:        don't know what has been before, these messages may not be worth
                   10596:        too much to you.</p></li>
1.385     leot     10597: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
                   10598:        documented</span>”</span>, that is the documentation exists only in the
1.80      rillig   10599:        mind of the developer who wrote the code. To get this
1.110     hubertf  10600:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10601:        to see who has written it and ask on the
                   10602:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10603:        find your questions later (see above). To be sure that the
                   10604:        developer in charge reads the mail, you may CC him or
                   10605:        her.</p></li>
                   10606: </ul></div>
1.299     rillig   10607: </td>
                   10608: </tr>
                   10609: <tr class="question">
                   10610: <td align="left" valign="top">
1.382     wiz      10611: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>25.8.</b></p>
1.299     rillig   10612: </td>
1.338     nia      10613: <td align="left" valign="top"><p>I have a little time to kill.
1.299     rillig   10614: What shall I do?</p></td>
                   10615: </tr>
                   10616: <tr class="answer">
                   10617: <td align="left" valign="top"></td>
                   10618: <td align="left" valign="top">
                   10619: <p>This is not really an FAQ yet, but here's the answer
                   10620: anyway.</p>
1.148     asau     10621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10622: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322     leot     10623:     <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   10624:     will tell you about newer versions of installed packages that are
                   10625:     available, but not yet updated in pkgsrc.</p></li>
                   10626: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10627:     &mdash; it contains a list of suggested new packages and a list of
                   10628:     cleanups and enhancements for pkgsrc that would be nice to
                   10629:     have.</p></li>
                   10630: <li class="listitem"><p>Review packages for which review was requested on
                   10631:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10632:     mailing list.</p></li>
1.85      jmmv     10633: </ul></div>
1.299     rillig   10634: </td>
1.85      jmmv     10635: </tr>
                   10636: </tbody>
1.299     rillig   10637: </table>
1.85      jmmv     10638: </div>
                   10639: </div>
1.75      rillig   10640: </div>
1.148     asau     10641: <div class="part">
1.75      rillig   10642: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     10643: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10644: <div class="partintro">
1.75      rillig   10645: <div></div>
                   10646: <p>This part of the guide deals with everything
                   10647:        from the infrastructure that is behind the interfaces described
                   10648:        in the developer's guide. A casual package maintainer should not
                   10649:        need anything from this part.</p>
                   10650: <div class="toc">
                   10651: <p><b>Table of Contents</b></p>
1.210     leot     10652: <dl class="toc">
1.382     wiz      10653: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10654: <dd><dl>
1.382     wiz      10655: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10656: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10657: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75      rillig   10658: <dd><dl>
1.382     wiz      10659: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10660: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75      rillig   10661: </dl></dd>
1.382     wiz      10662: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10663: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10664: <dd><dl>
1.382     wiz      10665: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10666: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10667: </dl></dd>
1.382     wiz      10668: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10669: <dd><dl>
1.382     wiz      10670: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10671: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10672: </dl></dd>
                   10673: </dl></dd>
1.382     wiz      10674: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig   10675: <dd><dl>
1.382     wiz      10676: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10677: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10678: <dd><dl>
1.382     wiz      10679: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10680: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10681: </dl></dd>
                   10682: </dl></dd>
1.382     wiz      10683: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   10684: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   10685: </dl>
                   10686: </div>
                   10687: </div>
1.148     asau     10688: <div class="chapter">
1.75      rillig   10689: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10690: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10691: <div class="toc">
                   10692: <p><b>Table of Contents</b></p>
1.210     leot     10693: <dl class="toc">
1.382     wiz      10694: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10695: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10696: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig   10697: <dd><dl>
1.382     wiz      10698: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10699: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig   10700: </dl></dd>
1.382     wiz      10701: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10702: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10703: <dd><dl>
1.382     wiz      10704: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10705: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10706: </dl></dd>
1.382     wiz      10707: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10708: <dd><dl>
1.382     wiz      10709: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10710: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10711: </dl></dd>
                   10712: </dl>
                   10713: </div>
                   10714: <p>The pkgsrc infrastructure consists of many small Makefile
                   10715:        fragments. Each such fragment needs a properly specified
                   10716:        interface. This chapter explains how such an interface looks
                   10717:        like.</p>
1.148     asau     10718: <div class="sect1">
1.75      rillig   10719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10720: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10721: <p>Whenever a variable is defined in the pkgsrc
                   10722:        infrastructure, the location and the way of definition provide
                   10723:        much information about the intended use of that variable.
                   10724:        Additionally, more documentation may be found in a header
                   10725:        comment or in this pkgsrc guide.</p>
                   10726: <p>A special file is
                   10727:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10728:        variables that are intended to be user-defined. They are either
                   10729:        defined using the <code class="literal">?=</code> operator or they are
                   10730:        left undefined because defining them to anything would
1.385     leot     10731:        effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81      rillig   10732:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10733:        file.</p>
                   10734: <p>Outside this file, the following conventions apply:
                   10735:        Variables that are defined using the <code class="literal">?=</code>
                   10736:        operator may be overridden by a package.</p>
                   10737: <p>Variables that are defined using the <code class="literal">=</code>
                   10738:        operator may be used read-only at run-time.</p>
                   10739: <p>Variables whose name starts with an underscore must not be
                   10740:        accessed outside the pkgsrc infrastructure at all. They may
                   10741:        change without further notice.</p>
1.148     asau     10742: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10743: <h3 class="title">Note</h3>
                   10744: <p>These conventions are currently not applied
                   10745:        consistently to the complete pkgsrc
                   10746:        infrastructure.</p>
                   10747: </div>
                   10748: </div>
1.148     asau     10749: <div class="sect1">
1.81      rillig   10750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10751: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10752: <p>All variables that contain lists of things should default
                   10753:        to being empty. Two examples that do not follow this rule are
                   10754:        <code class="varname">USE_LANGUAGES</code> and
                   10755:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10756:        modified using the <code class="literal">+=</code> operator in package
                   10757:        <code class="filename">Makefile</code>s (or other files included by
                   10758:        them), since there is no guarantee whether the variable is
                   10759:        already set or not, and what its value is. In the case of
1.385     leot     10760:        <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81      rillig   10761:        the default value and just define it as in the following
                   10762:        example.</p>
                   10763: <pre class="programlisting">
1.100     rillig   10764: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10765: </pre>
                   10766: <p>Because of the selection of this default value, the same
                   10767:        value appears in many package Makefiles. Similarly for
                   10768:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.385     leot     10769:        value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81      rillig   10770:        doesn't stand out. Nevertheless it is mentioned in many
                   10771:        files.</p>
                   10772: </div>
1.148     asau     10773: <div class="sect1">
1.81      rillig   10774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10775: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148     asau     10776: <div class="sect2">
1.75      rillig   10777: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10778: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75      rillig   10779: <p>Variable evaluation takes place either at load time or at
                   10780:        runtime, depending on the context in which they occur. The
                   10781:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10782: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10783: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10784:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10785: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10786:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10787: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10788: </ul></div>
                   10789: <p>A special exception are references to the iteration
                   10790:        variables of <code class="literal">.for</code> loops, which are expanded
                   10791:        inline, no matter in which context they appear.</p>
                   10792: <p>As the values of variables may change during load time,
                   10793:        care must be taken not to evaluate them by accident. Typical
                   10794:        examples for variables that should not be evaluated at load time
                   10795:        are <code class="varname">DEPENDS</code> and
                   10796:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10797:        clear, here is an example:</p>
                   10798: <pre class="programlisting">
1.100     rillig   10799: CONFIGURE_ARGS=         # none
                   10800: CFLAGS=                 -O
                   10801: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10802: 
1.100     rillig   10803: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10804: 
1.100     rillig   10805: CFLAGS+=                -Wall
1.222     sevan    10806: </pre>
1.75      rillig   10807: <p>This code shows how the use of the <code class="literal">:=</code>
                   10808:        operator can quickly lead to unexpected results. The first
                   10809:        paragraph is fairly common code. The second paragraph evaluates
                   10810:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10811:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10812:        <code class="literal">-Wall</code> is appended to the
                   10813:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10814:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10815:        paragraphs from above typically occur in completely unrelated
                   10816:        files.</p>
                   10817: </div>
1.148     asau     10818: <div class="sect2">
1.75      rillig   10819: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10820: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75      rillig   10821: <p>After all the files have been loaded, the values of the
                   10822:        variables cannot be changed anymore. Variables that are used in
                   10823:        the shell commands are expanded at this point.</p>
                   10824: </div>
                   10825: </div>
1.148     asau     10826: <div class="sect1">
1.75      rillig   10827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10828: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10829: <p>There are many ways in which the definition and use of a
1.218     rillig   10830:        variable can be restricted in order to detect bugs and violations
                   10831:        of the (mostly unwritten) policies. A package can be checked with
                   10832:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10833:        rules.</p>
1.78      rillig   10834: </div>
1.148     asau     10835: <div class="sect1">
1.78      rillig   10836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10837: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10838: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10839:        of the following classes. Cases where a file falls into more
                   10840:        than one class should be avoided as it often leads to subtle
                   10841:        bugs.</p>
1.148     asau     10842: <div class="sect2">
1.75      rillig   10843: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10844: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10845: <p>In a traditional imperative programming language some of
1.76      rillig   10846:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10847:        procedures. They take some input parameters and&mdash;after
                   10848:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10849:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10850:        care must be taken not to use parameter names that have already
                   10851:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10852:        bad choice for a parameter name.</p>
                   10853: <p>Procedures are completely evaluated at preprocessing time.
                   10854:        That is, when calling a procedure all input parameters must be
                   10855:        completely resolvable. For example,
                   10856:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10857:        parameter since it is very likely that further text will be
                   10858:        added after calling the procedure, which would effectively apply
                   10859:        the procedure to only a part of the variable. Also, references
1.218     rillig   10860:        to other variables will be modified after calling the
1.75      rillig   10861:        procedure.</p>
                   10862: <p>A procedure can declare its output parameters either as
                   10863:        suitable for use in preprocessing directives or as only
                   10864:        available at runtime. The latter alternative is for variables
                   10865:        that contain references to other runtime variables.</p>
                   10866: <p>Procedures shall be written such that it is possible to
                   10867:        call the procedure more than once. That is, the file must not
                   10868:        contain multiple-inclusion guards.</p>
                   10869: <p>Examples for procedures are
1.76      rillig   10870:        <code class="filename">mk/bsd.options.mk</code> and
                   10871:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10872:        that the parameters are evaluated at load time, they should be
                   10873:        assigned using the <code class="literal">:=</code> operator, which should
                   10874:        be used only for this purpose.</p>
                   10875: </div>
1.148     asau     10876: <div class="sect2">
1.75      rillig   10877: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10878: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10879: <p>Action files take some input parameters and may define
                   10880:        runtime variables. They shall not define loadtime variables.
                   10881:        There are action files that are included implicitly by the
                   10882:        pkgsrc infrastructure, while other must be included
                   10883:        explicitly.</p>
                   10884: <p>An example for action files is
1.76      rillig   10885:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10886: </div>
                   10887: </div>
1.148     asau     10888: <div class="sect1">
1.81      rillig   10889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10890: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10891: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10892:        a set of variable definitions, and include the file
                   10893:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10894:        Before that, they may also include various other
                   10895:        <code class="filename">*.mk</code> files if they need to query the
                   10896:        availability of certain features like the type of compiler or
                   10897:        the X11 implementation. Due to the heavy use of preprocessor
                   10898:        directives like <code class="literal">.if</code> and
                   10899:        <code class="literal">.for</code>, the order in which the files are loaded
                   10900:        matters.</p>
                   10901: <p>This section describes at which point the various files
                   10902:        are loaded and gives reasons for that order.</p>
1.148     asau     10903: <div class="sect2">
1.81      rillig   10904: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10905: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10906: </h3></div></div></div>
                   10907: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10908:        is to define some essential variables like
                   10909:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10910:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10911: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10912:        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   10913:        After that, those variables
1.81      rillig   10914:        that have not been overridden by the user are loaded from
                   10915:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10916: <p>After the user settings, the system settings and platform
                   10917:        settings are loaded, which may override the user
                   10918:        settings.</p>
                   10919: <p>Then, the tool definitions are loaded. The tool wrappers
                   10920:        are not yet in effect. This only happens when building a
                   10921:        package, so the proper variables must be used instead of the
                   10922:        direct tool names.</p>
                   10923: <p>As the last steps, some essential variables from the
                   10924:        wrapper and the package system flavor are loaded, as well as the
                   10925:        variables that have been cached in earlier phases of a package
                   10926:        build.</p>
                   10927: </div>
1.148     asau     10928: <div class="sect2">
1.81      rillig   10929: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10930: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10931: </h3></div></div></div>
1.81      rillig   10932: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10933: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10934:        loaded, which fill default values for those variables that have
1.93      rillig   10935:        not been defined by the package. These variables may later
1.81      rillig   10936:        be used even in unrelated files.</p>
                   10937: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10938:        provides the target <code class="literal">error-check</code> that is added
                   10939:        as a special dependency to all other targets that use
                   10940:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10941:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10942: <p>Then, the package-specific hacks from
                   10943:        <code class="filename">hacks.mk</code> are included.</p>
                   10944: <p>Then, various other files follow. Most of them don't have
                   10945:        any dependencies on what they need to have included before or
                   10946:        after them, though some do.</p>
                   10947: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10948:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10949:        restricts the use of these variables to all the files that have
                   10950:        been included before. Appearances in later files will be
                   10951:        silently ignored.</p>
                   10952: <p>Then, the files for the main targets are included, in the
                   10953:        order of later execution, though the actual order should not
                   10954:        matter.</p>
                   10955: <p>At last, some more files are included that don't set any
                   10956:        interesting variables but rather just define make targets to be
                   10957:        executed.</p>
                   10958: </div>
                   10959: </div>
1.75      rillig   10960: </div>
1.148     asau     10961: <div class="chapter">
1.75      rillig   10962: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10963: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75      rillig   10964: <div class="toc">
                   10965: <p><b>Table of Contents</b></p>
1.210     leot     10966: <dl class="toc">
1.382     wiz      10967: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10968: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10969: <dd><dl>
1.382     wiz      10970: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10971: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10972: </dl></dd>
                   10973: </dl>
                   10974: </div>
                   10975: <p>The pkgsrc infrastructure consists of a large codebase,
                   10976:        and there are many corners where every little bit of a file is
                   10977:        well thought out, making pkgsrc likely to fail as soon as
                   10978:        anything is changed near those parts. To prevent most changes
                   10979:        from breaking anything, a suite of regression tests should go
                   10980:        along with every important part of the pkgsrc infrastructure.
                   10981:        This chapter describes how regression tests work in pkgsrc and
                   10982:        how you can add new tests.</p>
1.148     asau     10983: <div class="sect1">
1.75      rillig   10984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10985: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.322     leot     10986: <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  10987:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10988:        can simply run that command, which will run all tests in the
1.283     rillig   10989:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10990: </div>
1.148     asau     10991: <div class="sect1">
1.75      rillig   10992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10993: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10994: <p>Every directory in the <code class="filename">regress/</code>
                   10995:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10996:        is considered a regression test. This file is a shell program
1.110     hubertf  10997:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10998:        The following functions can be overridden to suit your
                   10999:        needs.</p>
1.148     asau     11000: <div class="sect2">
1.75      rillig   11001: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11002: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   11003: <p>These functions do not take any parameters. Although they
1.385     leot     11004:        are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289     leot     11005:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   11006:        question</a> for details.</p>
1.148     asau     11007: <div class="variablelist"><dl class="variablelist">
1.218     rillig   11008: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   11009: <dd><p>This function prepares the environment for the
                   11010:        test. By default it does nothing.</p></dd>
1.218     rillig   11011: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   11012: <dd>
                   11013: <p>This function runs the actual test. By default,
1.75      rillig   11014:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   11015:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   11016:        error messages into the file
1.218     rillig   11017:        <code class="varname">TEST_OUTFILE</code>.</p>
                   11018: <p>When defining this function, make sure that all output that
                   11019:        needs to be checked is written to the correct output file.
                   11020:        Example:</p>
                   11021: <pre class="programlisting">
                   11022: do_test() {
1.223     rillig   11023:         echo "Example output"
1.218     rillig   11024: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   11025: </pre>
                   11026: </dd>
                   11027: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   11028: <dd>
                   11029: <p>This function is run after the test and is
1.75      rillig   11030:        typically used to compare the actual output from the one that is
                   11031:        expected. It can make use of the various helper functions from
1.218     rillig   11032:        the next section. Example:</p>
                   11033: <pre class="programlisting">
                   11034: check_result() {
1.223     rillig   11035:         exit_status 0
                   11036:         output_require "Example"
                   11037:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   11038:         output_prohibit "no such file or directory"
1.283     rillig   11039:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   11040: }
                   11041: </pre>
                   11042: </dd>
                   11043: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   11044: <dd><p>This function cleans everything up after the
                   11045:        test has been run. By default it does nothing.</p></dd>
                   11046: </dl></div>
                   11047: </div>
1.148     asau     11048: <div class="sect2">
1.75      rillig   11049: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11050: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148     asau     11051: <div class="variablelist"><dl class="variablelist">
1.283     rillig   11052: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   11053: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   11054: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   11055: <dd><p>This function compares the exitcode of the
1.218     rillig   11056:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   11057:        If they differ, the test will fail.</p></dd>
1.218     rillig   11058: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   11059: <dd>
                   11060: <p>This function checks for each of its parameters
                   11061:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   11062:        extended regular expression. If it does not, the test will
1.218     rillig   11063:        fail. Example:</p>
                   11064: <pre class="programlisting">
1.219     rillig   11065: output_require "looks fine"
                   11066: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   11067: </pre>
                   11068: </dd>
1.292     leot     11069: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   11070: <dd><p>This function checks for each of its parameters
1.110     hubertf  11071:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   11072:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   11073:        If any of the regular expressions matches, the test will
                   11074:        fail.</p></dd>
                   11075: </dl></div>
                   11076: </div>
                   11077: </div>
                   11078: </div>
1.148     asau     11079: <div class="chapter">
1.75      rillig   11080: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     11081: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75      rillig   11082: <div class="toc">
                   11083: <p><b>Table of Contents</b></p>
1.382     wiz      11084: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   11085: </div>
                   11086: <p>The pkgsrc system has already been ported to many
                   11087:        operating systems, hardware architectures and compilers. This
                   11088:        chapter explains the necessary steps to make pkgsrc even more
                   11089:        portable.</p>
1.148     asau     11090: <div class="sect1">
1.75      rillig   11091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11092: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   11093: <p>To port pkgsrc to a new operating system (called
                   11094:        <code class="literal">MyOS</code> in this example), you need to touch the
                   11095:        following files:</p>
1.148     asau     11096: <div class="variablelist"><dl class="variablelist">
1.93      rillig   11097: <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   11098: <dd><p>This file contains some basic definitions, for
                   11099:        example the name of the C
                   11100:        compiler.</p></dd>
1.76      rillig   11101: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   11102: <dd><p>Insert code that defines the variables
                   11103:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327     wiz      11104:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75      rillig   11105:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   11106:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   11107:        appear in this file.</p></dd>
1.93      rillig   11108: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11109: <dd><p>This file contains the platform-specific
                   11110:        definitions that are used by pkgsrc. Start by copying one of the
                   11111:        other files and edit it to your
                   11112:        needs.</p></dd>
1.93      rillig   11113: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11114: <dd><p>This file defines the paths to all the tools
                   11115:        that are needed by one or the other package in pkgsrc, as well
                   11116:        as by pkgsrc itself. Find out where these tools are on your
                   11117:        platform and add them.</p></dd>
                   11118: </dl></div>
                   11119: <p>Now, you should be able to build some basic packages, like
1.322     leot     11120:        <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   11121: </div>
                   11122: </div>
                   11123: </div>
1.148     asau     11124: <div class="appendix">
                   11125: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11126: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   11127: <div class="toc">
                   11128: <p><b>Table of Contents</b></p>
1.210     leot     11129: <dl class="toc">
1.75      rillig   11130: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   11131: <dd><dl>
                   11132: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   11133: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   11134: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   11135: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   11136: </dl></dd>
                   11137: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   11138: </dl>
                   11139: </div>
                   11140: <p>We checked to find a piece of software that wasn't in the packages
                   11141:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  11142:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   11143:     present in the tree is beyond us, but it's useful for the purposes of
                   11144:     this exercise.</p>
1.148     asau     11145: <div class="sect1">
1.75      rillig   11146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11147: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     11148: <div class="sect2">
1.75      rillig   11149: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11150: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
1.75      rillig   11151: <pre class="programlisting">
1.100     rillig   11152: # $NetBSD$
                   11153: #
1.1       grant    11154: 
1.100     rillig   11155: DISTNAME=       bison-1.25
                   11156: CATEGORIES=     devel
1.286     rillig   11157: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    11158: 
1.136     dholland 11159: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     11160: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   11161: COMMENT=        GNU yacc clone
1.1       grant    11162: 
1.100     rillig   11163: GNU_CONFIGURE=  yes
1.152     wiz      11164: INFO_FILES=     yes
1.1       grant    11165: 
1.100     rillig   11166: .include "../../mk/bsd.pkg.mk"
1.1       grant    11167: </pre>
1.75      rillig   11168: </div>
1.148     asau     11169: <div class="sect2">
1.75      rillig   11170: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11171: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
1.75      rillig   11172: <pre class="programlisting">
1.100     rillig   11173: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.378     leot     11174: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   11175: of the NetBSD source tree is beyond me.
1.1       grant    11176: </pre>
1.75      rillig   11177: </div>
1.148     asau     11178: <div class="sect2">
1.75      rillig   11179: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11180: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
1.75      rillig   11181: <pre class="programlisting">
1.100     rillig   11182: @comment $NetBSD$
                   11183: bin/bison
                   11184: man/man1/bison.1.gz
                   11185: share/bison.simple
                   11186: share/bison.hairy
1.1       grant    11187: </pre>
1.75      rillig   11188: </div>
1.148     asau     11189: <div class="sect2">
1.75      rillig   11190: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11191: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   11192: <p>The NetBSD package system comes with
1.322     leot     11193:         <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   11194:        which helps to check the contents of these
                   11195:        files. After installation it is quite easy to use, just change to the
1.286     rillig   11196:        directory of the package you wish to examine and run
1.110     hubertf  11197:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   11198: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   11199: ERROR: Makefile: Each package must define its LICENSE.
                   11200: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   11201: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   11202: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   11203: 1 error, 2 warnings and 1 note found.
                   11204: (Run "pkglint -e" to show explanations.)
                   11205: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   11206: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   11207: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   11208:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   11209:        -Wall</strong></span> for a very thorough check.</p>
                   11210: </div>
                   11211: </div>
1.148     asau     11212: <div class="sect1">
1.75      rillig   11213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11214: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
1.75      rillig   11215: <p>Create the directory where the package lives,
                   11216:       plus any auxiliary directories:</p>
                   11217: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   11218: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   11219: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   11220: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   11221: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.385     leot     11222:       <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   11223:       then continue with fetching the distfile:</p>
                   11224: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    11225: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   11226: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   11227: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11228: ftp: Error retrieving file: 500 Internal error
                   11229: 
                   11230: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   11231: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11232: ftp: Error retrieving file: 500 Internal error
                   11233: 
                   11234: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   11235: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   11236: Successfully retrieved file.</pre>
                   11237: <p>Generate the checksum of the distfile into
1.76      rillig   11238:       <code class="filename">distinfo</code>:</p>
1.88      wiz      11239: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   11240: <p>Now compile:</p>
                   11241: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    11242: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11243: ===&gt;  Extracting for bison-1.25
                   11244: ===&gt;  Patching for bison-1.25
                   11245: ===&gt;   Ignoring empty patch directory
                   11246: ===&gt;  Configuring for bison-1.25
                   11247: creating cache ./config.cache
                   11248: checking for gcc... cc
                   11249: checking whether we are using GNU C... yes
                   11250: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   11251: checking how to run the C preprocessor... cc -E
                   11252: checking for minix/config.h... no
                   11253: checking for POSIXized ISC... no
                   11254: checking whether cross-compiling... no
                   11255: checking for ANSI C header files... yes
                   11256: checking for string.h... yes
                   11257: checking for stdlib.h... yes
                   11258: checking for memory.h... yes
                   11259: checking for working const... yes
                   11260: checking for working alloca.h... no
                   11261: checking for alloca... yes
                   11262: checking for strerror... yes
                   11263: updating cache ./config.cache
                   11264: creating ./config.status
                   11265: creating Makefile
                   11266: ===&gt;  Building for bison-1.25
                   11267: 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
                   11268: 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
                   11269: 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
                   11270: 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
                   11271: 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   11272: 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    11273: 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
                   11274: 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
                   11275: 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
                   11276: 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
                   11277: 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
                   11278: 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
                   11279: 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
                   11280: 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
                   11281: 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
                   11282: 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
                   11283: 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
                   11284: 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
                   11285: 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
                   11286: 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
                   11287: 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
                   11288: 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
                   11289: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   11290: rm -f bison.s1
1.75      rillig   11291: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   11292: <p>Everything seems OK, so install the files:</p>
                   11293: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    11294: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11295: ===&gt;  Installing for bison-1.25
                   11296: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   11297: rm -f /usr/pkg/bin/bison
                   11298: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   11299: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   11300: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   11301: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   11302: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   11303: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   11304: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   11305: ===&gt;  Registering installation for bison-1.25</pre>
                   11306: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  11307:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   11308:       binary package, do this now:</p>
                   11309: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11310: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11311: ===&gt;  Building package for bison-1.25
                   11312: Creating package bison-1.25.tgz
                   11313: Registering depends:.
1.75      rillig   11314: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   11315: <p>Now that you don't need the source and object files
                   11316:       any more, clean up:</p>
                   11317: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   11318: ===&gt;  Cleaning for bison-1.25</pre>
                   11319: </div>
                   11320: </div>
1.148     asau     11321: <div class="appendix">
                   11322: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11323: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75      rillig   11324: <div class="toc">
                   11325: <p><b>Table of Contents</b></p>
1.210     leot     11326: <dl class="toc">
1.322     leot     11327: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   11328: <dd><dl>
                   11329: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   11330: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   11331: </dl></dd>
                   11332: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   11333: <dd><dl>
                   11334: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   11335: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   11336: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   11337: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   11338: </dl></dd>
                   11339: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   11340: <dd><dl>
                   11341: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   11342: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   11343: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   11344: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   11345: </dl></dd>
1.75      rillig   11346: </dl>
                   11347: </div>
1.322     leot     11348: <p>
                   11349: A number of mechanisms are available in pkgsrc to improve the security of the
                   11350: resulting system. This page describes the mechanisms, and gives hints
                   11351: about detecting and fixing problems.
                   11352: </p>
                   11353: <p>
                   11354: Mechanisms can be enabled individually in
                   11355: <code class="filename">mk.conf</code>, and are
                   11356: individually described below.
                   11357: </p>
                   11358: <p>
                   11359: Typically, a feature will cause some programs to fail to build or work
                   11360: when first enabled. This can be due to latent problems in the
                   11361: program, and can be due to other reasons. After enough testing to
                   11362: have confidence that user problems will be quite rare, individual
                   11363: mechanisms will be enabled by default.
                   11364: </p>
                   11365: <p>
                   11366: For each mechanism, see the Caveats section below for an explanation
                   11367: of what might go wrong at compile time and at run time, and how to
                   11368: notice and address these problems.
                   11369: </p>
1.148     asau     11370: <div class="sect1">
1.75      rillig   11371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11372: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
1.322     leot     11373: <div class="sect2">
                   11374: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11375: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
1.322     leot     11376: <div class="sect3">
                   11377: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11378: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
1.322     leot     11379: <p>
                   11380: This allows substitute wrappers to be used for some commonly used
                   11381: library functions that do not have built-in bounds checking - but
                   11382: could in some cases.
                   11383: </p>
                   11384: <p>
                   11385: Two mitigation levels are available:
                   11386: </p>
                   11387: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11388: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   11389: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   11390: </ul></div>
                   11391: <p>
                   11392: "strong" has been enabled by default since pkgsrc-2017Q3.
                   11393: </p>
                   11394: </div>
                   11395: <div class="sect3">
                   11396: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11397: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
1.322     leot     11398: <p>
                   11399: This enables a stack-smashing protection mitigation. It is done by adding a
                   11400: guard variable to functions with vulnerable objects. The guards are initialized
                   11401: when a function is entered and then checked when the function exits. The guard
                   11402: check will fail and the program forcibly exited if the variable was modified in
                   11403: the meantime. This can happen in case of buffer overflows or memory corruption,
                   11404: and therefore exposing these bugs.
                   11405: </p>
                   11406: <p>
                   11407: Different mitigation levels are available:
                   11408: </p>
                   11409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11410: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   11411: by the compiler;</p></li>
                   11412: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   11413: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   11414: two settings above.</p></li>
                   11415: </ul></div>
                   11416: <p>
                   11417: This mitigation is supported by both GCC and clang. It may be supported in
                   11418: additional compilers, possibly under a different name. It is particularly useful
                   11419: for unsafe programming languages, such as C/C++.
                   11420: </p>
                   11421: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11422: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   11423: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   11424: </ul></div>
                   11425: <p>More details can be found here:</p>
                   11426: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11427: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11428: </p></li></ul></div>
                   11429: </div>
                   11430: <div class="sect3">
                   11431: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11432: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
1.322     leot     11433: <p>
                   11434: This requests the creation of PIE (Position Independent Executables) for all
                   11435: executables. The PIE mechanism is normally used for shared libraries, so that
                   11436: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11437: useful security properties; however, it is necessary to fully leverage some,
                   11438: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11439: (ASLR), which causes different addresses to be used each time a program is run.
                   11440: This makes it more difficult for an attacker to guess addresses and thus makes
                   11441: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11442: program, instead of the stack and heap only.
                   11443: </p>
                   11444: <p>
                   11445: PIE executables will only be built for toolchains that are known to support PIE.
                   11446: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11447: </p>
                   11448: <p>
                   11449: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11450: </p>
1.75      rillig   11451: </div>
1.325     gutterid 11452: <div class="sect3">
                   11453: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11454: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322     leot     11455: <p>
                   11456: This also makes the exploitation of some security vulnerabilities more
                   11457: difficult in some cases.
                   11458: </p>
                   11459: <p>Two different mitigation levels are available:</p>
                   11460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11461: <li class="listitem"><p>
1.334     nia      11462: partial (the default): the ELF sections are reordered so that internal data sections
1.322     leot     11463: precede the program's own data sections, and non-PLT GOT is read-only;
                   11464: </p></li>
                   11465: <li class="listitem"><p>
                   11466: full: in addition to partial RELRO, every relocation is performed immediately
1.333     nia      11467: when starting the program, allowing the entire GOT to be read-only.  This
                   11468: can greatly slow down startup of large programs.
1.322     leot     11469: </p></li>
                   11470: </ul></div>
                   11471: <p>
                   11472: This is currently supported by GCC. Many software distributions now enable this
1.335     nia      11473: feature by default, at the "partial" level.
1.322     leot     11474: </p>
                   11475: <p>
                   11476: More details can be found here:
                   11477: </p>
                   11478: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11479: <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>
                   11480: </p></li></ul></div>
1.75      rillig   11481: </div>
1.334     nia      11482: </div>
                   11483: <div class="sect2">
                   11484: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11485: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
1.334     nia      11486: <div class="sect3">
                   11487: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11488: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
1.334     nia      11489: <p>
                   11490: With this option, pkgsrc will try to build packages reproducibly. This allows
                   11491: packages built from the same tree and with the same options, to produce
                   11492: identical results bit by bit. This option should be combined with ASLR and
                   11493: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
                   11494: attackers attempting to exploit security vulnerabilities.
                   11495: </p>
                   11496: <p>
                   11497: More details can be found here:
                   11498: </p>
                   11499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11500: <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>
                   11501: </p></li></ul></div>
                   11502: <p>
                   11503: More work likely needs to be done before pkgsrc is fully reproducible.
                   11504: </p>
                   11505: </div>
1.322     leot     11506: <div class="sect3">
                   11507: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11508: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322     leot     11509: <p>
                   11510: This uses <code class="literal">-fstack-check</code> with GCC for
                   11511: another stack protection mitigation.
                   11512: </p>
                   11513: <p>
                   11514: It asks the compiler to generate code verifying that it does not corrupt the
                   11515: stack. According to GCC's manual page, this is really only useful for
                   11516: multi-threaded programs.
                   11517: </p>
1.76      rillig   11518: </div>
                   11519: </div>
                   11520: </div>
1.148     asau     11521: <div class="sect1">
1.76      rillig   11522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11523: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
1.322     leot     11524: <div class="sect2">
                   11525: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11526: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
1.322     leot     11527: <div class="sect3">
                   11528: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11529: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
1.322     leot     11530: <p>
                   11531: A number of packages may fail to build with this option enabled. The
                   11532: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11533: compilation flag when building libraries or executables (or ideally
                   11534: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11535: <code class="varname">CFLAGS</code> already, but requires the package to
                   11536: actually support it.
                   11537: </p>
                   11538: <div class="sect4">
                   11539: <div class="titlepage"><div><div><h5 class="title">
1.385     leot     11540: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
1.322     leot     11541: <p>
                   11542: These instructions are meant as a reference only; they likely need to be adapted
                   11543: for many packages individually.
                   11544: </p>
                   11545: <p>
                   11546: For packages using <code class="filename">Makefiles</code>:
                   11547: </p>
                   11548: <pre class="programlisting">
                   11549: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11550: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11551: </pre>
                   11552: <p>
                   11553: For packages using <code class="filename">Imakefiles</code>:
                   11554: </p>
                   11555: <pre class="programlisting">
                   11556: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11557: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11558: </pre>
                   11559: </div>
                   11560: </div>
                   11561: <div class="sect3">
                   11562: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11563: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
1.322     leot     11564: <p>
                   11565: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11566: scenarios are essentially possible. This is nearly always due to a bug in
                   11567: the program being exposed due to ASLR.
                   11568: </p>
                   11569: </div>
                   11570: <div class="sect3">
                   11571: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11572: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
1.322     leot     11573: <p>
                   11574: Ideally, packages should be fixed for compatibility with MKPIE.
                   11575: However, in some cases this is very difficult, due to complex build systems,
                   11576: packages using non-standard toolchains, or programming languages with odd
                   11577: bootstrapping mechanisms.
                   11578: </p>
                   11579: <p>
                   11580: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11581: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11582: <code class="filename">bsd.prefs.mk</code> is included.
                   11583: </p>
                   11584: </div>
                   11585: </div>
                   11586: <div class="sect2">
                   11587: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11588: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
1.322     leot     11589: <div class="sect3">
                   11590: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11591: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
1.322     leot     11592: <p>
                   11593: This feature makes use of pre-processing directives to look for hardened,
                   11594: alternative implementations of essential library calls. Some programs may fail
                   11595: to build as a result; this usually happens for those trying too hard to be
                   11596: portable, or otherwise abusing definitions in the standard library.
                   11597: </p>
                   11598: </div>
                   11599: <div class="sect3">
                   11600: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11601: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
1.322     leot     11602: <p>
                   11603: This feature may cause some programs to crash, usually indicating an
                   11604: actual bug in the program. The fix will typically involve patching the
                   11605: original program's source code.
                   11606: </p>
                   11607: </div>
                   11608: <div class="sect3">
                   11609: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11610: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
1.322     leot     11611: <p>
                   11612: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11613: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11614: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11615: optimization level. This cannot easily be applied globally, as some packages
                   11616: may require specific optimization levels.
                   11617: </p>
                   11618: </div>
                   11619: <div class="sect3">
                   11620: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11621: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
1.322     leot     11622: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11623: <h3 class="title">Note</h3>
                   11624: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11625: the program!  This is a very bad idea and will expose you to security
                   11626: vulnerabilities.
                   11627: </p>
                   11628: </div>
                   11629: <p>
                   11630: To disable FORTIFY on a per-package basis, set the following
                   11631: in the package's <code class="filename">Makefile</code>
                   11632: before <code class="filename">bsd.prefs.mk</code> is included:
                   11633: </p>
                   11634: <pre class="programlisting">
                   11635: FORTIFY_SUPPORTED=     no
                   11636: </pre>
                   11637: </div>
                   11638: </div>
                   11639: <div class="sect2">
                   11640: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11641: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
1.322     leot     11642: <div class="sect3">
                   11643: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11644: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
1.322     leot     11645: <p>
                   11646: For better protection, full RELRO requires every symbol to be resolved when the
                   11647: program starts, rather than simply when required at run-time. This will have
                   11648: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11649: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11650: background are affected only when started. Programs loading plug-ins at
                   11651: run-time are affected when loading the plug-ins.
                   11652: </p>
                   11653: <p>
                   11654: The impact is not expected to be noticeable on modern hardware, except in some
                   11655: cases for big programs.
                   11656: </p>
                   11657: </div>
                   11658: <div class="sect3">
                   11659: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11660: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
1.322     leot     11661: <p>
                   11662: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11663: RELRO: for instance, with an initialization routine listing any other plug-in
                   11664: required. With full RELRO, the missing symbols are resolved before the
                   11665: initialization routine can run, and the dynamic loader will not be able to find
                   11666: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11667: drivers. Partial RELRO can be applied instead in this case.
                   11668: </p>
                   11669: </div>
                   11670: <div class="sect3">
                   11671: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11672: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
1.322     leot     11673: <p>
                   11674: To disable RELRO on a per-package basis, set the following
                   11675: in the package's <code class="filename">Makefile</code>
                   11676: before <code class="filename">bsd.prefs.mk</code> is included:
                   11677: </p>
                   11678: <pre class="programlisting">
                   11679: RELRO_SUPPORTED=       no
                   11680: </pre>
1.324     nia      11681: <p>
                   11682: It is also possible to at most enable partial RELRO, by
                   11683: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11684: </p>
1.322     leot     11685: </div>
                   11686: </div>
                   11687: <div class="sect2">
                   11688: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11689: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
1.322     leot     11690: <div class="sect3">
                   11691: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11692: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
1.322     leot     11693: <p>
                   11694: The stack-smashing protection provided by this option does not work for some
                   11695: programs. The most common situation in which this happens is when the program
                   11696: allocates variables on the stack, with the size determined at run-time.
                   11697: </p>
                   11698: </div>
                   11699: <div class="sect3">
                   11700: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11701: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
1.322     leot     11702: <p>
                   11703: Again, this feature may cause some programs to crash via a
                   11704: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11705: </p>
                   11706: <p>
                   11707: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11708: messages are sent and - by default -
                   11709: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11710: </p>
                   11711: <pre class="programlisting">
                   11712: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11713: </pre>
                   11714: <p>
                   11715: (where <code class="literal">hostname</code> is the hostname(1) and
                   11716: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11717: </p>
                   11718: <p>
                   11719: Patching the original program is then required.
                   11720: </p>
                   11721: <p>
                   11722: Rebuilding the package via:
                   11723: </p>
                   11724: <pre class="programlisting">
                   11725: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11726: </pre>
                   11727: <p>
                   11728: and inspecting the backtrace of the coredump via the debugger
                   11729: should point out the problematic call by inspecting the frame
                   11730: calling the _chk() (SSP) function.
                   11731: </p>
                   11732: </div>
                   11733: <div class="sect3">
                   11734: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11735: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
1.322     leot     11736: <p>
                   11737: The compiler emits extra code when using this feature: a check for buffer
                   11738: overflows is performed when entering and exiting functions, requiring an extra
                   11739: variable on the stack. The level of protection can otherwise be adjusted to
                   11740: affect only those functions considered more sensitive by the compiler (with
                   11741: -fstack-protector instead of -fstack-protector-all).
                   11742: </p>
                   11743: <p>
                   11744: The impact is not expected to be noticeable on modern hardware. However,
                   11745: programs with a hard requirement to run at the fastest possible speed should
                   11746: avoid using this feature, or using libraries built with this feature.
                   11747: </p>
                   11748: </div>
                   11749: <div class="sect3">
                   11750: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11751: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
1.322     leot     11752: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11753: <h3 class="title">Note</h3>
                   11754: <p>SSP should not be disabled to work around runtime crashes in
                   11755: the program!  This is a very bad idea and will expose you to security
                   11756: vulnerabilities.</p>
                   11757: </div>
                   11758: <p>
                   11759: To disable SSP on a per-package basis, set the following
                   11760: in the package's <code class="filename">Makefile</code>
                   11761: before <code class="filename">bsd.prefs.mk</code> is included:
                   11762: </p>
                   11763: <pre class="programlisting">
                   11764: SSP_SUPPORTED= no
                   11765: </pre>
                   11766: </div>
                   11767: </div>
                   11768: </div>
                   11769: <div class="sect1">
                   11770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11771: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
1.322     leot     11772: <p>
                   11773: The illusion of security is worse than having no security at all. This section
                   11774: lists a number of ways to ensure the security features requested are actually
                   11775: effective.
                   11776: </p>
                   11777: <p>
                   11778: These instructions were obtained and tested on a system derived from NetBSD 7
                   11779: (amd64). YMMV.
                   11780: </p>
                   11781: <div class="sect2">
                   11782: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11783: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
1.322     leot     11784: <p>
                   11785: The ELF executable type in use changes for binaries built as PIE; without:
                   11786: </p>
                   11787: <pre class="programlisting">
                   11788: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11789: /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
                   11790: </pre>
                   11791: <p>as opposed to the following binary, built as PIE:</p>
                   11792: <pre class="programlisting">
                   11793: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11794: /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
                   11795: </pre>
                   11796: <p>
                   11797: The latter result is then what is expected.
                   11798: </p>
                   11799: </div>
                   11800: <div class="sect2">
                   11801: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11802: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
1.322     leot     11803: <p>
                   11804: The following command should list a section called RELRO:
                   11805: </p>
                   11806: <pre class="programlisting">
                   11807: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11808: 
                   11809: /path/to/bin/ary:     file format elf64-x86-64
                   11810: 
                   11811: Program Header:
                   11812: [...]
                   11813:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11814: </pre>
                   11815: <p>
                   11816: This check is now performed automatically if
                   11817: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11818: </p>
                   11819: </div>
                   11820: <div class="sect2">
                   11821: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11822: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
1.322     leot     11823: <p>
                   11824: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11825: the <code class="varname">BIND_NOW</code> flag:
                   11826: </p>
                   11827: <pre class="programlisting">
                   11828: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11829: 
                   11830: /path/to/bin/ary:     file format elf64-x86-64
                   11831: 
                   11832: Dynamic Section:
                   11833: [...]
                   11834:   BIND_NOW             0x0000000000000000
                   11835: </pre>
                   11836: <p>
                   11837: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11838: </p>
                   11839: <p>
                   11840: This check is now performed automatically (where supported) if
                   11841: <code class="varname">PKG_DEVELOPER</code> is set.
                   11842: </p>
                   11843: </div>
                   11844: <div class="sect2">
                   11845: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11846: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323     nia      11847: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11848: <h3 class="title">Note</h3>
                   11849: <p>
                   11850: Checking for SSP using this method only works where the operating system
                   11851: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11852: on recent NetBSD/FreeBSD/Linux versions.
                   11853: </p>
                   11854: </div>
1.322     leot     11855: <p>
                   11856: Building objects, binaries and libraries with SSP will affect the presence of
                   11857: additional symbols in the resulting file:
                   11858: </p>
                   11859: <pre class="programlisting">
                   11860: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11861: [...]
                   11862:                  U __stack_chk_fail
                   11863: 0000000000600ea0 B __stack_chk_guard
                   11864: </pre>
                   11865: <p>
                   11866: This is an indicator that the program was indeed built with support for SSP.
                   11867: </p>
                   11868: <p>
                   11869: This check is now performed automatically (where supported) if
                   11870: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11871: </p>
                   11872: </div>
                   11873: </div>
                   11874: </div>
                   11875: <div class="appendix">
                   11876: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11877: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
1.322     leot     11878: <div class="toc">
                   11879: <p><b>Table of Contents</b></p>
                   11880: <dl class="toc">
                   11881: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11882: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11883: </dl>
                   11884: </div>
                   11885: <div class="sect1">
                   11886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11887: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
1.322     leot     11888: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11889: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11890: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11891: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11892: =&gt; [172219 bytes]
                   11893: Connected to ftp.plig.net.
                   11894: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11895: 331 Guest login ok, send your complete e-mail address as password.
                   11896: 230-You are user #5 of 500 simultaneous users allowed.
                   11897: 230-
                   11898: 230-  ___ _             _ _
                   11899: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11900: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11901: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11902: 230-         |_|   |_|     |___|         |___|
                   11903: 230-
                   11904: 230-** Welcome to ftp.plig.org **
                   11905: 230-
                   11906: 230-Please note that all transfers from this FTP site are logged. If you
                   11907: 230-do not like this, please disconnect now.
                   11908: 230-
                   11909: 230-This archive is available via
                   11910: 230-
                   11911: 230-HTTP:  http://ftp.plig.org/
                   11912: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11913: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11914: 230-
                   11915: 230-Please email comments, bug reports and requests for packages to be
                   11916: 230-mirrored to ftp-admin@plig.org.
                   11917: 230-
                   11918: 230-
                   11919: 230 Logged in anonymously.
                   11920: Remote system type is UNIX.
                   11921: Using binary mode to transfer files.
                   11922: 200 Type okay.
                   11923: 250 "/pub" is new cwd.
                   11924: 250-"/pub/figlet" is new cwd.
                   11925: 250-
                   11926: 250-Welcome to the figlet archive at ftp.figlet.org
                   11927: 250-
                   11928: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11929: 250-
                   11930: 250-The official FIGlet web page is:
                   11931: 250-   http://www.figlet.org/
                   11932: 250-
                   11933: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11934: 250-contribute a font or something else, you can email us.
                   11935: 250
                   11936: 250 "/pub/figlet/program" is new cwd.
                   11937: 250 "/pub/figlet/program/unix" is new cwd.
                   11938: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11939: 502 Unimplemented command.
                   11940: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11941: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11942: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11943: 226 Transfer completed.
                   11944: 172219 bytes received in 00:02 (75.99 KB/s)
                   11945: 221 Goodbye.
                   11946: =&gt; Checksum OK for figlet221.tar.gz.
                   11947: ===&gt; Extracting for figlet-2.2.1nb2
                   11948: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11949: ===&gt; Patching for figlet-2.2.1nb2
                   11950: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11951: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11952: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11953: ===&gt; Configuring for figlet-2.2.1nb2
                   11954: ===&gt; Building for figlet-2.2.1nb2
                   11955: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11956: chmod a+x figlet
                   11957: gcc -O2 -o chkfont chkfont.c
                   11958: =&gt; Unwrapping files-to-be-installed.
                   11959: <code class="prompt">#</code>
                   11960: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11961: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11962: ===&gt; Installing for figlet-2.2.1nb2
                   11963: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11964: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11965: mkdir -p /usr/pkg/share/figlet
                   11966: cp figlet /usr/pkg/bin
                   11967: cp chkfont /usr/pkg/bin
                   11968: chmod 555 figlist showfigfonts
                   11969: cp figlist /usr/pkg/bin
                   11970: cp showfigfonts /usr/pkg/bin
                   11971: cp fonts/*.flf /usr/pkg/share/figlet
                   11972: cp fonts/*.flc /usr/pkg/share/figlet
                   11973: cp figlet.6 /usr/pkg/man/man6
                   11974: ===&gt; Registering installation for figlet-2.2.1nb2
                   11975: <code class="prompt">#</code></pre>
                   11976: </div>
                   11977: <div class="sect1">
                   11978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11979: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
1.322     leot     11980: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11981: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11982: ===&gt; Packaging figlet-2.2.1nb2
                   11983: ===&gt; Building binary package for figlet-2.2.1nb2
                   11984: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11985: Using SrcDir value of /usr/pkg
                   11986: Registering depends:.
                   11987: <code class="prompt">#</code></pre>
                   11988: </div>
                   11989: </div>
                   11990: <div class="appendix">
                   11991: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11992: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.322     leot     11993: <div class="toc">
                   11994: <p><b>Table of Contents</b></p>
                   11995: <dl class="toc">
                   11996: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11997: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11998: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11999: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   12000: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   12001: <code class="filename">stable</code>,
                   12002: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   12003: source packages</a></span></dt>
                   12004: </dl>
                   12005: </div>
                   12006: <p>As in other big projects, the directory layout of pkgsrc
                   12007:        is quite complex for newbies. This chapter explains where you
                   12008:        find things on the FTP server. The base directory on
                   12009:        <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>.
                   12010:        On other servers it may be different, but inside this directory,
                   12011:        everything should look the same, no matter on which server you
                   12012:        are. This directory contains some subdirectories, which are
                   12013:        explained below.</p>
                   12014: <div class="sect1">
                   12015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12016: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.322     leot     12017: <p>The directory <code class="filename">distfiles</code> contains lots
                   12018:        of archive files from all pkgsrc packages, which are mirrored
                   12019:        here. The subdirectories are called after their package names
                   12020:        and are used when the distributed files have names that don't
                   12021:        explicitly contain a version number or are otherwise too generic
                   12022:        (for example <code class="filename">release.tar.gz</code>).</p>
                   12023: </div>
                   12024: <div class="sect1">
                   12025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12026: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.322     leot     12027: <p>This directory contains things that individual pkgsrc
                   12028:        developers find worth publishing.</p>
                   12029: </div>
                   12030: <div class="sect1">
                   12031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12032: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.322     leot     12033: <p>This directory contains binary packages for the various
                   12034:        platforms that are supported by pkgsrc.
                   12035:        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>
                   12036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   12037: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   12038:        operating system for which the packages have been built. The
                   12039:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   12040:        command, so it may differ from the one you are used to
                   12041:        hear.</p></li>
                   12042: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   12043:        architecture of the platform for which the packages have been
                   12044:        built. It also includes the <code class="varname">ABI</code> (Application
                   12045:        Binary Interface) for platforms that have several of
                   12046:        them.</p></li>
                   12047: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.370     gdt      12048:        the operating system.  Typically it is the version defining an
                   12049:        ABI, e.g. 9.0.</p></li>
1.322     leot     12050: <li class="listitem"><p><code class="varname">TAG</code> is either
1.370     gdt      12051:        <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
                   12052:        for a stable branch, or <code class="literal">current</code> for packages
1.322     leot     12053:        built from the HEAD branch. The latter should only be used when
1.370     gdt      12054:        the packages are updated on a regular basis.</p></li>
1.322     leot     12055: </ul></div>
1.370     gdt      12056: <p>The rationale for this scheme is that users can first
                   12057:        search by OPSYS and ARCH, since these are more or less
                   12058:        unchangeable.  After that, there is a management set of
                   12059:        directories with OSVERSION and TAG.</p>
                   12060: <p>See also <code class="filename">README.md</code> in
                   12061:        <code class="filename">packages</code> for more details, including
                   12062:        about symlinks.</p>
1.322     leot     12063: <p>In each of these directories, there is a
                   12064:        whole binary packages collection for a specific platform. It has a directory called
                   12065:        <code class="filename">All</code> which contains all binary packages.
1.370     gdt      12066:        </p>
1.322     leot     12067: </div>
                   12068: <div class="sect1">
                   12069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12070: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   12071: <p>Here are the reports from bulk builds, for those who want
                   12072:        to fix packages that didn't build on some of the platforms. The
1.385     leot     12073:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108     rillig   12074: </div>
1.148     asau     12075: <div class="sect1">
1.108     rillig   12076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12077: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261     leot     12078: <code class="filename">stable</code>,
1.126     jakllsch 12079: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   12080: source packages</h2></div></div></div>
1.385     leot     12081: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76      rillig   12082:        that is the files that define how to create binary packages from
                   12083:        source archives.</p>
1.262     leot     12084: <p>Each of the <code class="filename">current</code>,
                   12085:        <code class="filename">stable</code> and
                   12086:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12087:        directories share the same structure.  They each contain a
                   12088:        <code class="filename">pkgsrc</code> directory and
                   12089:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   12090: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   12091:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     12092:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   12093:        as the directory, ready to be downloaded as a whole.</p>
                   12094: <p>The <code class="filename">current</code> directory contains files
                   12095:        related to the HEAD branch of the CVS repository.
                   12096:        In this directory there is an additional file called
                   12097:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   12098:        all pkgsrc <code class="filename">README</code>s with information about
                   12099:        categories and packages.
                   12100:        </p>
                   12101: <p>The <code class="filename">stable</code> directory is a symlink to
                   12102:        the latest 
                   12103:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12104:        </p>
                   12105: <p>The
                   12106:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12107:        directories contain files related to the 
                   12108:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12109:        stable branch of the CVS repository. In these directories there is
                   12110:        an additional file called
                   12111:        <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   12112:        which contains the state of pkgsrc when it was branched.</p>
                   12113: </div>
1.75      rillig   12114: </div>
1.148     asau     12115: <div class="appendix">
                   12116: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     12117: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267     rillig   12118: <p>
                   12119:        The following list contains all help topics that are available
                   12120:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   12121: </p>
1.269     leot     12122: <table border="0" summary="Simple list" class="simplelist">
                   12123: <tr>
                   12124: <td>#!</td>
                   12125: <td>-lintl</td>
                   12126: </tr>
                   12127: <tr>
1.320     wiz      12128: <td>32bit</td>
1.269     leot     12129: <td>64bit</td>
1.320     wiz      12130: </tr>
                   12131: <tr>
1.269     leot     12132: <td>ABI</td>
1.320     wiz      12133: <td>ACCEPTABLE_LICENSES</td>
1.269     leot     12134: </tr>
                   12135: <tr>
                   12136: <td>ACROREAD_FONTPATH</td>
1.384     leot     12137: <td>AFAIK</td>
1.269     leot     12138: </tr>
                   12139: <tr>
1.320     wiz      12140: <td>AIX</td>
1.384     leot     12141: <td>ALLOW_NETWORK_ACCESS</td>
1.269     leot     12142: </tr>
                   12143: <tr>
1.357     gutterid 12144: <td>ALLOW_NEWER_COMPILER</td>
1.384     leot     12145: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.269     leot     12146: </tr>
                   12147: <tr>
1.357     gutterid 12148: <td>ALL_ENV</td>
1.384     leot     12149: <td>ALSA_PC</td>
1.369     wiz      12150: </tr>
                   12151: <tr>
1.368     gutterid 12152: <td>ALTERNATIVES_SRC</td>
1.384     leot     12153: <td>AMANDA_TMP</td>
1.382     wiz      12154: </tr>
                   12155: <tr>
                   12156: <td>AMANDA_USER</td>
1.384     leot     12157: <td>AMANDA_VAR</td>
1.378     leot     12158: </tr>
                   12159: <tr>
1.382     wiz      12160: <td>APACHE_GROUP</td>
1.384     leot     12161: <td>APACHE_MODULE_NAME</td>
1.376     wiz      12162: </tr>
                   12163: <tr>
1.382     wiz      12164: <td>APACHE_MODULE_SRC</td>
1.384     leot     12165: <td>APACHE_MODULE_SRCDIR</td>
1.367     gdt      12166: </tr>
                   12167: <tr>
1.382     wiz      12168: <td>APACHE_PKG_PREFIX</td>
1.384     leot     12169: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.360     leot     12170: </tr>
                   12171: <tr>
1.382     wiz      12172: <td>APACHE_SUEXEC_DOCROOT</td>
1.384     leot     12173: <td>APACHE_USER</td>
1.355     rillig   12174: </tr>
                   12175: <tr>
1.382     wiz      12176: <td>ARGMAX_REQ</td>
1.384     leot     12177: <td>ARG_MAX</td>
1.352     wiz      12178: </tr>
                   12179: <tr>
1.382     wiz      12180: <td>ARLA_CACHE</td>
1.384     leot     12181: <td>AUDIT_PACKAGES_FLAGS</td>
1.348     wiz      12182: </tr>
                   12183: <tr>
1.382     wiz      12184: <td>AUTOCONF_REQD</td>
1.384     leot     12185: <td>AUTOMAKE_OVERRIDE</td>
1.342     wiz      12186: </tr>
                   12187: <tr>
1.382     wiz      12188: <td>AUTOMAKE_REQD</td>
1.384     leot     12189: <td>AUTO_MKDIRS</td>
1.376     wiz      12190: </tr>
                   12191: <tr>
1.382     wiz      12192: <td>AUX</td>
1.384     leot     12193: <td>BDB185_DEFAULT</td>
1.338     nia      12194: </tr>
                   12195: <tr>
1.382     wiz      12196: <td>BDBBASE</td>
1.384     leot     12197: <td>BDB_ACCEPTED</td>
1.332     rillig   12198: </tr>
                   12199: <tr>
1.382     wiz      12200: <td>BDB_DEFAULT</td>
1.384     leot     12201: <td>BDB_LIBS</td>
1.329     leot     12202: </tr>
                   12203: <tr>
1.382     wiz      12204: <td>BDB_TYPE</td>
1.384     leot     12205: <td>BINCIMAP_GROUP</td>
1.327     wiz      12206: </tr>
                   12207: <tr>
1.382     wiz      12208: <td>BINCIMAP_LOG_USER</td>
1.384     leot     12209: <td>BINCIMAP_USER</td>
1.311     leot     12210: </tr>
                   12211: <tr>
1.382     wiz      12212: <td>BIND_DIR</td>
1.384     leot     12213: <td>BIND_GROUP</td>
1.292     leot     12214: </tr>
                   12215: <tr>
1.382     wiz      12216: <td>BIND_USER</td>
1.384     leot     12217: <td>BINOWN</td>
1.274     rillig   12218: </tr>
                   12219: <tr>
1.382     wiz      12220: <td>BINPKG_SITES</td>
1.384     leot     12221: <td>BIN_INSTALL_FLAGS</td>
1.269     leot     12222: </tr>
                   12223: <tr>
1.382     wiz      12224: <td>BISON_PKGDATADIR</td>
1.384     leot     12225: <td>BLAS</td>
1.369     wiz      12226: </tr>
                   12227: <tr>
1.382     wiz      12228: <td>BLAS_ACCEPTED</td>
1.384     leot     12229: <td>BLAS_C_INTERFACE</td>
1.269     leot     12230: </tr>
                   12231: <tr>
1.382     wiz      12232: <td>BLAS_INCLUDES</td>
1.384     leot     12233: <td>BLAS_INDEX64</td>
1.269     leot     12234: </tr>
                   12235: <tr>
1.382     wiz      12236: <td>BLAS_LIBS</td>
1.384     leot     12237: <td>BLAS_PC</td>
1.269     leot     12238: </tr>
                   12239: <tr>
1.382     wiz      12240: <td>BLAS_TYPE</td>
1.384     leot     12241: <td>BOOTSTRAP_DEPENDS</td>
1.269     leot     12242: </tr>
                   12243: <tr>
1.382     wiz      12244: <td>BROKEN</td>
1.384     leot     12245: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269     leot     12246: </tr>
                   12247: <tr>
1.382     wiz      12248: <td>BROKEN_ON_PLATFORM</td>
1.384     leot     12249: <td>BSDSRCDIR</td>
1.269     leot     12250: </tr>
                   12251: <tr>
1.384     leot     12252: <td>BSD_MAKE_ENV</td>
1.386     wiz      12253: <td>BUILDLINK_AUTO_DIRS</td>
1.269     leot     12254: </tr>
                   12255: <tr>
1.384     leot     12256: <td>BUILDLINK_AUTO_VARS</td>
1.386     wiz      12257: <td>BUILDLINK_CFLAGS</td>
1.269     leot     12258: </tr>
                   12259: <tr>
1.384     leot     12260: <td>BUILDLINK_CONTENTS_FILTER</td>
1.386     wiz      12261: <td>BUILDLINK_CPPFLAGS</td>
1.269     leot     12262: </tr>
                   12263: <tr>
1.384     leot     12264: <td>BUILDLINK_DEPMETHOD</td>
1.386     wiz      12265: <td>BUILDLINK_FILES</td>
1.269     leot     12266: </tr>
                   12267: <tr>
1.384     leot     12268: <td>BUILDLINK_FILES_CMD</td>
1.386     wiz      12269: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.269     leot     12270: </tr>
                   12271: <tr>
1.384     leot     12272: <td>BUILDLINK_LDFLAGS</td>
1.386     wiz      12273: <td>BUILDLINK_LIBS</td>
1.320     wiz      12274: </tr>
                   12275: <tr>
1.384     leot     12276: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.386     wiz      12277: <td>BUILDLINK_PKGNAME</td>
1.269     leot     12278: </tr>
                   12279: <tr>
1.384     leot     12280: <td>BUILDLINK_PREFIX</td>
1.386     wiz      12281: <td>BUILDLINK_RPATHDIRS</td>
1.269     leot     12282: </tr>
                   12283: <tr>
1.384     leot     12284: <td>BUILDLINK_TREE</td>
1.386     wiz      12285: <td>BUILD_DEFS</td>
1.269     leot     12286: </tr>
                   12287: <tr>
1.384     leot     12288: <td>BUILD_DEFS_EFFECTS</td>
1.386     wiz      12289: <td>BUILD_DEPENDS</td>
1.269     leot     12290: </tr>
                   12291: <tr>
1.384     leot     12292: <td>BUILD_DIRS</td>
1.386     wiz      12293: <td>BUILD_ENV_SHELL</td>
1.269     leot     12294: </tr>
                   12295: <tr>
1.384     leot     12296: <td>BUILD_MAKE_CMD</td>
1.386     wiz      12297: <td>BUILD_MAKE_FLAGS</td>
1.269     leot     12298: </tr>
                   12299: <tr>
1.384     leot     12300: <td>BUILD_TARGET</td>
1.386     wiz      12301: <td>BUILTIN_FIND_FILES</td>
1.269     leot     12302: </tr>
                   12303: <tr>
1.384     leot     12304: <td>BUILTIN_FIND_FILES_VAR</td>
1.386     wiz      12305: <td>BUILTIN_FIND_GREP</td>
1.269     leot     12306: </tr>
                   12307: <tr>
1.384     leot     12308: <td>BUILTIN_FIND_HEADERS</td>
1.386     wiz      12309: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269     leot     12310: </tr>
                   12311: <tr>
1.384     leot     12312: <td>BUILTIN_FIND_PKGCONFIG</td>
1.386     wiz      12313: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.269     leot     12314: </tr>
                   12315: <tr>
1.384     leot     12316: <td>BUILTIN_PKG</td>
1.386     wiz      12317: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.269     leot     12318: </tr>
                   12319: <tr>
1.384     leot     12320: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.386     wiz      12321: <td>BUILTIN_VERSION_SCRIPT</td>
1.309     gutterid 12322: </tr>
                   12323: <tr>
1.384     leot     12324: <td>BUILTIN_X11_TYPE</td>
1.386     wiz      12325: <td>BUILTIN_X11_VERSION</td>
1.269     leot     12326: </tr>
                   12327: <tr>
1.384     leot     12328: <td>CACTI_GROUP</td>
1.386     wiz      12329: <td>CACTI_USER</td>
1.269     leot     12330: </tr>
                   12331: <tr>
1.384     leot     12332: <td>CANNA_GROUP</td>
1.386     wiz      12333: <td>CANNA_USER</td>
1.269     leot     12334: </tr>
                   12335: <tr>
1.384     leot     12336: <td>CAT</td>
1.386     wiz      12337: <td>CBLAS_LIBS</td>
1.269     leot     12338: </tr>
                   12339: <tr>
1.384     leot     12340: <td>CBLAS_PC</td>
1.386     wiz      12341: <td>CCACHE_BASE</td>
1.269     leot     12342: </tr>
                   12343: <tr>
1.384     leot     12344: <td>CCACHE_DIR</td>
1.386     wiz      12345: <td>CCACHE_LOGFILE</td>
1.269     leot     12346: </tr>
                   12347: <tr>
1.384     leot     12348: <td>CCACHE_RECACHE</td>
1.386     wiz      12349: <td>CC_VERSION</td>
1.269     leot     12350: </tr>
                   12351: <tr>
1.386     wiz      12352: <td>CDRECORD_CONF</td>
1.389     wiz      12353: <td>CDROM_PKG_URL_DIR</td>
1.269     leot     12354: </tr>
                   12355: <tr>
1.386     wiz      12356: <td>CDROM_PKG_URL_HOST</td>
1.389     wiz      12357: <td>CHANGES</td>
1.269     leot     12358: </tr>
                   12359: <tr>
1.386     wiz      12360: <td>CHECKOUT_DATE</td>
1.389     wiz      12361: <td>CHECK_COMPILER</td>
1.338     nia      12362: </tr>
                   12363: <tr>
1.386     wiz      12364: <td>CHECK_FAKEHOME</td>
1.389     wiz      12365: <td>CHECK_FILES</td>
1.382     wiz      12366: </tr>
                   12367: <tr>
1.386     wiz      12368: <td>CHECK_FILES_ONLY_PREFIX</td>
1.389     wiz      12369: <td>CHECK_FILES_SKIP</td>
1.378     leot     12370: </tr>
                   12371: <tr>
1.386     wiz      12372: <td>CHECK_FILES_STRICT</td>
1.389     wiz      12373: <td>CHECK_HEADERS</td>
1.376     wiz      12374: </tr>
                   12375: <tr>
1.386     wiz      12376: <td>CHECK_HEADERS_SKIP</td>
1.389     wiz      12377: <td>CHECK_INTERPRETER</td>
1.369     wiz      12378: </tr>
                   12379: <tr>
1.386     wiz      12380: <td>CHECK_INTERPRETER_SKIP</td>
1.389     wiz      12381: <td>CHECK_PERMS</td>
1.367     gdt      12382: </tr>
                   12383: <tr>
1.386     wiz      12384: <td>CHECK_PERMS_AUTOFIX</td>
1.389     wiz      12385: <td>CHECK_PERMS_SKIP</td>
1.360     leot     12386: </tr>
                   12387: <tr>
1.386     wiz      12388: <td>CHECK_PIE</td>
1.389     wiz      12389: <td>CHECK_PIE_SKIP</td>
1.355     rillig   12390: </tr>
                   12391: <tr>
1.386     wiz      12392: <td>CHECK_PIE_SUPPORTED</td>
1.389     wiz      12393: <td>CHECK_PORTABILITY</td>
1.352     wiz      12394: </tr>
                   12395: <tr>
1.386     wiz      12396: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.389     wiz      12397: <td>CHECK_PORTABILITY_SKIP</td>
1.348     wiz      12398: </tr>
                   12399: <tr>
1.386     wiz      12400: <td>CHECK_RELRO</td>
1.389     wiz      12401: <td>CHECK_RELRO_SKIP</td>
1.342     wiz      12402: </tr>
                   12403: <tr>
1.386     wiz      12404: <td>CHECK_RELRO_SUPPORTED</td>
1.389     wiz      12405: <td>CHECK_SHLIBS</td>
1.332     rillig   12406: </tr>
                   12407: <tr>
1.386     wiz      12408: <td>CHECK_SHLIBS_SKIP</td>
1.389     wiz      12409: <td>CHECK_SHLIBS_SUPPORTED</td>
1.329     leot     12410: </tr>
                   12411: <tr>
1.386     wiz      12412: <td>CHECK_SHLIBS_TOXIC</td>
1.389     wiz      12413: <td>CHECK_SSP</td>
1.327     wiz      12414: </tr>
                   12415: <tr>
1.386     wiz      12416: <td>CHECK_SSP_SKIP</td>
1.389     wiz      12417: <td>CHECK_SSP_SUPPORTED</td>
1.320     wiz      12418: </tr>
                   12419: <tr>
1.386     wiz      12420: <td>CHECK_STRIPPED</td>
1.389     wiz      12421: <td>CHECK_STRIPPED_SKIP</td>
1.311     leot     12422: </tr>
                   12423: <tr>
1.386     wiz      12424: <td>CHECK_WRKREF</td>
1.389     wiz      12425: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.292     leot     12426: </tr>
                   12427: <tr>
1.386     wiz      12428: <td>CHECK_WRKREF_SKIP</td>
1.389     wiz      12429: <td>CLAMAV_DBDIR</td>
1.274     rillig   12430: </tr>
                   12431: <tr>
1.386     wiz      12432: <td>CLAMAV_GROUP</td>
1.389     wiz      12433: <td>CLAMAV_USER</td>
1.331     gutterid 12434: </tr>
                   12435: <tr>
1.386     wiz      12436: <td>CLANGBASE</td>
1.389     wiz      12437: <td>CLEANDEPENDS</td>
1.269     leot     12438: </tr>
                   12439: <tr>
1.386     wiz      12440: <td>CLT</td>
1.389     wiz      12441: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269     leot     12442: </tr>
                   12443: <tr>
1.386     wiz      12444: <td>CMAKE_INSTALL_NAME_DIR</td>
1.389     wiz      12445: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     12446: </tr>
                   12447: <tr>
1.386     wiz      12448: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.389     wiz      12449: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     12450: </tr>
                   12451: <tr>
1.386     wiz      12452: <td>CMAKE_PREFIX_PATH</td>
1.389     wiz      12453: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.269     leot     12454: </tr>
                   12455: <tr>
1.386     wiz      12456: <td>COMMON_LISP_DOCFILES</td>
1.389     wiz      12457: <td>COMMON_LISP_EXAMPLES</td>
1.369     wiz      12458: </tr>
                   12459: <tr>
1.386     wiz      12460: <td>COMMON_LISP_EXTRAFILES</td>
1.389     wiz      12461: <td>COMMON_LISP_PACKAGES</td>
1.382     wiz      12462: </tr>
                   12463: <tr>
1.386     wiz      12464: <td>COMMON_LISP_SYSTEM</td>
1.389     wiz      12465: <td>COMPILER_RPATH_FLAG</td>
1.382     wiz      12466: </tr>
                   12467: <tr>
1.386     wiz      12468: <td>COMPILER_USE_SYMLINKS</td>
1.389     wiz      12469: <td>CONFIGURE_ARGS</td>
1.269     leot     12470: </tr>
                   12471: <tr>
1.386     wiz      12472: <td>CONFIGURE_DIRS</td>
1.389     wiz      12473: <td>CONFIGURE_ENV</td>
1.269     leot     12474: </tr>
                   12475: <tr>
1.386     wiz      12476: <td>CONFIGURE_ENV_SHELL</td>
1.389     wiz      12477: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     12478: </tr>
                   12479: <tr>
1.386     wiz      12480: <td>CONFIGURE_HAS_MANDIR</td>
1.389     wiz      12481: <td>CONFIGURE_SCRIPT</td>
1.269     leot     12482: </tr>
                   12483: <tr>
1.386     wiz      12484: <td>CONFIG_SHELL</td>
1.389     wiz      12485: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     12486: </tr>
                   12487: <tr>
1.386     wiz      12488: <td>CONF_FILES</td>
1.389     wiz      12489: <td>CONF_FILES_MODE</td>
1.269     leot     12490: </tr>
                   12491: <tr>
1.386     wiz      12492: <td>CONF_FILES_PERMS</td>
1.389     wiz      12493: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     12494: </tr>
                   12495: <tr>
1.386     wiz      12496: <td>CONSERVER_DEFAULTPORT</td>
1.389     wiz      12497: <td>CP</td>
1.269     leot     12498: </tr>
                   12499: <tr>
1.386     wiz      12500: <td>CPE</td>
1.389     wiz      12501: <td>CPE_EDITION</td>
1.269     leot     12502: </tr>
                   12503: <tr>
1.386     wiz      12504: <td>CPE_LANG</td>
1.389     wiz      12505: <td>CPE_OTHER</td>
1.347     gutterid 12506: </tr>
                   12507: <tr>
1.386     wiz      12508: <td>CPE_PART</td>
1.389     wiz      12509: <td>CPE_PRODUCT</td>
1.347     gutterid 12510: </tr>
                   12511: <tr>
1.386     wiz      12512: <td>CPE_SW_EDITION</td>
1.389     wiz      12513: <td>CPE_TARGET_HW</td>
1.347     gutterid 12514: </tr>
                   12515: <tr>
1.386     wiz      12516: <td>CPE_TARGET_SW</td>
1.389     wiz      12517: <td>CPE_UPDATE</td>
1.347     gutterid 12518: </tr>
                   12519: <tr>
1.386     wiz      12520: <td>CPE_URI</td>
1.389     wiz      12521: <td>CPE_VENDOR</td>
1.347     gutterid 12522: </tr>
                   12523: <tr>
1.386     wiz      12524: <td>CPE_VERSION</td>
1.389     wiz      12525: <td>CPP</td>
1.347     gutterid 12526: </tr>
                   12527: <tr>
1.386     wiz      12528: <td>CPP_PRECOMP_FLAGS</td>
1.389     wiz      12529: <td>CREATE_WRKDIR_SYMLINK</td>
1.269     leot     12530: </tr>
                   12531: <tr>
1.386     wiz      12532: <td>CROSSBASE</td>
1.389     wiz      12533: <td>CTFCONVERT</td>
1.269     leot     12534: </tr>
                   12535: <tr>
1.386     wiz      12536: <td>CTF_FILES_SKIP</td>
1.389     wiz      12537: <td>CTF_SUPPORTED</td>
1.269     leot     12538: </tr>
                   12539: <tr>
1.386     wiz      12540: <td>CTYPE</td>
1.389     wiz      12541: <td>CUPS_GROUP</td>
1.269     leot     12542: </tr>
                   12543: <tr>
1.386     wiz      12544: <td>CUPS_SYSTEM_GROUPS</td>
1.389     wiz      12545: <td>CUPS_USER</td>
1.269     leot     12546: </tr>
                   12547: <tr>
1.386     wiz      12548: <td>CURSES_DEFAULT</td>
1.389     wiz      12549: <td>CURSES_TYPE</td>
1.292     leot     12550: </tr>
                   12551: <tr>
1.386     wiz      12552: <td>CVS_EXTRACTDIR</td>
1.389     wiz      12553: <td>CVS_MODULE</td>
1.342     wiz      12554: </tr>
                   12555: <tr>
1.386     wiz      12556: <td>CVS_PROJECT</td>
1.389     wiz      12557: <td>CVS_REPOSITORIES</td>
1.382     wiz      12558: </tr>
                   12559: <tr>
1.386     wiz      12560: <td>CVS_ROOT</td>
1.389     wiz      12561: <td>CVS_ROOT_GNU</td>
1.382     wiz      12562: </tr>
                   12563: <tr>
1.386     wiz      12564: <td>CVS_ROOT_NONGNU</td>
1.389     wiz      12565: <td>CVS_ROOT_SOURCEFORGE</td>
1.382     wiz      12566: </tr>
                   12567: <tr>
1.386     wiz      12568: <td>CVS_TAG</td>
1.389     wiz      12569: <td>CYRUS_GROUP</td>
1.382     wiz      12570: </tr>
                   12571: <tr>
1.386     wiz      12572: <td>CYRUS_IDLE</td>
1.389     wiz      12573: <td>CYRUS_USER</td>
1.378     leot     12574: </tr>
                   12575: <tr>
1.386     wiz      12576: <td>DAEMONTOOLS_GROUP</td>
1.389     wiz      12577: <td>DAEMONTOOLS_LOG_USER</td>
1.376     wiz      12578: </tr>
                   12579: <tr>
1.386     wiz      12580: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.389     wiz      12581: <td>DARWIN_REQUIRES_FILTER</td>
1.369     wiz      12582: </tr>
                   12583: <tr>
1.386     wiz      12584: <td>DBUS_GROUP</td>
1.389     wiz      12585: <td>DBUS_USER</td>
1.367     gdt      12586: </tr>
                   12587: <tr>
1.386     wiz      12588: <td>DEFANG_GROUP</td>
1.389     wiz      12589: <td>DEFANG_USER</td>
1.360     leot     12590: </tr>
                   12591: <tr>
1.386     wiz      12592: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.389     wiz      12593: <td>DEFAULT_DISTFILES</td>
1.352     wiz      12594: </tr>
                   12595: <tr>
1.386     wiz      12596: <td>DEFAULT_IRC_SERVER</td>
1.389     wiz      12597: <td>DEFAULT_SERIAL_DEVICE</td>
1.348     wiz      12598: </tr>
                   12599: <tr>
1.386     wiz      12600: <td>DEF_UMASK</td>
1.389     wiz      12601: <td>DEINSTALLDEPENDS</td>
1.332     rillig   12602: </tr>
                   12603: <tr>
1.386     wiz      12604: <td>DEINSTALL_SRC</td>
1.389     wiz      12605: <td>DEINSTALL_TEMPLATES</td>
1.329     leot     12606: </tr>
                   12607: <tr>
1.386     wiz      12608: <td>DELAYED_ERROR_MSG</td>
1.389     wiz      12609: <td>DELAYED_WARNING_MSG</td>
1.327     wiz      12610: </tr>
                   12611: <tr>
1.386     wiz      12612: <td>DEPENDS</td>
1.389     wiz      12613: <td>DEPENDS_TARGET</td>
1.320     wiz      12614: </tr>
                   12615: <tr>
1.386     wiz      12616: <td>DEPENDS_TYPE</td>
1.389     wiz      12617: <td>DESTDIR</td>
1.311     leot     12618: </tr>
                   12619: <tr>
1.386     wiz      12620: <td>DESTDIR_VARNAME</td>
1.389     wiz      12621: <td>DIALER_GROUP</td>
1.269     leot     12622: </tr>
                   12623: <tr>
1.386     wiz      12624: <td>DIGEST_REQD</td>
1.389     wiz      12625: <td>DISTDIR</td>
1.269     leot     12626: </tr>
                   12627: <tr>
1.386     wiz      12628: <td>DISTFILES</td>
1.389     wiz      12629: <td>DISTINFO_FILE</td>
1.269     leot     12630: </tr>
                   12631: <tr>
1.386     wiz      12632: <td>DISTNAME</td>
1.389     wiz      12633: <td>DIST_PATH</td>
1.309     gutterid 12634: </tr>
                   12635: <tr>
1.386     wiz      12636: <td>DIST_SUBDIR</td>
1.389     wiz      12637: <td>DJBDNS_AXFR_USER</td>
1.269     leot     12638: </tr>
                   12639: <tr>
1.386     wiz      12640: <td>DJBDNS_CACHE_USER</td>
1.389     wiz      12641: <td>DJBDNS_DJBDNS_GROUP</td>
1.269     leot     12642: </tr>
                   12643: <tr>
1.386     wiz      12644: <td>DJBDNS_LOG_USER</td>
1.389     wiz      12645: <td>DJBDNS_RBL_USER</td>
1.269     leot     12646: </tr>
                   12647: <tr>
1.386     wiz      12648: <td>DJBDNS_TINY_USER</td>
1.389     wiz      12649: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269     leot     12650: </tr>
                   12651: <tr>
1.386     wiz      12652: <td>DL_AUTO_VARS</td>
1.389     wiz      12653: <td>DL_CFLAGS</td>
1.269     leot     12654: </tr>
                   12655: <tr>
1.386     wiz      12656: <td>DL_LDFLAGS</td>
1.389     wiz      12657: <td>DL_LIBS</td>
1.269     leot     12658: </tr>
                   12659: <tr>
1.386     wiz      12660: <td>DNS</td>
1.389     wiz      12661: <td>DOCOWN</td>
1.269     leot     12662: </tr>
                   12663: <tr>
1.386     wiz      12664: <td>DOWNLOADED_DISTFILE</td>
1.389     wiz      12665: <td>DQCACHE_GROUP</td>
1.269     leot     12666: </tr>
                   12667: <tr>
1.386     wiz      12668: <td>DQCACHE_USER</td>
1.389     wiz      12669: <td>DT_LAYOUT</td>
1.269     leot     12670: </tr>
                   12671: <tr>
1.386     wiz      12672: <td>DYNAMIC_SITES_CMD</td>
1.389     wiz      12673: <td>DYNAMIC_SITES_SCRIPT</td>
1.269     leot     12674: </tr>
                   12675: <tr>
1.386     wiz      12676: <td>ECHO</td>
1.389     wiz      12677: <td>ECHO_N</td>
1.269     leot     12678: </tr>
                   12679: <tr>
1.386     wiz      12680: <td>ELK_GUI</td>
1.389     wiz      12681: <td>EMACS_TYPE</td>
1.269     leot     12682: </tr>
                   12683: <tr>
1.386     wiz      12684: <td>EMULDIR</td>
1.389     wiz      12685: <td>EMULSUBDIR</td>
1.269     leot     12686: </tr>
                   12687: <tr>
1.386     wiz      12688: <td>EMULSUBDIRSLASH</td>
1.389     wiz      12689: <td>EMUL_ARCH</td>
1.269     leot     12690: </tr>
                   12691: <tr>
1.386     wiz      12692: <td>EMUL_DISTRO</td>
1.389     wiz      12693: <td>EMUL_EXEC_FMT</td>
1.269     leot     12694: </tr>
                   12695: <tr>
1.386     wiz      12696: <td>EMUL_IS_NATIVE</td>
1.389     wiz      12697: <td>EMUL_MODULES</td>
1.269     leot     12698: </tr>
                   12699: <tr>
1.386     wiz      12700: <td>EMUL_OPSYS</td>
1.389     wiz      12701: <td>EMUL_PKG_FMT</td>
1.357     gutterid 12702: </tr>
                   12703: <tr>
1.386     wiz      12704: <td>EMUL_PLATFORM</td>
1.389     wiz      12705: <td>EMUL_PLATFORMS</td>
1.333     nia      12706: </tr>
                   12707: <tr>
1.386     wiz      12708: <td>EMUL_PREFER</td>
1.389     wiz      12709: <td>EMUL_REQD</td>
1.269     leot     12710: </tr>
                   12711: <tr>
1.386     wiz      12712: <td>EMUL_TYPE</td>
1.389     wiz      12713: <td>ERROR_MSG</td>
1.269     leot     12714: </tr>
                   12715: <tr>
1.386     wiz      12716: <td>EXIM_GROUP</td>
1.389     wiz      12717: <td>EXIM_USER</td>
1.269     leot     12718: </tr>
                   12719: <tr>
1.386     wiz      12720: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.389     wiz      12721: <td>EXTRACTOR</td>
1.269     leot     12722: </tr>
                   12723: <tr>
1.386     wiz      12724: <td>EXTRACT_CMD</td>
1.389     wiz      12725: <td>EXTRACT_CMD_DEFAULT</td>
1.269     leot     12726: </tr>
                   12727: <tr>
1.386     wiz      12728: <td>EXTRACT_DIR</td>
1.389     wiz      12729: <td>EXTRACT_ELEMENTS</td>
1.269     leot     12730: </tr>
                   12731: <tr>
1.386     wiz      12732: <td>EXTRACT_ENV</td>
1.389     wiz      12733: <td>EXTRACT_ONLY</td>
1.269     leot     12734: </tr>
                   12735: <tr>
1.386     wiz      12736: <td>EXTRACT_OPTS</td>
1.389     wiz      12737: <td>EXTRACT_SUFX</td>
1.269     leot     12738: </tr>
                   12739: <tr>
1.386     wiz      12740: <td>EXTRACT_USING</td>
1.389     wiz      12741: <td>FAIL</td>
1.269     leot     12742: </tr>
                   12743: <tr>
1.386     wiz      12744: <td>FAILOVER_FETCH</td>
1.389     wiz      12745: <td>FAIL_MSG</td>
1.269     leot     12746: </tr>
                   12747: <tr>
1.386     wiz      12748: <td>FAKE_NCURSES</td>
1.389     wiz      12749: <td>FAM</td>
1.269     leot     12750: </tr>
                   12751: <tr>
1.386     wiz      12752: <td>FAM_ACCEPTED</td>
1.389     wiz      12753: <td>FAM_DEFAULT</td>
1.269     leot     12754: </tr>
                   12755: <tr>
1.386     wiz      12756: <td>FAM_SERVER</td>
1.389     wiz      12757: <td>FCPATH</td>
1.269     leot     12758: </tr>
                   12759: <tr>
1.386     wiz      12760: <td>FETCH_AFTER_ARGS</td>
1.389     wiz      12761: <td>FETCH_BEFORE_ARGS</td>
1.338     nia      12762: </tr>
                   12763: <tr>
1.386     wiz      12764: <td>FETCH_CMD</td>
1.389     wiz      12765: <td>FETCH_INSECURE</td>
1.269     leot     12766: </tr>
                   12767: <tr>
1.381     dholland 12768: <td>FETCH_OUTPUT_ARGS</td>
1.389     wiz      12769: <td>FETCH_PROXY</td>
1.269     leot     12770: </tr>
                   12771: <tr>
1.381     dholland 12772: <td>FETCH_RESUME_ARGS</td>
1.389     wiz      12773: <td>FETCH_TIMEOUT</td>
1.269     leot     12774: </tr>
                   12775: <tr>
1.381     dholland 12776: <td>FETCH_USE_IPV4_ONLY</td>
1.389     wiz      12777: <td>FETCH_USING</td>
1.269     leot     12778: </tr>
                   12779: <tr>
1.381     dholland 12780: <td>FILES_SUBST</td>
1.389     wiz      12781: <td>FILES_SUBST_SED</td>
1.269     leot     12782: </tr>
                   12783: <tr>
1.378     leot     12784: <td>FIX_SYSTEM_HEADERS</td>
1.389     wiz      12785: <td>FONTDIR</td>
1.269     leot     12786: </tr>
                   12787: <tr>
1.377     jnemeth  12788: <td>FONTS_DIRS</td>
1.389     wiz      12789: <td>FONTS_VERBOSE</td>
1.382     wiz      12790: </tr>
                   12791: <tr>
                   12792: <td>FOO_HACKS_MK</td>
1.389     wiz      12793: <td>FORCE_CXX_STD</td>
1.269     leot     12794: </tr>
                   12795: <tr>
1.382     wiz      12796: <td>FORCE_C_STD</td>
1.389     wiz      12797: <td>FOSSIL_EXTRACTDIR</td>
1.382     wiz      12798: </tr>
                   12799: <tr>
                   12800: <td>FOSSIL_REPO</td>
1.389     wiz      12801: <td>FOSSIL_REPOSITORIES</td>
1.382     wiz      12802: </tr>
                   12803: <tr>
                   12804: <td>FOSSIL_VERSION</td>
1.389     wiz      12805: <td>FOX_USE_XUNICODE</td>
1.292     leot     12806: </tr>
                   12807: <tr>
1.382     wiz      12808: <td>FREEWNN_GROUP</td>
1.389     wiz      12809: <td>FREEWNN_USER</td>
1.378     leot     12810: </tr>
                   12811: <tr>
1.382     wiz      12812: <td>FTP_PKG_URL_DIR</td>
1.389     wiz      12813: <td>FTP_PKG_URL_HOST</td>
1.269     leot     12814: </tr>
                   12815: <tr>
1.382     wiz      12816: <td>GAMEDATAMODE</td>
1.389     wiz      12817: <td>GAMEDATA_PERMS</td>
1.269     leot     12818: </tr>
                   12819: <tr>
1.382     wiz      12820: <td>GAMEDIRMODE</td>
1.389     wiz      12821: <td>GAMEDIR_PERMS</td>
1.269     leot     12822: </tr>
                   12823: <tr>
1.382     wiz      12824: <td>GAMEGRP</td>
1.389     wiz      12825: <td>GAMEMODE</td>
1.269     leot     12826: </tr>
                   12827: <tr>
1.382     wiz      12828: <td>GAMEOWN</td>
1.389     wiz      12829: <td>GAMES_GROUP</td>
1.269     leot     12830: </tr>
                   12831: <tr>
1.382     wiz      12832: <td>GAMES_USER</td>
1.389     wiz      12833: <td>GCC</td>
1.269     leot     12834: </tr>
                   12835: <tr>
1.382     wiz      12836: <td>GCCBASE</td>
1.389     wiz      12837: <td>GCC_REQD</td>
1.269     leot     12838: </tr>
                   12839: <tr>
1.382     wiz      12840: <td>GCC_VERSION_SUFFIX</td>
1.389     wiz      12841: <td>GEM_BUILD</td>
1.269     leot     12842: </tr>
                   12843: <tr>
1.382     wiz      12844: <td>GEM_CLEANBUILD</td>
1.389     wiz      12845: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.269     leot     12846: </tr>
                   12847: <tr>
1.382     wiz      12848: <td>GEM_DOCDIR</td>
1.389     wiz      12849: <td>GEM_EXTSDIR</td>
1.269     leot     12850: </tr>
                   12851: <tr>
1.382     wiz      12852: <td>GEM_HOME</td>
1.389     wiz      12853: <td>GEM_KEEPBUILD</td>
1.269     leot     12854: </tr>
                   12855: <tr>
1.382     wiz      12856: <td>GEM_LIBDIR</td>
1.389     wiz      12857: <td>GEM_NAME</td>
1.374     wiz      12858: </tr>
                   12859: <tr>
1.382     wiz      12860: <td>GEM_PATH</td>
1.389     wiz      12861: <td>GEM_PLUGINSDIR</td>
1.292     leot     12862: </tr>
                   12863: <tr>
1.382     wiz      12864: <td>GEM_SPECFILE</td>
1.389     wiz      12865: <td>GENERATE_PLIST</td>
1.269     leot     12866: </tr>
                   12867: <tr>
1.382     wiz      12868: <td>GHC</td>
1.389     wiz      12869: <td>GHOSTSCRIPT_REQD</td>
1.269     leot     12870: </tr>
                   12871: <tr>
1.382     wiz      12872: <td>GITHUB_PROJECT</td>
1.389     wiz      12873: <td>GITHUB_RELEASE</td>
1.269     leot     12874: </tr>
                   12875: <tr>
1.382     wiz      12876: <td>GITHUB_SUBMODULES</td>
1.389     wiz      12877: <td>GITHUB_TAG</td>
1.269     leot     12878: </tr>
                   12879: <tr>
1.382     wiz      12880: <td>GITHUB_TYPE</td>
1.389     wiz      12881: <td>GITLAB_PROJECT</td>
1.292     leot     12882: </tr>
                   12883: <tr>
1.382     wiz      12884: <td>GITLAB_RELEASE</td>
1.389     wiz      12885: <td>GITLAB_SUBMODULES</td>
1.311     leot     12886: </tr>
                   12887: <tr>
1.382     wiz      12888: <td>GITLAB_TAG</td>
1.389     wiz      12889: <td>GITLAB_TYPE</td>
1.269     leot     12890: </tr>
                   12891: <tr>
1.382     wiz      12892: <td>GIT_BRANCH</td>
1.389     wiz      12893: <td>GIT_ENV</td>
1.382     wiz      12894: </tr>
                   12895: <tr>
                   12896: <td>GIT_EXTRACTDIR</td>
1.389     wiz      12897: <td>GIT_REPO</td>
1.382     wiz      12898: </tr>
                   12899: <tr>
                   12900: <td>GIT_REPOSITORIES</td>
1.389     wiz      12901: <td>GIT_REVISION</td>
1.382     wiz      12902: </tr>
                   12903: <tr>
                   12904: <td>GIT_TAG</td>
1.389     wiz      12905: <td>GNAT</td>
1.338     nia      12906: </tr>
                   12907: <tr>
1.379     wiz      12908: <td>GNU</td>
1.389     wiz      12909: <td>GNU_CONFIGURE</td>
1.378     leot     12910: </tr>
                   12911: <tr>
1.379     wiz      12912: <td>GNU_CONFIGURE_ICONV</td>
1.389     wiz      12913: <td>GNU_CONFIGURE_INFODIR</td>
1.376     wiz      12914: </tr>
                   12915: <tr>
1.379     wiz      12916: <td>GNU_CONFIGURE_MANDIR</td>
1.389     wiz      12917: <td>GNU_CONFIGURE_QUIET</td>
1.369     wiz      12918: </tr>
                   12919: <tr>
1.379     wiz      12920: <td>GNU_CONFIGURE_STRICT</td>
1.391   ! wiz      12921: <td>GOFLAGS</td>
        !          12922: </tr>
        !          12923: <tr>
1.389     wiz      12924: <td>GO_BUILD_PATTERN</td>
1.391   ! wiz      12925: <td>GO_DIST_BASE</td>
1.360     leot     12926: </tr>
                   12927: <tr>
1.389     wiz      12928: <td>GO_EXTRA_MOD_DIRS</td>
1.391   ! wiz      12929: <td>GO_MODULE_EXTRACT</td>
1.355     rillig   12930: </tr>
                   12931: <tr>
1.389     wiz      12932: <td>GO_MODULE_FILES</td>
1.391   ! wiz      12933: <td>GO_SRCPATH</td>
1.348     wiz      12934: </tr>
                   12935: <tr>
1.389     wiz      12936: <td>GROUP_SPECIFIC_PKGS</td>
1.391   ! wiz      12937: <td>GRUB_NETWORK_CARDS</td>
1.269     leot     12938: </tr>
                   12939: <tr>
1.389     wiz      12940: <td>GRUB_PRESET_COMMAND</td>
1.391   ! wiz      12941: <td>GRUB_SCAN_ARGS</td>
1.269     leot     12942: </tr>
                   12943: <tr>
1.389     wiz      12944: <td>GZIP</td>
1.391   ! wiz      12945: <td>HASKELL_COMPILER</td>
1.352     wiz      12946: </tr>
                   12947: <tr>
1.389     wiz      12948: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.391   ! wiz      12949: <td>HASKELL_DISABLE_LIBRARIES</td>
1.382     wiz      12950: </tr>
                   12951: <tr>
1.389     wiz      12952: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.391   ! wiz      12953: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.276     leot     12954: </tr>
                   12955: <tr>
1.389     wiz      12956: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.391   ! wiz      12957: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269     leot     12958: </tr>
                   12959: <tr>
1.389     wiz      12960: <td>HASKELL_ENABLE_TESTS</td>
1.391   ! wiz      12961: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.332     rillig   12962: </tr>
                   12963: <tr>
1.389     wiz      12964: <td>HASKELL_PKG_NAME</td>
1.391   ! wiz      12965: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.341     gutterid 12966: </tr>
                   12967: <tr>
1.389     wiz      12968: <td>HEADER_TEMPLATES</td>
1.391   ! wiz      12969: <td>HG_REPO</td>
1.382     wiz      12970: </tr>
                   12971: <tr>
1.389     wiz      12972: <td>HG_REPOSITORIES</td>
1.391   ! wiz      12973: <td>HG_TAG</td>
1.335     nia      12974: </tr>
                   12975: <tr>
1.389     wiz      12976: <td>HOMEPAGE</td>
1.391   ! wiz      12977: <td>HOST_PKGTOOLS_ARGS</td>
1.378     leot     12978: </tr>
                   12979: <tr>
1.389     wiz      12980: <td>HOST_SPECIFIC_PKGS</td>
1.391   ! wiz      12981: <td>HOWL_GROUP</td>
1.378     leot     12982: </tr>
                   12983: <tr>
1.389     wiz      12984: <td>HOWL_USER</td>
1.391   ! wiz      12985: <td>ICCBASE</td>
1.329     leot     12986: </tr>
                   12987: <tr>
1.389     wiz      12988: <td>ICECAST_CHROOTDIR</td>
1.391   ! wiz      12989: <td>ICON_THEMES</td>
1.360     leot     12990: </tr>
                   12991: <tr>
1.389     wiz      12992: <td>IDOBASE</td>
1.391   ! wiz      12993: <td>IGNORE_CCACHE</td>
1.355     rillig   12994: </tr>
                   12995: <tr>
1.389     wiz      12996: <td>IGNORE_INFO_DIRS</td>
1.391   ! wiz      12997: <td>IGNORE_INTERACTIVE_FETCH</td>
1.348     wiz      12998: </tr>
                   12999: <tr>
1.389     wiz      13000: <td>IMAKE</td>
1.391   ! wiz      13001: <td>IMAKEOPTS</td>
1.342     wiz      13002: </tr>
                   13003: <tr>
1.389     wiz      13004: <td>IMAKE_MAKE</td>
1.391   ! wiz      13005: <td>IMAKE_MANINSTALL</td>
1.338     nia      13006: </tr>
                   13007: <tr>
1.389     wiz      13008: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.391   ! wiz      13009: <td>IMDICTDIR</td>
1.269     leot     13010: </tr>
                   13011: <tr>
1.389     wiz      13012: <td>INCOMPAT_CURSES</td>
1.391   ! wiz      13013: <td>INFO_DIR</td>
1.305     bacon    13014: </tr>
                   13015: <tr>
1.389     wiz      13016: <td>INFO_FILES</td>
1.391   ! wiz      13017: <td>INFO_MSG</td>
1.269     leot     13018: </tr>
                   13019: <tr>
1.389     wiz      13020: <td>INIT_SYSTEM</td>
1.391   ! wiz      13021: <td>INN_DATA_DIR</td>
1.269     leot     13022: </tr>
                   13023: <tr>
1.389     wiz      13024: <td>INN_GROUP</td>
1.391   ! wiz      13025: <td>INN_USER</td>
1.269     leot     13026: </tr>
                   13027: <tr>
1.389     wiz      13028: <td>INSTALLATION_DIRS</td>
1.391   ! wiz      13029: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269     leot     13030: </tr>
                   13031: <tr>
1.389     wiz      13032: <td>INSTALL_ENV</td>
1.391   ! wiz      13033: <td>INSTALL_ENV_SHELL</td>
1.269     leot     13034: </tr>
                   13035: <tr>
1.389     wiz      13036: <td>INSTALL_SH_OVERRIDE</td>
1.391   ! wiz      13037: <td>INSTALL_SRC</td>
1.269     leot     13038: </tr>
                   13039: <tr>
1.389     wiz      13040: <td>INSTALL_TEMPLATES</td>
1.391   ! wiz      13041: <td>INSTALL_UNSTRIPPED</td>
1.269     leot     13042: </tr>
                   13043: <tr>
1.389     wiz      13044: <td>IRCD_HYBRID_IRC_GROUP</td>
1.391   ! wiz      13045: <td>IRCD_HYBRID_IRC_USER</td>
1.269     leot     13046: </tr>
                   13047: <tr>
1.389     wiz      13048: <td>IRCD_HYBRID_MAXCONN</td>
1.391   ! wiz      13049: <td>IRCD_HYBRID_NICLEN</td>
1.369     wiz      13050: </tr>
                   13051: <tr>
1.389     wiz      13052: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.391   ! wiz      13053: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.287     rillig   13054: </tr>
                   13055: <tr>
1.389     wiz      13056: <td>IRCD_HYBRID_TOPICLEN</td>
1.391   ! wiz      13057: <td>IRIX</td>
1.269     leot     13058: </tr>
                   13059: <tr>
1.389     wiz      13060: <td>IRRD_USE_PGP</td>
1.391   ! wiz      13061: <td>JABBERD_GROUP</td>
1.269     leot     13062: </tr>
                   13063: <tr>
1.389     wiz      13064: <td>JABBERD_LOGDIR</td>
1.391   ! wiz      13065: <td>JABBERD_PIDDIR</td>
1.269     leot     13066: </tr>
                   13067: <tr>
1.389     wiz      13068: <td>JABBERD_SPOOLDIR</td>
1.391   ! wiz      13069: <td>JABBERD_USER</td>
1.269     leot     13070: </tr>
                   13071: <tr>
1.389     wiz      13072: <td>JAVA_APP_PATH</td>
1.391   ! wiz      13073: <td>JAVA_APP_TARGETS</td>
1.382     wiz      13074: </tr>
                   13075: <tr>
1.389     wiz      13076: <td>JAVA_BINPREFIX</td>
1.391   ! wiz      13077: <td>JAVA_CLASSPATH</td>
1.378     leot     13078: </tr>
                   13079: <tr>
1.389     wiz      13080: <td>JAVA_HOME</td>
1.391   ! wiz      13081: <td>JAVA_LD_LIBRARY_PATH</td>
1.376     wiz      13082: </tr>
                   13083: <tr>
1.389     wiz      13084: <td>JAVA_NAME</td>
1.391   ! wiz      13085: <td>JAVA_UNLIMIT</td>
1.367     gdt      13086: </tr>
                   13087: <tr>
1.389     wiz      13088: <td>JAVA_WRAPPERS</td>
1.391   ! wiz      13089: <td>JPEG_ACCEPTED</td>
1.360     leot     13090: </tr>
                   13091: <tr>
1.389     wiz      13092: <td>JPEG_DEFAULT</td>
1.391   ! wiz      13093: <td>KERBEROS</td>
1.269     leot     13094: </tr>
                   13095: <tr>
1.389     wiz      13096: <td>KERMIT_SUID_UUCP</td>
1.391   ! wiz      13097: <td>KJS_USE_PCRE</td>
1.348     wiz      13098: </tr>
                   13099: <tr>
1.389     wiz      13100: <td>KNEWS_DOMAIN_FILE</td>
1.391   ! wiz      13101: <td>KNEWS_DOMAIN_NAME</td>
1.292     leot     13102: </tr>
                   13103: <tr>
1.389     wiz      13104: <td>KRB5_ACCEPTED</td>
1.391   ! wiz      13105: <td>KRB5_DEFAULT</td>
1.342     wiz      13106: </tr>
                   13107: <tr>
1.389     wiz      13108: <td>LANGUAGES</td>
1.391   ! wiz      13109: <td>LAPACKE_LIBS</td>
1.311     leot     13110: </tr>
                   13111: <tr>
1.389     wiz      13112: <td>LAPACKE_PC</td>
1.391   ! wiz      13113: <td>LAPACK_LIBS</td>
1.269     leot     13114: </tr>
                   13115: <tr>
1.389     wiz      13116: <td>LAPACK_PC</td>
1.391   ! wiz      13117: <td>LATEX2HTML_ICONPATH</td>
1.332     rillig   13118: </tr>
                   13119: <tr>
1.389     wiz      13120: <td>LDCONFIG_ADD_CMD</td>
1.391   ! wiz      13121: <td>LDCONFIG_REMOVE_CMD</td>
1.269     leot     13122: </tr>
                   13123: <tr>
1.389     wiz      13124: <td>LDD</td>
1.391   ! wiz      13125: <td>LEAFNODE_DATA_DIR</td>
1.269     leot     13126: </tr>
                   13127: <tr>
1.389     wiz      13128: <td>LEAFNODE_GROUP</td>
1.391   ! wiz      13129: <td>LEAFNODE_USER</td>
1.269     leot     13130: </tr>
                   13131: <tr>
1.389     wiz      13132: <td>LIBDVDCSS_HOMEPAGE</td>
1.391   ! wiz      13133: <td>LIBDVDCSS_MASTER_SITES</td>
1.269     leot     13134: </tr>
                   13135: <tr>
1.389     wiz      13136: <td>LIBIMAGEQUANT_TYPE</td>
1.391   ! wiz      13137: <td>LIBRSVG_TYPE</td>
1.292     leot     13138: </tr>
                   13139: <tr>
1.389     wiz      13140: <td>LIBTOOL</td>
1.391   ! wiz      13141: <td>LIBTOOLIZE_PLIST</td>
1.271     brook    13142: </tr>
                   13143: <tr>
1.389     wiz      13144: <td>LIBTOOL_M4_OVERRIDE</td>
1.391   ! wiz      13145: <td>LIBUSB_TYPE</td>
1.269     leot     13146: </tr>
                   13147: <tr>
1.389     wiz      13148: <td>LICENSE</td>
1.391   ! wiz      13149: <td>LINKER_RPATH_FLAG</td>
1.269     leot     13150: </tr>
                   13151: <tr>
1.389     wiz      13152: <td>LINK_RPATH_FLAG</td>
1.391   ! wiz      13153: <td>LINUX_BASE_NODEPS</td>
1.369     wiz      13154: </tr>
                   13155: <tr>
1.389     wiz      13156: <td>LINUX_BASE_PREFERRED</td>
1.391   ! wiz      13157: <td>LINUX_BASE_REQUIRED</td>
1.382     wiz      13158: </tr>
                   13159: <tr>
1.389     wiz      13160: <td>LINUX_LOCALES</td>
1.391   ! wiz      13161: <td>LOCALBASE</td>
1.355     rillig   13162: </tr>
                   13163: <tr>
1.389     wiz      13164: <td>LOCALBASE_LOCKTYPE</td>
1.391   ! wiz      13165: <td>LOCALPATCHES</td>
1.269     leot     13166: </tr>
                   13167: <tr>
1.389     wiz      13168: <td>LOVE_DATA</td>
1.391   ! wiz      13169: <td>LOVE_GAME</td>
1.352     wiz      13170: </tr>
                   13171: <tr>
1.389     wiz      13172: <td>LOVE_VERSION</td>
1.391   ! wiz      13173: <td>LOWER_OPSYS</td>
1.338     nia      13174: </tr>
                   13175: <tr>
1.389     wiz      13176: <td>LOWER_OPSYS_VERSUFFIX</td>
1.391   ! wiz      13177: <td>LOWER_VARIANT_VERSION</td>
1.370     gdt      13178: </tr>
                   13179: <tr>
1.389     wiz      13180: <td>LOWER_VENDOR</td>
1.391   ! wiz      13181: <td>LP32PLATFORMS</td>
1.370     gdt      13182: </tr>
                   13183: <tr>
1.389     wiz      13184: <td>LP64PLATFORMS</td>
1.391   ! wiz      13185: <td>LUA_BUSTED_ARGS</td>
1.269     leot     13186: </tr>
                   13187: <tr>
1.389     wiz      13188: <td>LUA_CDIR</td>
1.391   ! wiz      13189: <td>LUA_COMPILER</td>
1.329     leot     13190: </tr>
                   13191: <tr>
1.389     wiz      13192: <td>LUA_DOCDIR</td>
1.391   ! wiz      13193: <td>LUA_EXAMPLESDIR</td>
1.269     leot     13194: </tr>
                   13195: <tr>
1.389     wiz      13196: <td>LUA_INCDIR</td>
1.391   ! wiz      13197: <td>LUA_INTERPRETER</td>
1.269     leot     13198: </tr>
                   13199: <tr>
1.389     wiz      13200: <td>LUA_LDIR</td>
1.391   ! wiz      13201: <td>LUA_LINKER_MAGIC</td>
1.269     leot     13202: </tr>
                   13203: <tr>
1.389     wiz      13204: <td>LUA_PKGPREFIX</td>
1.391   ! wiz      13205: <td>LUA_SELF_CONFLICT</td>
1.336     nia      13206: </tr>
                   13207: <tr>
1.389     wiz      13208: <td>LUA_USE_BUSTED</td>
1.391   ! wiz      13209: <td>LUA_VERSIONS_ACCEPTED</td>
1.333     nia      13210: </tr>
                   13211: <tr>
1.389     wiz      13212: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.391   ! wiz      13213: <td>LUA_VERSION_DEFAULT</td>
1.382     wiz      13214: </tr>
                   13215: <tr>
1.389     wiz      13216: <td>LUA_VERSION_REQD</td>
1.391   ! wiz      13217: <td>Lua</td>
1.333     nia      13218: </tr>
                   13219: <tr>
1.389     wiz      13220: <td>MACHINE_PLATFORM</td>
1.391   ! wiz      13221: <td>MAILAGENT_DOMAIN</td>
1.333     nia      13222: </tr>
                   13223: <tr>
1.389     wiz      13224: <td>MAILAGENT_EMAIL</td>
1.391   ! wiz      13225: <td>MAILAGENT_FQDN</td>
1.333     nia      13226: </tr>
                   13227: <tr>
1.389     wiz      13228: <td>MAILAGENT_ORGANIZATION</td>
1.391   ! wiz      13229: <td>MAJORDOMO_HOMEDIR</td>
1.333     nia      13230: </tr>
                   13231: <tr>
1.389     wiz      13232: <td>MAJOR_OS_VERSION</td>
1.391   ! wiz      13233: <td>MAKEINFO_ARGS</td>
1.376     wiz      13234: </tr>
                   13235: <tr>
1.389     wiz      13236: <td>MAKE_DIRS</td>
1.391   ! wiz      13237: <td>MAKE_DIRS_PERMS</td>
1.378     leot     13238: </tr>
                   13239: <tr>
1.389     wiz      13240: <td>MAKE_ENV</td>
1.391   ! wiz      13241: <td>MAKE_FILE</td>
1.367     gdt      13242: </tr>
                   13243: <tr>
1.389     wiz      13244: <td>MAKE_FLAGS</td>
1.391   ! wiz      13245: <td>MAKE_JOBS</td>
1.360     leot     13246: </tr>
                   13247: <tr>
1.389     wiz      13248: <td>MAKE_JOBS_SAFE</td>
1.391   ! wiz      13249: <td>MAKE_PROGRAM</td>
1.320     wiz      13250: </tr>
                   13251: <tr>
1.389     wiz      13252: <td>MANCOMPRESSED_IF_MANZ</td>
1.391   ! wiz      13253: <td>MANINSTALL</td>
1.348     wiz      13254: </tr>
                   13255: <tr>
1.389     wiz      13256: <td>MANZ</td>
1.391   ! wiz      13257: <td>MARIADB_VERSIONS_ALL</td>
1.342     wiz      13258: </tr>
                   13259: <tr>
1.389     wiz      13260: <td>MASTER_SITES</td>
1.391   ! wiz      13261: <td>MASTER_SITE_BACKUP</td>
1.269     leot     13262: </tr>
                   13263: <tr>
1.389     wiz      13264: <td>MASTER_SITE_LOCAL</td>
1.391   ! wiz      13265: <td>MASTER_SITE_MOZILLA</td>
1.327     wiz      13266: </tr>
                   13267: <tr>
1.389     wiz      13268: <td>MASTER_SITE_OVERRIDE</td>
1.391   ! wiz      13269: <td>MASTER_SITE_PERL_CPAN</td>
1.269     leot     13270: </tr>
                   13271: <tr>
1.389     wiz      13272: <td>MASTER_SORT</td>
1.391   ! wiz      13273: <td>MASTER_SORT_RANDOM</td>
1.269     leot     13274: </tr>
                   13275: <tr>
1.389     wiz      13276: <td>MASTER_SORT_REGEX</td>
1.391   ! wiz      13277: <td>MECAB_CHARSET</td>
1.269     leot     13278: </tr>
                   13279: <tr>
1.389     wiz      13280: <td>MEDIATOMB_GROUP</td>
1.391   ! wiz      13281: <td>MEDIATOMB_USER</td>
1.303     bacon    13282: </tr>
                   13283: <tr>
1.389     wiz      13284: <td>MIPSPROBASE</td>
1.391   ! wiz      13285: <td>MIREDO_GROUP</td>
1.269     leot     13286: </tr>
                   13287: <tr>
1.389     wiz      13288: <td>MIREDO_USER</td>
1.391   ! wiz      13289: <td>MISSING_FEATURES</td>
1.269     leot     13290: </tr>
                   13291: <tr>
1.389     wiz      13292: <td>MKDIR</td>
1.391   ! wiz      13293: <td>MKPIE_SUPPORTED</td>
1.269     leot     13294: </tr>
                   13295: <tr>
1.389     wiz      13296: <td>MLDONKEY_GROUP</td>
1.391   ! wiz      13297: <td>MLDONKEY_HOME</td>
1.269     leot     13298: </tr>
                   13299: <tr>
1.389     wiz      13300: <td>MLDONKEY_USER</td>
1.391   ! wiz      13301: <td>MONOTONE_GROUP</td>
1.269     leot     13302: </tr>
                   13303: <tr>
1.389     wiz      13304: <td>MONOTONE_USER</td>
1.391   ! wiz      13305: <td>MOTIFBASE</td>
1.269     leot     13306: </tr>
                   13307: <tr>
1.389     wiz      13308: <td>MOTIF_TYPE</td>
1.391   ! wiz      13309: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     13310: </tr>
                   13311: <tr>
1.389     wiz      13312: <td>MPI_TYPE</td>
1.391   ! wiz      13313: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     13314: </tr>
                   13315: <tr>
1.389     wiz      13316: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.391   ! wiz      13317: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     13318: </tr>
                   13319: <tr>
1.389     wiz      13320: <td>MUST</td>
1.391   ! wiz      13321: <td>MV</td>
1.382     wiz      13322: </tr>
                   13323: <tr>
1.389     wiz      13324: <td>MYSQL_CHARSET</td>
1.391   ! wiz      13325: <td>MYSQL_DATADIR</td>
1.355     rillig   13326: </tr>
                   13327: <tr>
1.389     wiz      13328: <td>MYSQL_EXTRA_CHARSET</td>
1.391   ! wiz      13329: <td>MYSQL_GROUP</td>
1.269     leot     13330: </tr>
                   13331: <tr>
1.389     wiz      13332: <td>MYSQL_USER</td>
1.391   ! wiz      13333: <td>MYSQL_VERSION</td>
1.352     wiz      13334: </tr>
                   13335: <tr>
1.389     wiz      13336: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.391   ! wiz      13337: <td>MYSQL_VERSION_DEFAULT</td>
1.338     nia      13338: </tr>
                   13339: <tr>
1.389     wiz      13340: <td>NAGIOSCMD_GROUP</td>
1.391   ! wiz      13341: <td>NAGIOSDIR</td>
1.329     leot     13342: </tr>
                   13343: <tr>
1.389     wiz      13344: <td>NAGIOS_GROUP</td>
1.391   ! wiz      13345: <td>NAGIOS_USER</td>
1.269     leot     13346: </tr>
                   13347: <tr>
1.389     wiz      13348: <td>NATIVE_EXEC_FMT</td>
1.391   ! wiz      13349: <td>NATIVE_LOWER_OPSYS</td>
1.320     wiz      13350: </tr>
                   13351: <tr>
1.389     wiz      13352: <td>NATIVE_LOWER_VENDOR</td>
1.391   ! wiz      13353: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     13354: </tr>
                   13355: <tr>
1.389     wiz      13356: <td>NATIVE_OBJECT_FMT</td>
1.391   ! wiz      13357: <td>NATIVE_OPSYS_VERSION</td>
1.269     leot     13358: </tr>
                   13359: <tr>
1.389     wiz      13360: <td>NATIVE_OS_VARIANT</td>
1.391   ! wiz      13361: <td>NATIVE_OS_VERSION</td>
1.269     leot     13362: </tr>
                   13363: <tr>
1.389     wiz      13364: <td>NBPAX_PROGRAM_PREFIX</td>
1.391   ! wiz      13365: <td>NETBSD_LOGIN_NAME</td>
1.370     gdt      13366: </tr>
                   13367: <tr>
1.389     wiz      13368: <td>NMH_EDITOR</td>
1.391   ! wiz      13369: <td>NMH_MTA</td>
1.370     gdt      13370: </tr>
                   13371: <tr>
1.389     wiz      13372: <td>NMH_PAGER</td>
1.391   ! wiz      13373: <td>NODE_VERSIONS_ACCEPTED</td>
1.309     gutterid 13374: </tr>
                   13375: <tr>
1.389     wiz      13376: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.391   ! wiz      13377: <td>NODE_VERSION_DEFAULT</td>
1.269     leot     13378: </tr>
                   13379: <tr>
1.389     wiz      13380: <td>NODE_VERSION_REQD</td>
1.391   ! wiz      13381: <td>NOLOGIN</td>
1.269     leot     13382: </tr>
                   13383: <tr>
1.389     wiz      13384: <td>NOTE</td>
1.391   ! wiz      13385: <td>NOT_FOR_PLATFORM</td>
1.269     leot     13386: </tr>
                   13387: <tr>
1.389     wiz      13388: <td>NOT_PAX_ASLR_SAFE</td>
1.391   ! wiz      13389: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269     leot     13390: </tr>
                   13391: <tr>
1.389     wiz      13392: <td>NO_BUILD</td>
1.391   ! wiz      13393: <td>NO_CHECKSUM</td>
1.269     leot     13394: </tr>
                   13395: <tr>
1.389     wiz      13396: <td>NO_CONFIGURE</td>
1.391   ! wiz      13397: <td>NO_SKIP</td>
1.269     leot     13398: </tr>
                   13399: <tr>
1.389     wiz      13400: <td>NSD_GROUP</td>
1.391   ! wiz      13401: <td>NSD_LOG_FACILITY</td>
1.344     gutterid 13402: </tr>
                   13403: <tr>
1.389     wiz      13404: <td>NSD_USER</td>
1.391   ! wiz      13405: <td>NS_PREFERRED</td>
1.379     wiz      13406: </tr>
                   13407: <tr>
1.389     wiz      13408: <td>NULLMAILER_GROUP</td>
1.391   ! wiz      13409: <td>NULLMAILER_USER</td>
1.333     nia      13410: </tr>
                   13411: <tr>
1.389     wiz      13412: <td>OBJECT_FMT</td>
1.391   ! wiz      13413: <td>OBJHOSTNAME</td>
1.333     nia      13414: </tr>
                   13415: <tr>
1.389     wiz      13416: <td>OBJMACHINE</td>
1.391   ! wiz      13417: <td>OCAML_FINDLIB_DIRS</td>
1.293     rillig   13418: </tr>
                   13419: <tr>
1.389     wiz      13420: <td>OCAML_FINDLIB_REGISTER</td>
1.391   ! wiz      13421: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269     leot     13422: </tr>
                   13423: <tr>
1.389     wiz      13424: <td>OCAML_SITELIBDIR</td>
1.391   ! wiz      13425: <td>OMF</td>
1.269     leot     13426: </tr>
                   13427: <tr>
1.389     wiz      13428: <td>ONLY_FOR_COMPILER</td>
1.391   ! wiz      13429: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     13430: </tr>
                   13431: <tr>
1.389     wiz      13432: <td>OPENSSH_CHROOT</td>
1.391   ! wiz      13433: <td>OPENSSH_GROUP</td>
1.269     leot     13434: </tr>
                   13435: <tr>
1.389     wiz      13436: <td>OPENSSH_USER</td>
1.391   ! wiz      13437: <td>OPSYS</td>
1.269     leot     13438: </tr>
                   13439: <tr>
1.389     wiz      13440: <td>OPSYS_EMULDIR</td>
1.391   ! wiz      13441: <td>OPSYS_VERSION</td>
1.269     leot     13442: </tr>
                   13443: <tr>
1.389     wiz      13444: <td>OS</td>
1.391   ! wiz      13445: <td>OSS_TYPE</td>
1.269     leot     13446: </tr>
                   13447: <tr>
1.389     wiz      13448: <td>OSX</td>
1.391   ! wiz      13449: <td>OSX_PATH_TO_M4</td>
1.269     leot     13450: </tr>
                   13451: <tr>
1.389     wiz      13452: <td>OSX_PATH_TO_YACC</td>
1.391   ! wiz      13453: <td>OS_HAVE_ALSA</td>
1.382     wiz      13454: </tr>
                   13455: <tr>
1.389     wiz      13456: <td>OS_HAVE_RCD</td>
1.391   ! wiz      13457: <td>OS_VARIANT</td>
1.376     wiz      13458: </tr>
                   13459: <tr>
1.389     wiz      13460: <td>OS_VERSION</td>
1.391   ! wiz      13461: <td>OTF_FONTS_DIR</td>
1.369     wiz      13462: </tr>
                   13463: <tr>
1.389     wiz      13464: <td>OVERRIDE_DIRDEPTH</td>
1.391   ! wiz      13465: <td>OVERRIDE_GEMSPEC</td>
1.352     wiz      13466: </tr>
                   13467: <tr>
1.389     wiz      13468: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.391   ! wiz      13469: <td>OVERRIDE_ROCKSPEC</td>
1.376     wiz      13470: </tr>
                   13471: <tr>
1.389     wiz      13472: <td>OWN_DIRS</td>
1.391   ! wiz      13473: <td>OWN_DIRS_PERMS</td>
1.378     leot     13474: </tr>
                   13475: <tr>
1.389     wiz      13476: <td>P4GROUP</td>
1.391   ! wiz      13477: <td>P4PORT</td>
1.367     gdt      13478: </tr>
                   13479: <tr>
1.389     wiz      13480: <td>P4ROOT</td>
1.391   ! wiz      13481: <td>P4USER</td>
1.360     leot     13482: </tr>
                   13483: <tr>
1.389     wiz      13484: <td>PACKAGES</td>
1.391   ! wiz      13485: <td>PALMOS_DEFAULT_SDK</td>
1.348     wiz      13486: </tr>
                   13487: <tr>
1.389     wiz      13488: <td>PAMBASE</td>
1.391   ! wiz      13489: <td>PAM_DEFAULT</td>
1.329     leot     13490: </tr>
                   13491: <tr>
1.389     wiz      13492: <td>PAPERSIZE</td>
1.391   ! wiz      13493: <td>PASSIVE_FETCH</td>
1.342     wiz      13494: </tr>
                   13495: <tr>
1.389     wiz      13496: <td>PATCHDIR</td>
1.391   ! wiz      13497: <td>PATCHFILES</td>
1.320     wiz      13498: </tr>
                   13499: <tr>
1.389     wiz      13500: <td>PATCH_ARGS</td>
1.391   ! wiz      13501: <td>PATCH_DEBUG</td>
1.269     leot     13502: </tr>
                   13503: <tr>
1.389     wiz      13504: <td>PATCH_DIST_ARGS</td>
1.391   ! wiz      13505: <td>PATCH_DIST_CAT</td>
1.269     leot     13506: </tr>
                   13507: <tr>
1.389     wiz      13508: <td>PATCH_DIST_STRIP</td>
1.391   ! wiz      13509: <td>PATCH_FUZZ_FACTOR</td>
1.269     leot     13510: </tr>
                   13511: <tr>
1.389     wiz      13512: <td>PATCH_STRIP</td>
1.391   ! wiz      13513: <td>PATH</td>
1.269     leot     13514: </tr>
                   13515: <tr>
1.389     wiz      13516: <td>PCCBASE</td>
1.391   ! wiz      13517: <td>PEAR</td>
1.378     leot     13518: </tr>
                   13519: <tr>
1.389     wiz      13520: <td>PEAR_CHANNEL</td>
1.391   ! wiz      13521: <td>PEAR_CHANNEL_ALIAS</td>
1.382     wiz      13522: </tr>
                   13523: <tr>
1.389     wiz      13524: <td>PEAR_CHANNEL_VERSION</td>
1.391   ! wiz      13525: <td>PEAR_CMD</td>
1.382     wiz      13526: </tr>
                   13527: <tr>
1.389     wiz      13528: <td>PEAR_LIB</td>
1.391   ! wiz      13529: <td>PEAR_PACKAGE_XML</td>
1.376     wiz      13530: </tr>
                   13531: <tr>
1.389     wiz      13532: <td>PEP-518</td>
1.391   ! wiz      13533: <td>PERL5</td>
1.342     wiz      13534: </tr>
                   13535: <tr>
1.389     wiz      13536: <td>PERL5_CONFIGURE</td>
1.391   ! wiz      13537: <td>PERL5_CONFIGURE_DIRS</td>
1.269     leot     13538: </tr>
                   13539: <tr>
1.389     wiz      13540: <td>PERL5_LDFLAGS</td>
1.391   ! wiz      13541: <td>PERL5_LICENSE</td>
1.332     rillig   13542: </tr>
                   13543: <tr>
1.389     wiz      13544: <td>PERL5_MODULE_TYPE</td>
1.391   ! wiz      13545: <td>PERL5_PACKLIST</td>
1.320     wiz      13546: </tr>
                   13547: <tr>
1.389     wiz      13548: <td>PERL5_PACKLIST_DIR</td>
1.391   ! wiz      13549: <td>PERL5_PERLBASE</td>
1.292     leot     13550: </tr>
                   13551: <tr>
1.389     wiz      13552: <td>PERL5_SITEBASE</td>
1.391   ! wiz      13553: <td>PERL5_USE_PACKLIST</td>
1.274     rillig   13554: </tr>
                   13555: <tr>
1.389     wiz      13556: <td>PERL5_VENDORBASE</td>
1.391   ! wiz      13557: <td>PFCTL</td>
1.274     rillig   13558: </tr>
                   13559: <tr>
1.389     wiz      13560: <td>PFVAR_H</td>
1.391   ! wiz      13561: <td>PF_VERSION</td>
1.269     leot     13562: </tr>
                   13563: <tr>
1.389     wiz      13564: <td>PGGROUP</td>
1.391   ! wiz      13565: <td>PGHOME</td>
1.269     leot     13566: </tr>
                   13567: <tr>
1.389     wiz      13568: <td>PGPKGSRCDIR</td>
1.391   ! wiz      13569: <td>PGSQL_TYPE</td>
1.269     leot     13570: </tr>
                   13571: <tr>
1.389     wiz      13572: <td>PGSQL_VERSION</td>
1.391   ! wiz      13573: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     13574: </tr>
                   13575: <tr>
1.389     wiz      13576: <td>PGSQL_VERSION_DEFAULT</td>
1.391   ! wiz      13577: <td>PGUSER</td>
1.269     leot     13578: </tr>
                   13579: <tr>
1.389     wiz      13580: <td>PG_LIB_EXT</td>
1.391   ! wiz      13581: <td>PHP</td>
1.269     leot     13582: </tr>
                   13583: <tr>
1.389     wiz      13584: <td>PHPCOMMON_MK</td>
1.391   ! wiz      13585: <td>PHPPKGSRCDIR</td>
1.379     wiz      13586: </tr>
                   13587: <tr>
1.389     wiz      13588: <td>PHP_BASE_VERS</td>
1.391   ! wiz      13589: <td>PHP_EGDIR</td>
1.269     leot     13590: </tr>
                   13591: <tr>
1.389     wiz      13592: <td>PHP_EXTENSION_DIR</td>
1.391   ! wiz      13593: <td>PHP_INCDIR</td>
1.269     leot     13594: </tr>
                   13595: <tr>
1.389     wiz      13596: <td>PHP_LIBDIR</td>
1.391   ! wiz      13597: <td>PHP_MAJOR_VERS</td>
1.379     wiz      13598: </tr>
                   13599: <tr>
1.389     wiz      13600: <td>PHP_MINIMUM_TEENY</td>
1.391   ! wiz      13601: <td>PHP_MINOR_VERS</td>
1.379     wiz      13602: </tr>
                   13603: <tr>
1.389     wiz      13604: <td>PHP_PKG_PREFIX</td>
1.391   ! wiz      13605: <td>PHP_SHAREDIR</td>
1.269     leot     13606: </tr>
                   13607: <tr>
1.389     wiz      13608: <td>PHP_VER</td>
1.391   ! wiz      13609: <td>PHP_VERSION</td>
1.269     leot     13610: </tr>
                   13611: <tr>
1.389     wiz      13612: <td>PHP_VERSIONS_ACCEPTED</td>
1.391   ! wiz      13613: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13614: </tr>
                   13615: <tr>
1.389     wiz      13616: <td>PHP_VERSION_DEFAULT</td>
1.391   ! wiz      13617: <td>PHP_VERSION_REQD</td>
1.269     leot     13618: </tr>
                   13619: <tr>
1.389     wiz      13620: <td>PILRC_USE_GTK</td>
1.391   ! wiz      13621: <td>PKGCONFIG_BASE</td>
1.269     leot     13622: </tr>
                   13623: <tr>
1.389     wiz      13624: <td>PKGCONFIG_FILE</td>
1.391   ! wiz      13625: <td>PKGCONFIG_OVERRIDE</td>
1.269     leot     13626: </tr>
                   13627: <tr>
1.389     wiz      13628: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.391   ! wiz      13629: <td>PKGDIR</td>
1.269     leot     13630: </tr>
                   13631: <tr>
1.389     wiz      13632: <td>PKGGNUDIR</td>
1.391   ! wiz      13633: <td>PKGINFODIR</td>
1.269     leot     13634: </tr>
                   13635: <tr>
1.389     wiz      13636: <td>PKGLOCALEDIR</td>
1.391   ! wiz      13637: <td>PKGMANDIR</td>
1.269     leot     13638: </tr>
                   13639: <tr>
1.389     wiz      13640: <td>PKGNAME</td>
1.391   ! wiz      13641: <td>PKGNAME_REQD</td>
1.269     leot     13642: </tr>
                   13643: <tr>
1.389     wiz      13644: <td>PKGPATH</td>
1.391   ! wiz      13645: <td>PKGREVISION</td>
1.269     leot     13646: </tr>
                   13647: <tr>
1.389     wiz      13648: <td>PKGSRC_BLAS_TYPES</td>
1.391   ! wiz      13649: <td>PKGSRC_CHANGES</td>
1.269     leot     13650: </tr>
                   13651: <tr>
1.389     wiz      13652: <td>PKGSRC_COMPILER</td>
1.391   ! wiz      13653: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269     leot     13654: </tr>
                   13655: <tr>
1.389     wiz      13656: <td>PKGSRC_LOCKTYPE</td>
1.391   ! wiz      13657: <td>PKGSRC_MAKE_ENV</td>
1.269     leot     13658: </tr>
                   13659: <tr>
1.389     wiz      13660: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.391   ! wiz      13661: <td>PKGSRC_MKPIE</td>
1.269     leot     13662: </tr>
                   13663: <tr>
1.389     wiz      13664: <td>PKGSRC_MKREPRO</td>
1.391   ! wiz      13665: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.269     leot     13666: </tr>
                   13667: <tr>
1.389     wiz      13668: <td>PKGSRC_RUN_TEST</td>
1.391   ! wiz      13669: <td>PKGSRC_SETENV</td>
1.292     leot     13670: </tr>
                   13671: <tr>
1.389     wiz      13672: <td>PKGSRC_SLEEPSECS</td>
1.391   ! wiz      13673: <td>PKGSRC_TODO</td>
1.269     leot     13674: </tr>
                   13675: <tr>
1.389     wiz      13676: <td>PKGSRC_USE_CTF</td>
1.391   ! wiz      13677: <td>PKGSRC_USE_FORTIFY</td>
1.274     rillig   13678: </tr>
                   13679: <tr>
1.389     wiz      13680: <td>PKGSRC_USE_MKTOOLS</td>
1.391   ! wiz      13681: <td>PKGSRC_USE_RELRO</td>
1.269     leot     13682: </tr>
                   13683: <tr>
1.389     wiz      13684: <td>PKGSRC_USE_SSP</td>
1.391   ! wiz      13685: <td>PKGSRC_USE_STACK_CHECK</td>
1.269     leot     13686: </tr>
                   13687: <tr>
1.389     wiz      13688: <td>PKGTASKS_DATAFILE</td>
1.391   ! wiz      13689: <td>PKGTOOLS_ARGS</td>
1.269     leot     13690: </tr>
                   13691: <tr>
1.389     wiz      13692: <td>PKGTOOLS_ENV</td>
1.391   ! wiz      13693: <td>PKG_ALTERNATIVES</td>
1.269     leot     13694: </tr>
                   13695: <tr>
1.389     wiz      13696: <td>PKG_APACHE</td>
1.391   ! wiz      13697: <td>PKG_APACHE_ACCEPTED</td>
1.269     leot     13698: </tr>
                   13699: <tr>
1.389     wiz      13700: <td>PKG_APACHE_DEFAULT</td>
1.391   ! wiz      13701: <td>PKG_BEST_EXISTS</td>
1.269     leot     13702: </tr>
                   13703: <tr>
1.389     wiz      13704: <td>PKG_BUILD_OPTIONS</td>
1.391   ! wiz      13705: <td>PKG_COMPRESSION</td>
1.269     leot     13706: </tr>
                   13707: <tr>
1.389     wiz      13708: <td>PKG_CONFIG</td>
1.391   ! wiz      13709: <td>PKG_CONFIG_PERMS</td>
1.269     leot     13710: </tr>
                   13711: <tr>
1.389     wiz      13712: <td>PKG_CREATE_USERGROUP</td>
1.391   ! wiz      13713: <td>PKG_DBDIR</td>
1.269     leot     13714: </tr>
                   13715: <tr>
1.389     wiz      13716: <td>PKG_DB_TMPDIR</td>
1.391   ! wiz      13717: <td>PKG_DEBUG_LEVEL</td>
1.269     leot     13718: </tr>
                   13719: <tr>
1.389     wiz      13720: <td>PKG_DEFAULT_OPTIONS</td>
1.391   ! wiz      13721: <td>PKG_DESTDIR_SUPPORT</td>
1.269     leot     13722: </tr>
                   13723: <tr>
1.389     wiz      13724: <td>PKG_DEVELOPER</td>
1.391   ! wiz      13725: <td>PKG_DISABLED_OPTIONS</td>
1.367     gdt      13726: </tr>
                   13727: <tr>
1.389     wiz      13728: <td>PKG_FATAL_ERRORS</td>
1.391   ! wiz      13729: <td>PKG_FC</td>
1.269     leot     13730: </tr>
                   13731: <tr>
1.389     wiz      13732: <td>PKG_FILELIST_CMD</td>
1.391   ! wiz      13733: <td>PKG_GECOS</td>
1.348     wiz      13734: </tr>
                   13735: <tr>
1.389     wiz      13736: <td>PKG_GID</td>
1.391   ! wiz      13737: <td>PKG_GROUPS</td>
1.360     leot     13738: </tr>
                   13739: <tr>
1.389     wiz      13740: <td>PKG_GROUPS_VARS</td>
1.391   ! wiz      13741: <td>PKG_HOME</td>
1.269     leot     13742: </tr>
                   13743: <tr>
1.389     wiz      13744: <td>PKG_INIT_SCRIPTS</td>
1.391   ! wiz      13745: <td>PKG_JAVA_HOME</td>
1.269     leot     13746: </tr>
                   13747: <tr>
1.389     wiz      13748: <td>PKG_JVM</td>
1.391   ! wiz      13749: <td>PKG_JVMS_ACCEPTED</td>
1.269     leot     13750: </tr>
                   13751: <tr>
1.389     wiz      13752: <td>PKG_JVM_DEFAULT</td>
1.391   ! wiz      13753: <td>PKG_LEGACY_OPTIONS</td>
1.269     leot     13754: </tr>
                   13755: <tr>
1.389     wiz      13756: <td>PKG_LIBTOOL</td>
1.391   ! wiz      13757: <td>PKG_MKSYMLINKS</td>
1.269     leot     13758: </tr>
                   13759: <tr>
1.389     wiz      13760: <td>PKG_OPTIONS</td>
1.391   ! wiz      13761: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269     leot     13762: </tr>
                   13763: <tr>
1.389     wiz      13764: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.391   ! wiz      13765: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269     leot     13766: </tr>
                   13767: <tr>
1.389     wiz      13768: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.391   ! wiz      13769: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269     leot     13770: </tr>
                   13771: <tr>
1.389     wiz      13772: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.391   ! wiz      13773: <td>PKG_OPTIONS_VAR</td>
1.269     leot     13774: </tr>
                   13775: <tr>
1.389     wiz      13776: <td>PKG_RCD_SCRIPTS</td>
1.391   ! wiz      13777: <td>PKG_REFCOUNT_DBDIR</td>
1.269     leot     13778: </tr>
                   13779: <tr>
1.389     wiz      13780: <td>PKG_REGISTER_SHELLS</td>
1.391   ! wiz      13781: <td>PKG_RESUME_TRANSFERS</td>
1.269     leot     13782: </tr>
                   13783: <tr>
1.389     wiz      13784: <td>PKG_SHELL</td>
1.391   ! wiz      13785: <td>PKG_SUGGESTED_OPTIONS</td>
1.269     leot     13786: </tr>
                   13787: <tr>
1.389     wiz      13788: <td>PKG_SUPPORTED_OPTIONS</td>
1.391   ! wiz      13789: <td>PKG_SYSCONFBASE</td>
1.269     leot     13790: </tr>
                   13791: <tr>
1.389     wiz      13792: <td>PKG_SYSCONFBASEDIR</td>
1.391   ! wiz      13793: <td>PKG_SYSCONFDIR</td>
1.269     leot     13794: </tr>
                   13795: <tr>
1.389     wiz      13796: <td>PKG_SYSCONFDIR_PERMS</td>
1.391   ! wiz      13797: <td>PKG_SYSCONFSUBDIR</td>
1.269     leot     13798: </tr>
                   13799: <tr>
1.389     wiz      13800: <td>PKG_SYSCONFVAR</td>
1.391   ! wiz      13801: <td>PKG_TOOLS_BIN</td>
1.269     leot     13802: </tr>
                   13803: <tr>
1.389     wiz      13804: <td>PKG_UID</td>
1.391   ! wiz      13805: <td>PKG_UPDATE_FONTS_DB</td>
1.269     leot     13806: </tr>
                   13807: <tr>
1.389     wiz      13808: <td>PKG_USERS</td>
1.391   ! wiz      13809: <td>PKG_USERS_VARS</td>
1.269     leot     13810: </tr>
                   13811: <tr>
1.389     wiz      13812: <td>PKG_VERBOSE</td>
1.391   ! wiz      13813: <td>PLEASE</td>
1.269     leot     13814: </tr>
                   13815: <tr>
1.389     wiz      13816: <td>PLIST</td>
1.391   ! wiz      13817: <td>PLIST_AWK</td>
1.269     leot     13818: </tr>
                   13819: <tr>
1.389     wiz      13820: <td>PLIST_AWK_ENV</td>
1.391   ! wiz      13821: <td>PLIST_SRC</td>
1.269     leot     13822: </tr>
                   13823: <tr>
1.389     wiz      13824: <td>PLIST_SUBST</td>
1.391   ! wiz      13825: <td>PLIST_TYPE</td>
1.269     leot     13826: </tr>
                   13827: <tr>
1.389     wiz      13828: <td>PLIST_VARS</td>
1.391   ! wiz      13829: <td>POPTOP_USE_MPPE</td>
1.269     leot     13830: </tr>
                   13831: <tr>
1.389     wiz      13832: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.391   ! wiz      13833: <td>POST_FETCH_HOOK</td>
1.269     leot     13834: </tr>
                   13835: <tr>
1.389     wiz      13836: <td>PREFER</td>
1.391   ! wiz      13837: <td>PREFER_NATIVE</td>
1.269     leot     13838: </tr>
                   13839: <tr>
1.389     wiz      13840: <td>PREFER_NATIVE_PTHREADS</td>
1.391   ! wiz      13841: <td>PREFER_PKGSRC</td>
1.269     leot     13842: </tr>
                   13843: <tr>
1.389     wiz      13844: <td>PREFIX</td>
1.391   ! wiz      13845: <td>PREPEND_PATH</td>
1.269     leot     13846: </tr>
                   13847: <tr>
1.389     wiz      13848: <td>PRE_ROOT_CMD</td>
1.391   ! wiz      13849: <td>PRIVILEGED_STAGES</td>
1.269     leot     13850: </tr>
                   13851: <tr>
1.389     wiz      13852: <td>PS</td>
1.391   ! wiz      13853: <td>PTHREAD_AUTO_VARS</td>
1.269     leot     13854: </tr>
                   13855: <tr>
1.389     wiz      13856: <td>PTHREAD_CFLAGS</td>
1.391   ! wiz      13857: <td>PTHREAD_LDFLAGS</td>
1.269     leot     13858: </tr>
                   13859: <tr>
1.389     wiz      13860: <td>PTHREAD_LIBS</td>
1.391   ! wiz      13861: <td>PTHREAD_OPTS</td>
1.269     leot     13862: </tr>
                   13863: <tr>
1.389     wiz      13864: <td>PTHREAD_TYPE</td>
1.391   ! wiz      13865: <td>PVM_SSH</td>
1.269     leot     13866: </tr>
                   13867: <tr>
1.389     wiz      13868: <td>PYPKGPREFIX</td>
1.391   ! wiz      13869: <td>PYSOABISUFFIX</td>
1.269     leot     13870: </tr>
                   13871: <tr>
1.389     wiz      13872: <td>PYTHON_27_ACCEPTED</td>
1.391   ! wiz      13873: <td>PYTHON_FOR_BUILD_ONLY</td>
1.385     leot     13874: </tr>
                   13875: <tr>
1.389     wiz      13876: <td>PYTHON_SELF_CONFLICT</td>
1.391   ! wiz      13877: <td>PYTHON_VERSION</td>
1.384     leot     13878: </tr>
                   13879: <tr>
1.389     wiz      13880: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.391   ! wiz      13881: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     13882: </tr>
                   13883: <tr>
1.389     wiz      13884: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.391   ! wiz      13885: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     13886: </tr>
                   13887: <tr>
1.389     wiz      13888: <td>PYTHON_VERSION_REQD</td>
1.391   ! wiz      13889: <td>PYVERSSUFFIX</td>
1.269     leot     13890: </tr>
                   13891: <tr>
1.389     wiz      13892: <td>QMAILDIR</td>
1.391   ! wiz      13893: <td>QMAIL_ALIAS_USER</td>
1.269     leot     13894: </tr>
                   13895: <tr>
1.389     wiz      13896: <td>QMAIL_DAEMON_USER</td>
1.391   ! wiz      13897: <td>QMAIL_LOG_USER</td>
1.269     leot     13898: </tr>
                   13899: <tr>
1.389     wiz      13900: <td>QMAIL_NOFILES_GROUP</td>
1.391   ! wiz      13901: <td>QMAIL_PASSWD_USER</td>
1.269     leot     13902: </tr>
                   13903: <tr>
1.389     wiz      13904: <td>QMAIL_QMAIL_GROUP</td>
1.391   ! wiz      13905: <td>QMAIL_QUEUE_DIR</td>
1.269     leot     13906: </tr>
                   13907: <tr>
1.389     wiz      13908: <td>QMAIL_QUEUE_EXTRA</td>
1.391   ! wiz      13909: <td>QMAIL_QUEUE_USER</td>
1.269     leot     13910: </tr>
                   13911: <tr>
1.389     wiz      13912: <td>QMAIL_REMOTE_USER</td>
1.391   ! wiz      13913: <td>QMAIL_ROOT_USER</td>
1.269     leot     13914: </tr>
                   13915: <tr>
1.389     wiz      13916: <td>QMAIL_SEND_USER</td>
1.391   ! wiz      13917: <td>QORE_LATEST_MODULE_API</td>
1.269     leot     13918: </tr>
                   13919: <tr>
1.389     wiz      13920: <td>QORE_MODULE_API</td>
1.391   ! wiz      13921: <td>QORE_MODULE_DIR</td>
1.269     leot     13922: </tr>
                   13923: <tr>
1.389     wiz      13924: <td>QORE_USER_MODULE_DIR</td>
1.391   ! wiz      13925: <td>QORE_VERSION</td>
1.269     leot     13926: </tr>
                   13927: <tr>
1.389     wiz      13928: <td>QPOPPER_FAC</td>
1.391   ! wiz      13929: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     13930: </tr>
                   13931: <tr>
1.389     wiz      13932: <td>QPOPPER_USER</td>
1.391   ! wiz      13933: <td>RAKE_NAME</td>
1.269     leot     13934: </tr>
                   13935: <tr>
1.389     wiz      13936: <td>RASMOL_DEPTH</td>
1.391   ! wiz      13937: <td>RCD_DIR</td>
1.269     leot     13938: </tr>
                   13939: <tr>
1.389     wiz      13940: <td>RCD_ORDER</td>
1.391   ! wiz      13941: <td>RCD_SCRIPTS</td>
1.269     leot     13942: </tr>
                   13943: <tr>
1.389     wiz      13944: <td>RCD_SCRIPTS_DIR</td>
1.391   ! wiz      13945: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.382     wiz      13946: </tr>
                   13947: <tr>
1.389     wiz      13948: <td>RCD_SCRIPTS_MODE</td>
1.391   ! wiz      13949: <td>RCD_SCRIPTS_SHELL</td>
1.378     leot     13950: </tr>
                   13951: <tr>
1.389     wiz      13952: <td>RCD_SCRIPT_SRC</td>
1.391   ! wiz      13953: <td>RCD_SUBR</td>
1.376     wiz      13954: </tr>
                   13955: <tr>
1.389     wiz      13956: <td>RDOC</td>
1.391   ! wiz      13957: <td>READLINE_DEFAULT</td>
1.355     rillig   13958: </tr>
                   13959: <tr>
1.389     wiz      13960: <td>READLINE_TYPE</td>
1.391   ! wiz      13961: <td>REAL_ROOT_GROUP</td>
1.329     leot     13962: </tr>
                   13963: <tr>
1.389     wiz      13964: <td>REAL_ROOT_USER</td>
1.391   ! wiz      13965: <td>RECURSIVE_MAKE</td>
1.320     wiz      13966: </tr>
                   13967: <tr>
1.389     wiz      13968: <td>RELAY_CTRL_DIR</td>
1.391   ! wiz      13969: <td>RELRO_SUPPORTED</td>
1.338     nia      13970: </tr>
                   13971: <tr>
1.389     wiz      13972: <td>REPLACE_AWK</td>
1.391   ! wiz      13973: <td>REPLACE_BASH</td>
1.292     leot     13974: </tr>
                   13975: <tr>
1.389     wiz      13976: <td>REPLACE_CSH</td>
1.391   ! wiz      13977: <td>REPLACE_KSH</td>
1.329     leot     13978: </tr>
                   13979: <tr>
1.389     wiz      13980: <td>REPLACE_LUA</td>
1.391   ! wiz      13981: <td>REPLACE_NODEJS</td>
1.327     wiz      13982: </tr>
                   13983: <tr>
1.389     wiz      13984: <td>REPLACE_OCTAVE</td>
1.391   ! wiz      13985: <td>REPLACE_PERL</td>
1.269     leot     13986: </tr>
                   13987: <tr>
1.389     wiz      13988: <td>REPLACE_PERL6</td>
1.391   ! wiz      13989: <td>REPLACE_PHP</td>
1.320     wiz      13990: </tr>
                   13991: <tr>
1.389     wiz      13992: <td>REPLACE_PYTHON</td>
1.391   ! wiz      13993: <td>REPLACE_QORE</td>
1.311     leot     13994: </tr>
                   13995: <tr>
1.389     wiz      13996: <td>REPLACE_R</td>
1.391   ! wiz      13997: <td>REPLACE_RUBY</td>
1.269     leot     13998: </tr>
                   13999: <tr>
1.389     wiz      14000: <td>REPLACE_RUBY_DIRS</td>
1.391   ! wiz      14001: <td>REPLACE_RUBY_PAT</td>
1.333     nia      14002: </tr>
                   14003: <tr>
1.389     wiz      14004: <td>REPLACE_SH</td>
1.391   ! wiz      14005: <td>REPLACE_TEXLUA</td>
1.269     leot     14006: </tr>
                   14007: <tr>
1.389     wiz      14008: <td>REPLACE_TOOL_PYTHON</td>
1.391   ! wiz      14009: <td>REPLACE_WISH</td>
1.369     wiz      14010: </tr>
                   14011: <tr>
1.389     wiz      14012: <td>REQD_DIRS</td>
1.391   ! wiz      14013: <td>REQD_DIRS_PERMS</td>
1.331     gutterid 14014: </tr>
                   14015: <tr>
1.389     wiz      14016: <td>REQD_FILES</td>
1.391   ! wiz      14017: <td>REQD_FILES_MODE</td>
1.269     leot     14018: </tr>
                   14019: <tr>
1.389     wiz      14020: <td>REQD_FILES_PERMS</td>
1.391   ! wiz      14021: <td>RESOLV_AUTO_VARS</td>
1.333     nia      14022: </tr>
                   14023: <tr>
1.389     wiz      14024: <td>RESOLV_LDFLAGS</td>
1.391   ! wiz      14025: <td>RESOLV_LIBS</td>
1.269     leot     14026: </tr>
                   14027: <tr>
1.389     wiz      14028: <td>RM</td>
1.391   ! wiz      14029: <td>ROCKSPEC_NAME</td>
1.369     wiz      14030: </tr>
                   14031: <tr>
1.389     wiz      14032: <td>ROCKSPEC_SPECFILE</td>
1.391   ! wiz      14033: <td>ROOT_CMD</td>
1.378     leot     14034: </tr>
                   14035: <tr>
1.389     wiz      14036: <td>ROOT_GROUP</td>
1.391   ! wiz      14037: <td>ROOT_USER</td>
1.382     wiz      14038: </tr>
                   14039: <tr>
1.389     wiz      14040: <td>RPCGEN</td>
1.391   ! wiz      14041: <td>RPM</td>
1.352     wiz      14042: </tr>
                   14043: <tr>
1.389     wiz      14044: <td>RPM2PKG_PLIST</td>
1.391   ! wiz      14045: <td>RPM2PKG_PREFIX</td>
1.269     leot     14046: </tr>
                   14047: <tr>
1.389     wiz      14048: <td>RPM2PKG_STAGE</td>
1.391   ! wiz      14049: <td>RPM2PKG_STRIP</td>
1.269     leot     14050: </tr>
                   14051: <tr>
1.389     wiz      14052: <td>RPM2PKG_SUBPREFIX</td>
1.391   ! wiz      14053: <td>RPMFILES</td>
1.320     wiz      14054: </tr>
                   14055: <tr>
1.389     wiz      14056: <td>RPMIGNOREPATH</td>
1.391   ! wiz      14057: <td>RPM_DB_PREFIX</td>
1.332     rillig   14058: </tr>
                   14059: <tr>
1.389     wiz      14060: <td>RSSH_CVS_PATH</td>
1.391   ! wiz      14061: <td>RSSH_RDIST_PATH</td>
1.329     leot     14062: </tr>
                   14063: <tr>
1.389     wiz      14064: <td>RSSH_RSYNC_PATH</td>
1.391   ! wiz      14065: <td>RSSH_SCP_PATH</td>
1.327     wiz      14066: </tr>
                   14067: <tr>
1.389     wiz      14068: <td>RSSH_SFTP_SERVER_PATH</td>
1.391   ! wiz      14069: <td>RUBY</td>
1.269     leot     14070: </tr>
                   14071: <tr>
1.389     wiz      14072: <td>RUBYGEM</td>
1.391   ! wiz      14073: <td>RUBYGEM_MANPAGES</td>
1.311     leot     14074: </tr>
                   14075: <tr>
1.389     wiz      14076: <td>RUBYGEM_NAME</td>
1.391   ! wiz      14077: <td>RUBYGEM_OPTIONS</td>
1.269     leot     14078: </tr>
                   14079: <tr>
1.389     wiz      14080: <td>RUBYGEM_USE_MANPAGES</td>
1.391   ! wiz      14081: <td>RUBYGEM_VERBOSE</td>
1.269     leot     14082: </tr>
                   14083: <tr>
1.389     wiz      14084: <td>RUBY_ABI_VERSION</td>
1.391   ! wiz      14085: <td>RUBY_ALLOW_HAS_RDOC</td>
1.269     leot     14086: </tr>
                   14087: <tr>
1.384     leot     14088: <td>RUBY_ARCH</td>
1.389     wiz      14089: <td>RUBY_ARCHINC</td>
1.346     jnemeth  14090: </tr>
                   14091: <tr>
1.384     leot     14092: <td>RUBY_ARCHLIB</td>
1.389     wiz      14093: <td>RUBY_BASE</td>
1.269     leot     14094: </tr>
                   14095: <tr>
1.384     leot     14096: <td>RUBY_BASERIDIR</td>
1.389     wiz      14097: <td>RUBY_BUILD_DOCUMENT</td>
1.269     leot     14098: </tr>
                   14099: <tr>
1.384     leot     14100: <td>RUBY_DLEXT</td>
1.389     wiz      14101: <td>RUBY_DOC</td>
1.269     leot     14102: </tr>
                   14103: <tr>
1.384     leot     14104: <td>RUBY_DYNAMIC_DIRS</td>
1.389     wiz      14105: <td>RUBY_EG</td>
1.269     leot     14106: </tr>
                   14107: <tr>
1.389     wiz      14108: <td>RUBY_EXTCONF</td>
1.391   ! wiz      14109: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     14110: </tr>
                   14111: <tr>
1.389     wiz      14112: <td>RUBY_EXTCONF_DEBUG</td>
1.391   ! wiz      14113: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     14114: </tr>
                   14115: <tr>
1.389     wiz      14116: <td>RUBY_GEM_ARCH</td>
1.391   ! wiz      14117: <td>RUBY_GEM_BASE</td>
1.269     leot     14118: </tr>
                   14119: <tr>
1.389     wiz      14120: <td>RUBY_INC</td>
1.391   ! wiz      14121: <td>RUBY_LIB</td>
1.269     leot     14122: </tr>
                   14123: <tr>
1.389     wiz      14124: <td>RUBY_LIB_BASE</td>
1.391   ! wiz      14125: <td>RUBY_NAME</td>
1.269     leot     14126: </tr>
                   14127: <tr>
1.389     wiz      14128: <td>RUBY_NOVERSION</td>
1.391   ! wiz      14129: <td>RUBY_PKGPREFIX</td>
1.269     leot     14130: </tr>
                   14131: <tr>
1.389     wiz      14132: <td>RUBY_RAILS</td>
1.391   ! wiz      14133: <td>RUBY_RAILS61_VERSION</td>
1.269     leot     14134: </tr>
                   14135: <tr>
1.389     wiz      14136: <td>RUBY_RAILS70_VERSION</td>
1.391   ! wiz      14137: <td>RUBY_RAILS71_VERSION</td>
1.269     leot     14138: </tr>
                   14139: <tr>
1.389     wiz      14140: <td>RUBY_RAILS72_VERSION</td>
1.391   ! wiz      14141: <td>RUBY_RAILS80_VERSION</td>
1.338     nia      14142: </tr>
                   14143: <tr>
1.389     wiz      14144: <td>RUBY_RAILS_ACCEPTED</td>
1.391   ! wiz      14145: <td>RUBY_RAILS_DEFAULT</td>
1.269     leot     14146: </tr>
                   14147: <tr>
1.389     wiz      14148: <td>RUBY_RAILS_REQD</td>
1.391   ! wiz      14149: <td>RUBY_RAILS_STRICT_DEP</td>
1.378     leot     14150: </tr>
                   14151: <tr>
1.389     wiz      14152: <td>RUBY_RIDIR</td>
1.391   ! wiz      14153: <td>RUBY_SETUP</td>
1.269     leot     14154: </tr>
                   14155: <tr>
1.389     wiz      14156: <td>RUBY_SHLIB</td>
1.391   ! wiz      14157: <td>RUBY_SHLIBALIAS</td>
1.269     leot     14158: </tr>
                   14159: <tr>
1.389     wiz      14160: <td>RUBY_SHLIBVER</td>
1.391   ! wiz      14161: <td>RUBY_SIMPLE_INSTALL</td>
1.269     leot     14162: </tr>
                   14163: <tr>
1.389     wiz      14164: <td>RUBY_SITEARCHLIB</td>
1.391   ! wiz      14165: <td>RUBY_SITELIB</td>
1.269     leot     14166: </tr>
                   14167: <tr>
1.389     wiz      14168: <td>RUBY_SITELIB_BASE</td>
1.391   ! wiz      14169: <td>RUBY_SITERIDIR</td>
1.269     leot     14170: </tr>
                   14171: <tr>
1.389     wiz      14172: <td>RUBY_SLEXT</td>
1.391   ! wiz      14173: <td>RUBY_SRCDIR</td>
1.269     leot     14174: </tr>
                   14175: <tr>
1.389     wiz      14176: <td>RUBY_STATICLIB</td>
1.391   ! wiz      14177: <td>RUBY_SUFFIX</td>
1.269     leot     14178: </tr>
                   14179: <tr>
1.389     wiz      14180: <td>RUBY_SYSRIDIR</td>
1.391   ! wiz      14181: <td>RUBY_USE_PTHREAD</td>
1.312     gdt      14182: </tr>
                   14183: <tr>
1.389     wiz      14184: <td>RUBY_VENDORARCHLIB</td>
1.391   ! wiz      14185: <td>RUBY_VENDORLIB</td>
1.289     leot     14186: </tr>
                   14187: <tr>
1.389     wiz      14188: <td>RUBY_VENDORLIB_BASE</td>
1.391   ! wiz      14189: <td>RUBY_VER</td>
1.269     leot     14190: </tr>
                   14191: <tr>
1.389     wiz      14192: <td>RUBY_VERSION</td>
1.391   ! wiz      14193: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269     leot     14194: </tr>
                   14195: <tr>
1.389     wiz      14196: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.391   ! wiz      14197: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     14198: </tr>
                   14199: <tr>
1.389     wiz      14200: <td>RUBY_VERSION_REQD</td>
1.391   ! wiz      14201: <td>RUBY_VER_DIR</td>
1.269     leot     14202: </tr>
                   14203: <tr>
1.389     wiz      14204: <td>RUN</td>
1.391   ! wiz      14205: <td>RUN_LDCONFIG</td>
1.269     leot     14206: </tr>
                   14207: <tr>
1.389     wiz      14208: <td>RUST_TYPE</td>
1.391   ! wiz      14209: <td>SCO</td>
1.269     leot     14210: </tr>
                   14211: <tr>
1.389     wiz      14212: <td>SCREWS_GROUP</td>
1.391   ! wiz      14213: <td>SCREWS_USER</td>
1.269     leot     14214: </tr>
                   14215: <tr>
1.389     wiz      14216: <td>SCRIPTS_ENV</td>
1.391   ! wiz      14217: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     14218: </tr>
                   14219: <tr>
1.389     wiz      14220: <td>SCROLLKEEPER_REBUILDDB</td>
1.391   ! wiz      14221: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     14222: </tr>
                   14223: <tr>
1.389     wiz      14224: <td>SDIST_PAWD</td>
1.391   ! wiz      14225: <td>SDL12_TYPE</td>
1.269     leot     14226: </tr>
                   14227: <tr>
1.389     wiz      14228: <td>SERIAL_DEVICES</td>
1.391   ! wiz      14229: <td>SETGIDGAME</td>
1.269     leot     14230: </tr>
                   14231: <tr>
1.389     wiz      14232: <td>SETGID_GAMES_PERMS</td>
1.391   ! wiz      14233: <td>SETUID_ROOT_PERMS</td>
1.269     leot     14234: </tr>
                   14235: <tr>
1.389     wiz      14236: <td>SH</td>
1.391   ! wiz      14237: <td>SHAIRPORT_GROUP</td>
1.269     leot     14238: </tr>
                   14239: <tr>
1.389     wiz      14240: <td>SHAIRPORT_USER</td>
1.391   ! wiz      14241: <td>SHLIB_EXT</td>
1.269     leot     14242: </tr>
                   14243: <tr>
1.389     wiz      14244: <td>SHORTNAME</td>
1.391   ! wiz      14245: <td>SIGN_PACKAGES</td>
1.382     wiz      14246: </tr>
                   14247: <tr>
1.389     wiz      14248: <td>SILC_CLIENT_WITH_PERL</td>
1.391   ! wiz      14249: <td>SITE_SPECIFIC_PKGS</td>
1.376     wiz      14250: </tr>
                   14251: <tr>
1.389     wiz      14252: <td>SKIP_DEPENDS</td>
1.391   ! wiz      14253: <td>SMF_INSTANCES</td>
1.348     wiz      14254: </tr>
                   14255: <tr>
1.389     wiz      14256: <td>SMF_MANIFEST</td>
1.391   ! wiz      14257: <td>SMF_METHODS</td>
1.269     leot     14258: </tr>
                   14259: <tr>
1.389     wiz      14260: <td>SMF_METHOD_SHELL</td>
1.391   ! wiz      14261: <td>SMF_METHOD_SRC</td>
1.342     wiz      14262: </tr>
                   14263: <tr>
1.389     wiz      14264: <td>SMF_NAME</td>
1.391   ! wiz      14265: <td>SMF_PREFIX</td>
1.269     leot     14266: </tr>
                   14267: <tr>
1.389     wiz      14268: <td>SMF_SRCDIR</td>
1.391   ! wiz      14269: <td>SNIPROXY_GROUP</td>
1.269     leot     14270: </tr>
                   14271: <tr>
1.389     wiz      14272: <td>SNIPROXY_USER</td>
1.391   ! wiz      14273: <td>SOURCE_BUFFSIZE</td>
1.292     leot     14274: </tr>
                   14275: <tr>
1.389     wiz      14276: <td>SPECIAL_PERMS</td>
1.391   ! wiz      14277: <td>SPECIFIC_PKGS</td>
1.269     leot     14278: </tr>
                   14279: <tr>
1.389     wiz      14280: <td>SSH_SUID</td>
1.391   ! wiz      14281: <td>SSLCERTBUNDLE</td>
1.332     rillig   14282: </tr>
                   14283: <tr>
1.389     wiz      14284: <td>SSLCERTS</td>
1.391   ! wiz      14285: <td>SSLDIR</td>
1.378     leot     14286: </tr>
                   14287: <tr>
1.389     wiz      14288: <td>SSLKEYS</td>
1.391   ! wiz      14289: <td>SSP_SUPPORTED</td>
1.378     leot     14290: </tr>
                   14291: <tr>
1.389     wiz      14292: <td>SSYNC_PAWD</td>
1.391   ! wiz      14293: <td>STEP_MSG</td>
1.269     leot     14294: </tr>
                   14295: <tr>
1.389     wiz      14296: <td>STRIP</td>
1.391   ! wiz      14297: <td>STRIP_DBG</td>
1.274     rillig   14298: </tr>
                   14299: <tr>
1.389     wiz      14300: <td>STRIP_DEBUG</td>
1.391   ! wiz      14301: <td>STRIP_DEBUG_SUPPORTED</td>
1.269     leot     14302: </tr>
                   14303: <tr>
1.389     wiz      14304: <td>STRIP_FILES_SKIP</td>
1.385     leot     14305: <td>SU</td>
1.269     leot     14306: </tr>
                   14307: <tr>
1.391   ! wiz      14308: <td>SUBDIR</td>
1.385     leot     14309: <td>SUBST</td>
1.269     leot     14310: </tr>
                   14311: <tr>
1.391   ! wiz      14312: <td>SUBST_CLASSES</td>
1.385     leot     14313: <td>SUBST_FILES</td>
1.269     leot     14314: </tr>
                   14315: <tr>
1.391   ! wiz      14316: <td>SUBST_FILTER_CMD</td>
1.385     leot     14317: <td>SUBST_MESSAGE</td>
1.269     leot     14318: </tr>
                   14319: <tr>
1.391   ! wiz      14320: <td>SUBST_NOOP_OK</td>
1.385     leot     14321: <td>SUBST_SED</td>
1.269     leot     14322: </tr>
                   14323: <tr>
1.391   ! wiz      14324: <td>SUBST_SHOW_DIFF</td>
1.385     leot     14325: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269     leot     14326: </tr>
                   14327: <tr>
1.391   ! wiz      14328: <td>SUBST_STAGE</td>
1.385     leot     14329: <td>SUBST_VARS</td>
1.269     leot     14330: </tr>
                   14331: <tr>
1.391   ! wiz      14332: <td>SUNWSPROBASE</td>
1.385     leot     14333: <td>SUSE_PREFER</td>
1.382     wiz      14334: </tr>
                   14335: <tr>
1.391   ! wiz      14336: <td>SU_CMD</td>
1.385     leot     14337: <td>SVN_EXTRACTDIR</td>
1.382     wiz      14338: </tr>
                   14339: <tr>
1.391   ! wiz      14340: <td>SVN_REPO</td>
1.385     leot     14341: <td>SVN_REPOSITORIES</td>
1.360     leot     14342: </tr>
                   14343: <tr>
1.391   ! wiz      14344: <td>SVN_REVISION</td>
1.385     leot     14345: <td>SYSCONFBASE</td>
1.376     wiz      14346: </tr>
                   14347: <tr>
1.391   ! wiz      14348: <td>TARGET_MACHINE_ARCH</td>
1.385     leot     14349: <td>TBL</td>
1.370     gdt      14350: </tr>
                   14351: <tr>
1.391   ! wiz      14352: <td>TERMCAP_TYPE</td>
1.385     leot     14353: <td>TERMINFO_DEFAULT</td>
1.352     wiz      14354: </tr>
                   14355: <tr>
1.391   ! wiz      14356: <td>TERMINFO_TYPE</td>
1.385     leot     14357: <td>TEST</td>
1.269     leot     14358: </tr>
                   14359: <tr>
1.391   ! wiz      14360: <td>TEST_DEPENDS</td>
1.385     leot     14361: <td>TEST_DIRS</td>
1.342     wiz      14362: </tr>
                   14363: <tr>
1.391   ! wiz      14364: <td>TEST_ENV</td>
1.385     leot     14365: <td>TEST_ENV_SHELL</td>
1.269     leot     14366: </tr>
                   14367: <tr>
1.391   ! wiz      14368: <td>TEST_MAKE_CMD</td>
1.385     leot     14369: <td>TEST_MAKE_FLAGS</td>
1.332     rillig   14370: </tr>
                   14371: <tr>
1.391   ! wiz      14372: <td>TEST_TARGET</td>
1.385     leot     14373: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.327     wiz      14374: </tr>
                   14375: <tr>
1.391   ! wiz      14376: <td>TEXLIVE_REV</td>
1.385     leot     14377: <td>TEXLIVE_UNVERSIONED</td>
1.332     rillig   14378: </tr>
                   14379: <tr>
1.391   ! wiz      14380: <td>TEXMFSITE</td>
1.385     leot     14381: <td>TEX_FORMATS</td>
1.320     wiz      14382: </tr>
                   14383: <tr>
1.391   ! wiz      14384: <td>TEX_HYPHEN_DAT</td>
1.385     leot     14385: <td>TEX_HYPHEN_DEF</td>
1.303     bacon    14386: </tr>
                   14387: <tr>
1.391   ! wiz      14388: <td>TEX_TEXMF_DIRS</td>
1.385     leot     14389: <td>THTTPD_LOG_FACILITY</td>
1.274     rillig   14390: </tr>
                   14391: <tr>
1.391   ! wiz      14392: <td>TINYDYN_USER</td>
1.385     leot     14393: <td>TLS</td>
1.269     leot     14394: </tr>
                   14395: <tr>
1.391   ! wiz      14396: <td>TLSWRAPPER_CHROOT</td>
1.385     leot     14397: <td>TO</td>
1.269     leot     14398: </tr>
                   14399: <tr>
1.391   ! wiz      14400: <td>TOOLDIR</td>
1.385     leot     14401: <td>TOOLS_ALIASES</td>
1.269     leot     14402: </tr>
                   14403: <tr>
1.391   ! wiz      14404: <td>TOOLS_ALWAYS_WRAP</td>
1.385     leot     14405: <td>TOOLS_ARGS</td>
1.269     leot     14406: </tr>
                   14407: <tr>
1.391   ! wiz      14408: <td>TOOLS_BROKEN</td>
1.385     leot     14409: <td>TOOLS_CMD</td>
1.269     leot     14410: </tr>
                   14411: <tr>
1.391   ! wiz      14412: <td>TOOLS_CMDLINE_SED</td>
1.385     leot     14413: <td>TOOLS_CREATE</td>
1.269     leot     14414: </tr>
                   14415: <tr>
1.391   ! wiz      14416: <td>TOOLS_CROSS_DESTDIR</td>
1.385     leot     14417: <td>TOOLS_DIR</td>
1.269     leot     14418: </tr>
                   14419: <tr>
1.391   ! wiz      14420: <td>TOOLS_FAIL</td>
1.385     leot     14421: <td>TOOLS_GNU_MISSING</td>
1.269     leot     14422: </tr>
                   14423: <tr>
1.391   ! wiz      14424: <td>TOOLS_LDCONFIG</td>
1.385     leot     14425: <td>TOOLS_NOOP</td>
1.269     leot     14426: </tr>
                   14427: <tr>
1.391   ! wiz      14428: <td>TOOLS_PATH</td>
1.385     leot     14429: <td>TOOLS_SCRIPT</td>
1.269     leot     14430: </tr>
                   14431: <tr>
1.391   ! wiz      14432: <td>TOOLS_USE_CROSS_COMPILE</td>
1.385     leot     14433: <td>TOOL_DEPENDS</td>
1.369     wiz      14434: </tr>
                   14435: <tr>
1.391   ! wiz      14436: <td>TTF_FONTDIR</td>
1.385     leot     14437: <td>TTF_FONTS_DIR</td>
1.378     leot     14438: </tr>
                   14439: <tr>
1.391   ! wiz      14440: <td>TYPE</td>
1.385     leot     14441: <td>UAC_REQD_EXECS</td>
1.355     rillig   14442: </tr>
                   14443: <tr>
1.391   ! wiz      14444: <td>UCSPI_SSL_GROUP</td>
1.385     leot     14445: <td>UCSPI_SSL_USER</td>
1.352     wiz      14446: </tr>
                   14447: <tr>
1.391   ! wiz      14448: <td>UNBOUND_GROUP</td>
1.385     leot     14449: <td>UNBOUND_LOG_FACILITY</td>
1.379     wiz      14450: </tr>
                   14451: <tr>
1.391   ! wiz      14452: <td>UNBOUND_USER</td>
1.385     leot     14453: <td>UNLIMIT_RESOURCES</td>
1.379     wiz      14454: </tr>
                   14455: <tr>
1.391   ! wiz      14456: <td>UNPRIVILEGED</td>
1.385     leot     14457: <td>UNPRIVILEGED_GROUP</td>
1.269     leot     14458: </tr>
                   14459: <tr>
1.391   ! wiz      14460: <td>UNPRIVILEGED_GROUPS</td>
1.385     leot     14461: <td>UNPRIVILEGED_USER</td>
1.338     nia      14462: </tr>
                   14463: <tr>
1.391   ! wiz      14464: <td>UNWRAP_FILES</td>
1.385     leot     14465: <td>UNWRAP_PATTERNS</td>
1.269     leot     14466: </tr>
                   14467: <tr>
1.391   ! wiz      14468: <td>UPDATE_GEMSPEC</td>
1.385     leot     14469: <td>UPDATE_TARGET</td>
1.327     wiz      14470: </tr>
                   14471: <tr>
1.391   ! wiz      14472: <td>URI</td>
1.385     leot     14473: <td>USERGROUP_PHASE</td>
1.269     leot     14474: </tr>
                   14475: <tr>
1.391   ! wiz      14476: <td>USERPPP_GROUP</td>
1.385     leot     14477: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     14478: </tr>
                   14479: <tr>
1.391   ! wiz      14480: <td>USE_ABI_DEPENDS</td>
1.385     leot     14481: <td>USE_ADA_FEATURES</td>
1.269     leot     14482: </tr>
                   14483: <tr>
1.391   ! wiz      14484: <td>USE_APR</td>
1.385     leot     14485: <td>USE_BSD_MAKEFILE</td>
1.269     leot     14486: </tr>
                   14487: <tr>
1.391   ! wiz      14488: <td>USE_BUILTIN</td>
1.385     leot     14489: <td>USE_CC_FEATURES</td>
1.269     leot     14490: </tr>
                   14491: <tr>
1.391   ! wiz      14492: <td>USE_CROSS_COMPILE</td>
1.385     leot     14493: <td>USE_CURSES</td>
1.357     gutterid 14494: </tr>
                   14495: <tr>
1.391   ! wiz      14496: <td>USE_CWRAPPERS</td>
1.385     leot     14497: <td>USE_CXX_FEATURES</td>
1.269     leot     14498: </tr>
                   14499: <tr>
1.391   ! wiz      14500: <td>USE_DB185</td>
1.385     leot     14501: <td>USE_FEATURES</td>
1.269     leot     14502: </tr>
                   14503: <tr>
1.391   ! wiz      14504: <td>USE_GAMESGROUP</td>
1.385     leot     14505: <td>USE_GCC_RUNTIME</td>
1.269     leot     14506: </tr>
                   14507: <tr>
1.391   ! wiz      14508: <td>USE_IMAKE</td>
1.385     leot     14509: <td>USE_INDIRECT_DEPENDS</td>
1.320     wiz      14510: </tr>
                   14511: <tr>
1.391   ! wiz      14512: <td>USE_JAVA</td>
1.385     leot     14513: <td>USE_JAVA2</td>
1.269     leot     14514: </tr>
                   14515: <tr>
1.391   ! wiz      14516: <td>USE_LANGUAGES</td>
1.385     leot     14517: <td>USE_LIBTOOL</td>
1.269     leot     14518: </tr>
                   14519: <tr>
1.391   ! wiz      14520: <td>USE_NATIVE_GCC</td>
1.385     leot     14521: <td>USE_NETBSD_REPO</td>
1.269     leot     14522: </tr>
                   14523: <tr>
1.391   ! wiz      14524: <td>USE_PKGSRC_GCC</td>
1.385     leot     14525: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     14526: </tr>
                   14527: <tr>
1.391   ! wiz      14528: <td>USE_PKGTASKS</td>
1.385     leot     14529: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     14530: </tr>
                   14531: <tr>
1.391   ! wiz      14532: <td>USE_RUBY_EXTCONF</td>
1.385     leot     14533: <td>USE_RUBY_INSTALL</td>
1.269     leot     14534: </tr>
                   14535: <tr>
1.391   ! wiz      14536: <td>USE_RUBY_SETUP</td>
1.385     leot     14537: <td>USE_RUBY_SETUP_PKG</td>
1.376     wiz      14538: </tr>
                   14539: <tr>
1.391   ! wiz      14540: <td>USE_TMPFILES</td>
1.385     leot     14541: <td>USE_TOOLS</td>
1.269     leot     14542: </tr>
                   14543: <tr>
1.391   ! wiz      14544: <td>UUCP_GROUP</td>
1.385     leot     14545: <td>UUCP_USER</td>
1.269     leot     14546: </tr>
                   14547: <tr>
1.391   ! wiz      14548: <td>VARBASE</td>
1.385     leot     14549: <td>VARNAME</td>
1.269     leot     14550: </tr>
                   14551: <tr>
1.391   ! wiz      14552: <td>VIM_EXTRA_OPTS</td>
1.385     leot     14553: <td>WARNING_MSG</td>
1.269     leot     14554: </tr>
                   14555: <tr>
1.391   ! wiz      14556: <td>WCALC_CGIDIR</td>
1.385     leot     14557: <td>WCALC_CGIPATH</td>
1.269     leot     14558: </tr>
                   14559: <tr>
1.391   ! wiz      14560: <td>WCALC_HTMLDIR</td>
1.385     leot     14561: <td>WCALC_HTMLPATH</td>
1.269     leot     14562: </tr>
                   14563: <tr>
1.391   ! wiz      14564: <td>WDM_MANAGERS</td>
1.385     leot     14565: <td>WRAPPER_CC</td>
1.269     leot     14566: </tr>
                   14567: <tr>
1.391   ! wiz      14568: <td>WRAPPER_REORDER_CMDS</td>
1.385     leot     14569: <td>WRKDIR</td>
1.269     leot     14570: </tr>
                   14571: <tr>
1.391   ! wiz      14572: <td>WRKDIR_BASENAME</td>
1.385     leot     14573: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     14574: </tr>
                   14575: <tr>
1.391   ! wiz      14576: <td>WRKLOG</td>
1.385     leot     14577: <td>WRKOBJDIR</td>
1.269     leot     14578: </tr>
                   14579: <tr>
1.391   ! wiz      14580: <td>WRKSRC</td>
1.385     leot     14581: <td>X10_PORT</td>
1.269     leot     14582: </tr>
                   14583: <tr>
1.391   ! wiz      14584: <td>X11</td>
1.385     leot     14585: <td>X11BASE</td>
1.269     leot     14586: </tr>
                   14587: <tr>
1.391   ! wiz      14588: <td>X11_PKGSRCDIR</td>
1.385     leot     14589: <td>X11_TYPE</td>
1.269     leot     14590: </tr>
                   14591: <tr>
1.391   ! wiz      14592: <td>X509_CERTIFICATE</td>
1.385     leot     14593: <td>X509_KEY</td>
1.303     bacon    14594: </tr>
                   14595: <tr>
1.391   ! wiz      14596: <td>XAW_TYPE</td>
1.385     leot     14597: <td>XLOCK_DEFAULT_MODE</td>
1.269     leot     14598: </tr>
                   14599: <tr>
1.391   ! wiz      14600: <td>XMKMF</td>
1.385     leot     14601: <td>XMKMF_FLAGS</td>
1.382     wiz      14602: </tr>
                   14603: <tr>
1.391   ! wiz      14604: <td>XXX</td>
1.385     leot     14605: <td>XXXX</td>
1.269     leot     14606: </tr>
                   14607: <tr>
1.391   ! wiz      14608: <td>YES</td>
1.385     leot     14609: <td>ZSH_STATIC</td>
1.367     gdt      14610: </tr>
                   14611: <tr>
1.391   ! wiz      14612: <td>__stdc__</td>
1.385     leot     14613: <td>_vargroups</td>
1.360     leot     14614: </tr>
                   14615: <tr>
1.391   ! wiz      14616: <td>accept</td>
1.385     leot     14617: <td>acquire-localbase-lock</td>
1.348     wiz      14618: </tr>
                   14619: <tr>
1.391   ! wiz      14620: <td>acquire-lock</td>
1.385     leot     14621: <td>add</td>
1.269     leot     14622: </tr>
                   14623: <tr>
1.391   ! wiz      14624: <td>added</td>
1.385     leot     14625: <td>administrator</td>
1.342     wiz      14626: </tr>
                   14627: <tr>
1.391   ! wiz      14628: <td>alloca</td>
1.385     leot     14629: <td>alternatives</td>
1.269     leot     14630: </tr>
                   14631: <tr>
1.391   ! wiz      14632: <td>aslr</td>
1.385     leot     14633: <td>asprintf</td>
1.274     rillig   14634: </tr>
                   14635: <tr>
1.391   ! wiz      14636: <td>atlas</td>
1.385     leot     14637: <td>autoconf</td>
1.332     rillig   14638: </tr>
                   14639: <tr>
1.391   ! wiz      14640: <td>automake</td>
1.385     leot     14641: <td>autoreconf</td>
1.384     leot     14642: </tr>
                   14643: <tr>
1.391   ! wiz      14644: <td>awk</td>
1.385     leot     14645: <td>barrier</td>
1.269     leot     14646: </tr>
                   14647: <tr>
1.391   ! wiz      14648: <td>bash</td>
1.385     leot     14649: <td>big-endian</td>
1.316     cirnatda 14650: </tr>
                   14651: <tr>
1.391   ! wiz      14652: <td>bin-install</td>
1.385     leot     14653: <td>bind</td>
1.289     leot     14654: </tr>
                   14655: <tr>
1.391   ! wiz      14656: <td>binpkg-list</td>
1.385     leot     14657: <td>blas</td>
1.269     leot     14658: </tr>
                   14659: <tr>
1.391   ! wiz      14660: <td>bootstrap-depends</td>
1.385     leot     14661: <td>broken</td>
1.269     leot     14662: </tr>
                   14663: <tr>
1.391   ! wiz      14664: <td>broken_on_platform</td>
1.385     leot     14665: <td>bsd</td>
1.289     leot     14666: </tr>
                   14667: <tr>
1.391   ! wiz      14668: <td>bsd.prog.mk</td>
1.385     leot     14669: <td>build</td>
1.269     leot     14670: </tr>
                   14671: <tr>
1.391   ! wiz      14672: <td>build-env</td>
1.385     leot     14673: <td>buildlink-directories</td>
1.269     leot     14674: </tr>
                   14675: <tr>
1.391   ! wiz      14676: <td>buildlink-oss-soundcard-h</td>
1.385     leot     14677: <td>built-in</td>
1.269     leot     14678: </tr>
                   14679: <tr>
1.391   ! wiz      14680: <td>builtin</td>
1.385     leot     14681: <td>c</td>
1.271     brook    14682: </tr>
                   14683: <tr>
1.391   ! wiz      14684: <td>c++</td>
1.385     leot     14685: <td>ccache</td>
1.269     leot     14686: </tr>
                   14687: <tr>
1.391   ! wiz      14688: <td>cce</td>
1.385     leot     14689: <td>cdefs</td>
1.356     gutterid 14690: </tr>
                   14691: <tr>
1.391   ! wiz      14692: <td>ceil</td>
1.385     leot     14693: <td>changes</td>
1.292     leot     14694: </tr>
                   14695: <tr>
1.391   ! wiz      14696: <td>changes-entry</td>
1.385     leot     14697: <td>changes-entry-noupdate</td>
1.274     rillig   14698: </tr>
                   14699: <tr>
1.391   ! wiz      14700: <td>check</td>
1.385     leot     14701: <td>check-clean</td>
1.269     leot     14702: </tr>
                   14703: <tr>
1.391   ! wiz      14704: <td>check-files</td>
1.385     leot     14705: <td>check-files-clean</td>
1.289     leot     14706: </tr>
                   14707: <tr>
1.391   ! wiz      14708: <td>check-hackage</td>
1.385     leot     14709: <td>check-vulnerable</td>
1.269     leot     14710: </tr>
                   14711: <tr>
1.391   ! wiz      14712: <td>checksum</td>
1.385     leot     14713: <td>checksum-phase</td>
1.370     gdt      14714: </tr>
                   14715: <tr>
1.391   ! wiz      14716: <td>clean</td>
1.385     leot     14717: <td>clean-depends</td>
1.269     leot     14718: </tr>
                   14719: <tr>
1.391   ! wiz      14720: <td>cleandir</td>
1.385     leot     14721: <td>commit</td>
1.269     leot     14722: </tr>
                   14723: <tr>
1.391   ! wiz      14724: <td>commit-changes-entry</td>
1.385     leot     14725: <td>compact</td>
1.269     leot     14726: </tr>
                   14727: <tr>
1.391   ! wiz      14728: <td>compiler</td>
1.385     leot     14729: <td>conf</td>
1.289     leot     14730: </tr>
                   14731: <tr>
1.391   ! wiz      14732: <td>config.guess</td>
1.385     leot     14733: <td>config.sub</td>
1.269     leot     14734: </tr>
                   14735: <tr>
1.391   ! wiz      14736: <td>configuration</td>
1.385     leot     14737: <td>configure</td>
1.269     leot     14738: </tr>
                   14739: <tr>
1.391   ! wiz      14740: <td>configure-env</td>
1.385     leot     14741: <td>configure-help</td>
1.269     leot     14742: </tr>
                   14743: <tr>
1.391   ! wiz      14744: <td>configure_args</td>
1.385     leot     14745: <td>connect</td>
1.269     leot     14746: </tr>
                   14747: <tr>
1.391   ! wiz      14748: <td>cos</td>
1.385     leot     14749: <td>cpe</td>
1.269     leot     14750: </tr>
                   14751: <tr>
1.391   ! wiz      14752: <td>cputime</td>
1.385     leot     14753: <td>create-usergroup</td>
1.269     leot     14754: </tr>
                   14755: <tr>
1.391   ! wiz      14756: <td>csh</td>
1.385     leot     14757: <td>ctf</td>
1.269     leot     14758: </tr>
                   14759: <tr>
1.391   ! wiz      14760: <td>cvs</td>
1.385     leot     14761: <td>debug</td>
1.378     leot     14762: </tr>
                   14763: <tr>
1.391   ! wiz      14764: <td>debug-barrier</td>
1.385     leot     14765: <td>declaration</td>
1.376     wiz      14766: </tr>
                   14767: <tr>
1.391   ! wiz      14768: <td>declare</td>
1.385     leot     14769: <td>defined</td>
1.355     rillig   14770: </tr>
                   14771: <tr>
1.391   ! wiz      14772: <td>depend</td>
1.385     leot     14773: <td>dependencies</td>
1.352     wiz      14774: </tr>
                   14775: <tr>
1.391   ! wiz      14776: <td>depends</td>
1.385     leot     14777: <td>depends-checksum</td>
1.338     nia      14778: </tr>
                   14779: <tr>
1.391   ! wiz      14780: <td>depends-fetch</td>
1.379     wiz      14781: <td>describe</td>
1.289     leot     14782: </tr>
                   14783: <tr>
1.391   ! wiz      14784: <td>destdir</td>
1.379     wiz      14785: <td>disable</td>
1.329     leot     14786: </tr>
                   14787: <tr>
1.391   ! wiz      14788: <td>distclean</td>
1.379     wiz      14789: <td>distfiles</td>
1.320     wiz      14790: </tr>
                   14791: <tr>
1.391   ! wiz      14792: <td>distinfo</td>
1.378     leot     14793: <td>dl</td>
1.269     leot     14794: </tr>
                   14795: <tr>
1.391   ! wiz      14796: <td>dlopen</td>
1.378     leot     14797: <td>do-buildlink</td>
1.311     leot     14798: </tr>
                   14799: <tr>
1.391   ! wiz      14800: <td>do-clean</td>
1.378     leot     14801: <td>do-configure</td>
1.269     leot     14802: </tr>
                   14803: <tr>
1.391   ! wiz      14804: <td>do-configure-post-hook</td>
1.378     leot     14805: <td>do-extract</td>
1.269     leot     14806: </tr>
                   14807: <tr>
1.391   ! wiz      14808: <td>do-fetch</td>
1.382     wiz      14809: <td>do-install</td>
                   14810: </tr>
                   14811: <tr>
1.391   ! wiz      14812: <td>download</td>
1.377     jnemeth  14813: <td>emul</td>
1.269     leot     14814: </tr>
                   14815: <tr>
1.391   ! wiz      14816: <td>emul-distinfo</td>
1.377     jnemeth  14817: <td>emul-fetch</td>
1.269     leot     14818: </tr>
                   14819: <tr>
1.391   ! wiz      14820: <td>emulation</td>
1.377     jnemeth  14821: <td>emulator</td>
1.277     rillig   14822: </tr>
                   14823: <tr>
1.391   ! wiz      14824: <td>enable</td>
1.352     wiz      14825: <td>endian</td>
1.376     wiz      14826: </tr>
                   14827: <tr>
1.391   ! wiz      14828: <td>endif</td>
1.365     gutterid 14829: <td>enomem</td>
1.378     leot     14830: </tr>
                   14831: <tr>
1.391   ! wiz      14832: <td>ensurepip</td>
1.378     leot     14833: <td>err</td>
1.367     gdt      14834: </tr>
                   14835: <tr>
1.391   ! wiz      14836: <td>errx</td>
1.378     leot     14837: <td>etc</td>
1.348     wiz      14838: </tr>
                   14839: <tr>
1.391   ! wiz      14840: <td>exp</td>
1.378     leot     14841: <td>extract-rpm</td>
1.269     leot     14842: </tr>
                   14843: <tr>
1.391   ! wiz      14844: <td>fabs</td>
1.378     leot     14845: <td>feature</td>
1.342     wiz      14846: </tr>
                   14847: <tr>
1.391   ! wiz      14848: <td>features</td>
1.378     leot     14849: <td>fetch</td>
1.329     leot     14850: </tr>
                   14851: <tr>
1.391   ! wiz      14852: <td>fetch-list</td>
1.378     leot     14853: <td>follows</td>
1.269     leot     14854: </tr>
                   14855: <tr>
1.391   ! wiz      14856: <td>forbids</td>
1.378     leot     14857: <td>form</td>
1.320     wiz      14858: </tr>
                   14859: <tr>
1.391   ! wiz      14860: <td>format</td>
1.378     leot     14861: <td>fortify</td>
1.352     wiz      14862: </tr>
                   14863: <tr>
1.391   ! wiz      14864: <td>fortify_source</td>
1.382     wiz      14865: <td>fossil</td>
                   14866: </tr>
                   14867: <tr>
1.391   ! wiz      14868: <td>friend</td>
1.377     jnemeth  14869: <td>fts</td>
1.369     wiz      14870: </tr>
                   14871: <tr>
1.391   ! wiz      14872: <td>fts_close</td>
1.377     jnemeth  14873: <td>fts_open</td>
1.355     rillig   14874: </tr>
                   14875: <tr>
1.391   ! wiz      14876: <td>fts_read</td>
1.377     jnemeth  14877: <td>fts_set</td>
1.332     rillig   14878: </tr>
                   14879: <tr>
1.391   ! wiz      14880: <td>gcc</td>
1.377     jnemeth  14881: <td>gethostbyaddr</td>
1.338     nia      14882: </tr>
                   14883: <tr>
1.391   ! wiz      14884: <td>gethostbyname</td>
1.377     jnemeth  14885: <td>gethostbyname2</td>
1.269     leot     14886: </tr>
                   14887: <tr>
1.391   ! wiz      14888: <td>getopt_long</td>
1.377     jnemeth  14889: <td>getprogname</td>
1.269     leot     14890: </tr>
                   14891: <tr>
1.391   ! wiz      14892: <td>getservbyname</td>
1.377     jnemeth  14893: <td>getservbyport</td>
1.269     leot     14894: </tr>
                   14895: <tr>
1.391   ! wiz      14896: <td>getservent</td>
1.352     wiz      14897: <td>gettext</td>
1.376     wiz      14898: </tr>
                   14899: <tr>
1.391   ! wiz      14900: <td>git</td>
1.365     gutterid 14901: <td>github</td>
1.378     leot     14902: </tr>
                   14903: <tr>
1.391   ! wiz      14904: <td>gitlab</td>
1.378     leot     14905: <td>glob</td>
1.367     gdt      14906: </tr>
                   14907: <tr>
1.391   ! wiz      14908: <td>gnu</td>
1.378     leot     14909: <td>gnu_configure_strict</td>
1.348     wiz      14910: </tr>
                   14911: <tr>
1.391   ! wiz      14912: <td>go</td>
1.381     dholland 14913: <td>golang</td>
1.289     leot     14914: </tr>
                   14915: <tr>
1.391   ! wiz      14916: <td>guess-license</td>
1.381     dholland 14917: <td>hashbang</td>
1.342     wiz      14918: </tr>
                   14919: <tr>
1.391   ! wiz      14920: <td>heimdal</td>
1.376     wiz      14921: <td>help</td>
1.352     wiz      14922: </tr>
                   14923: <tr>
1.391   ! wiz      14924: <td>hg</td>
1.375     jkoshy   14925: <td>imake</td>
1.382     wiz      14926: </tr>
                   14927: <tr>
1.391   ! wiz      14928: <td>in-tree</td>
1.382     wiz      14929: <td>increment</td>
1.369     wiz      14930: </tr>
                   14931: <tr>
1.391   ! wiz      14932: <td>indirect</td>
1.382     wiz      14933: <td>inet_aton</td>
1.355     rillig   14934: </tr>
                   14935: <tr>
1.391   ! wiz      14936: <td>install</td>
1.382     wiz      14937: <td>install-env</td>
1.379     wiz      14938: </tr>
                   14939: <tr>
1.391   ! wiz      14940: <td>interp</td>
1.382     wiz      14941: <td>interpreter</td>
1.269     leot     14942: </tr>
                   14943: <tr>
1.391   ! wiz      14944: <td>intl</td>
1.382     wiz      14945: <td>ip4</td>
1.329     leot     14946: </tr>
                   14947: <tr>
1.391   ! wiz      14948: <td>ip6</td>
1.382     wiz      14949: <td>ipv4</td>
1.269     leot     14950: </tr>
                   14951: <tr>
1.391   ! wiz      14952: <td>ipv6</td>
1.382     wiz      14953: <td>iso</td>
1.320     wiz      14954: </tr>
                   14955: <tr>
1.391   ! wiz      14956: <td>kerberos</td>
1.382     wiz      14957: <td>krb</td>
1.311     leot     14958: </tr>
                   14959: <tr>
1.391   ! wiz      14960: <td>krb5</td>
1.382     wiz      14961: <td>ksh</td>
1.269     leot     14962: </tr>
                   14963: <tr>
1.391   ! wiz      14964: <td>lapack</td>
1.382     wiz      14965: <td>latex</td>
1.269     leot     14966: </tr>
                   14967: <tr>
1.391   ! wiz      14968: <td>libiconv</td>
1.382     wiz      14969: <td>libintl_bindtextdomain</td>
1.269     leot     14970: </tr>
                   14971: <tr>
1.391   ! wiz      14972: <td>libintl_gettext</td>
1.382     wiz      14973: <td>libintl_textdomain</td>
1.269     leot     14974: </tr>
                   14975: <tr>
1.391   ! wiz      14976: <td>libnbcompat</td>
1.382     wiz      14977: <td>libs</td>
1.303     bacon    14978: </tr>
                   14979: <tr>
1.391   ! wiz      14980: <td>libtool</td>
1.382     wiz      14981: <td>licence</td>
1.303     bacon    14982: </tr>
                   14983: <tr>
1.391   ! wiz      14984: <td>license</td>
1.382     wiz      14985: <td>lintl</td>
1.269     leot     14986: </tr>
                   14987: <tr>
1.391   ! wiz      14988: <td>little-endian</td>
1.382     wiz      14989: <td>lock</td>
1.292     leot     14990: </tr>
                   14991: <tr>
1.391   ! wiz      14992: <td>locking</td>
1.382     wiz      14993: <td>lua</td>
1.269     leot     14994: </tr>
                   14995: <tr>
1.391   ! wiz      14996: <td>lvalue</td>
1.382     wiz      14997: <td>machine_endian</td>
1.289     leot     14998: </tr>
                   14999: <tr>
1.391   ! wiz      15000: <td>make</td>
1.382     wiz      15001: <td>makedistinfo</td>
1.274     rillig   15002: </tr>
                   15003: <tr>
1.391   ! wiz      15004: <td>makepatchsum</td>
1.382     wiz      15005: <td>makesum</td>
1.377     jnemeth  15006: </tr>
                   15007: <tr>
1.391   ! wiz      15008: <td>mdi</td>
1.382     wiz      15009: <td>memory</td>
1.360     leot     15010: </tr>
                   15011: <tr>
1.391   ! wiz      15012: <td>mercurial</td>
1.381     dholland 15013: <td>meta</td>
1.378     leot     15014: </tr>
                   15015: <tr>
1.391   ! wiz      15016: <td>meta-package</td>
1.381     dholland 15017: <td>meta_package</td>
1.376     wiz      15018: </tr>
                   15019: <tr>
1.391   ! wiz      15020: <td>mit-krb5</td>
1.381     dholland 15021: <td>mk.conf</td>
1.367     gdt      15022: </tr>
                   15023: <tr>
1.391   ! wiz      15024: <td>mkl</td>
1.381     dholland 15025: <td>mount</td>
1.271     brook    15026: </tr>
                   15027: <tr>
1.391   ! wiz      15028: <td>move</td>
1.381     dholland 15029: <td>moved</td>
1.348     wiz      15030: </tr>
                   15031: <tr>
1.391   ! wiz      15032: <td>mprotect</td>
1.381     dholland 15033: <td>mps</td>
1.342     wiz      15034: </tr>
                   15035: <tr>
1.391   ! wiz      15036: <td>mremap</td>
1.381     dholland 15037: <td>native</td>
1.269     leot     15038: </tr>
                   15039: <tr>
1.391   ! wiz      15040: <td>nb</td>
1.381     dholland 15041: <td>nbcompat</td>
1.269     leot     15042: </tr>
                   15043: <tr>
1.391   ! wiz      15044: <td>netlib</td>
1.381     dholland 15045: <td>network</td>
1.292     leot     15046: </tr>
                   15047: <tr>
1.391   ! wiz      15048: <td>node</td>
1.381     dholland 15049: <td>node.js</td>
1.370     gdt      15050: </tr>
                   15051: <tr>
1.391   ! wiz      15052: <td>nodejs</td>
1.381     dholland 15053: <td>obstack</td>
1.274     rillig   15054: </tr>
                   15055: <tr>
1.391   ! wiz      15056: <td>obstack_ptr_grow</td>
1.381     dholland 15057: <td>occurs</td>
1.341     gutterid 15058: </tr>
                   15059: <tr>
1.391   ! wiz      15060: <td>only</td>
1.381     dholland 15061: <td>openblas</td>
1.269     leot     15062: </tr>
                   15063: <tr>
1.391   ! wiz      15064: <td>options</td>
1.381     dholland 15065: <td>options.mk</td>
1.269     leot     15066: </tr>
                   15067: <tr>
1.391   ! wiz      15068: <td>order</td>
1.381     dholland 15069: <td>override</td>
1.333     nia      15070: </tr>
                   15071: <tr>
1.391   ! wiz      15072: <td>override-intltool</td>
1.381     dholland 15073: <td>override-message-intltool</td>
1.333     nia      15074: </tr>
                   15075: <tr>
1.391   ! wiz      15076: <td>package</td>
1.381     dholland 15077: <td>parallel</td>
1.320     wiz      15078: </tr>
                   15079: <tr>
1.391   ! wiz      15080: <td>path</td>
1.381     dholland 15081: <td>pax</td>
1.269     leot     15082: </tr>
                   15083: <tr>
1.391   ! wiz      15084: <td>paxctl</td>
1.381     dholland 15085: <td>pbulk-index</td>
1.269     leot     15086: </tr>
                   15087: <tr>
1.391   ! wiz      15088: <td>pc</td>
1.381     dholland 15089: <td>perl</td>
1.269     leot     15090: </tr>
                   15091: <tr>
1.391   ! wiz      15092: <td>perl5</td>
1.381     dholland 15093: <td>perms</td>
1.271     brook    15094: </tr>
                   15095: <tr>
1.391   ! wiz      15096: <td>php</td>
1.381     dholland 15097: <td>pkg-build-options</td>
1.269     leot     15098: </tr>
                   15099: <tr>
1.391   ! wiz      15100: <td>pkg-config</td>
1.381     dholland 15101: <td>pkg_build_options</td>
1.269     leot     15102: </tr>
                   15103: <tr>
1.391   ! wiz      15104: <td>pkgsrc</td>
1.381     dholland 15105: <td>platform</td>
1.269     leot     15106: </tr>
                   15107: <tr>
1.391   ! wiz      15108: <td>plist</td>
1.381     dholland 15109: <td>post-extract</td>
1.269     leot     15110: </tr>
                   15111: <tr>
1.391   ! wiz      15112: <td>post-fetch</td>
1.381     dholland 15113: <td>post-wrapper</td>
1.269     leot     15114: </tr>
                   15115: <tr>
1.391   ! wiz      15116: <td>pre-build-checks-hook</td>
1.381     dholland 15117: <td>pre-configure-checks-hook</td>
1.269     leot     15118: </tr>
                   15119: <tr>
1.391   ! wiz      15120: <td>pre-extract</td>
1.381     dholland 15121: <td>pre-fetch</td>
1.269     leot     15122: </tr>
                   15123: <tr>
1.391   ! wiz      15124: <td>print-plist</td>
1.376     wiz      15125: <td>print-summary-data</td>
1.269     leot     15126: </tr>
                   15127: <tr>
1.391   ! wiz      15128: <td>privileged-install-hook</td>
1.376     wiz      15129: <td>pypi</td>
1.269     leot     15130: </tr>
                   15131: <tr>
1.391   ! wiz      15132: <td>python</td>
1.376     wiz      15133: <td>r</td>
1.269     leot     15134: </tr>
                   15135: <tr>
1.391   ! wiz      15136: <td>readme-all</td>
1.376     wiz      15137: <td>recursive</td>
1.289     leot     15138: </tr>
                   15139: <tr>
1.391   ! wiz      15140: <td>recv</td>
1.376     wiz      15141: <td>recvfrom</td>
1.269     leot     15142: </tr>
                   15143: <tr>
1.391   ! wiz      15144: <td>regcomp</td>
1.376     wiz      15145: <td>release-localbase-lock</td>
1.269     leot     15146: </tr>
                   15147: <tr>
1.391   ! wiz      15148: <td>release-lock</td>
1.376     wiz      15149: <td>relro</td>
1.269     leot     15150: </tr>
                   15151: <tr>
1.391   ! wiz      15152: <td>remove</td>
1.376     wiz      15153: <td>removed</td>
1.269     leot     15154: </tr>
                   15155: <tr>
1.391   ! wiz      15156: <td>rename</td>
1.376     wiz      15157: <td>renamed</td>
1.269     leot     15158: </tr>
                   15159: <tr>
1.391   ! wiz      15160: <td>reorder</td>
1.376     wiz      15161: <td>replace</td>
1.289     leot     15162: </tr>
                   15163: <tr>
1.391   ! wiz      15164: <td>replace_interpreter</td>
1.376     wiz      15165: <td>reproducible</td>
1.289     leot     15166: </tr>
                   15167: <tr>
1.391   ! wiz      15168: <td>resolv</td>
1.376     wiz      15169: <td>root</td>
1.269     leot     15170: </tr>
                   15171: <tr>
1.391   ! wiz      15172: <td>ruby</td>
1.376     wiz      15173: <td>send</td>
1.341     gutterid 15174: </tr>
                   15175: <tr>
1.391   ! wiz      15176: <td>sendfile</td>
1.376     wiz      15177: <td>sendto</td>
1.341     gutterid 15178: </tr>
                   15179: <tr>
1.391   ! wiz      15180: <td>setenv</td>
1.376     wiz      15181: <td>setgid</td>
1.269     leot     15182: </tr>
                   15183: <tr>
1.391   ! wiz      15184: <td>setprogname</td>
1.376     wiz      15185: <td>setuid</td>
1.269     leot     15186: </tr>
                   15187: <tr>
1.391   ! wiz      15188: <td>sh</td>
1.376     wiz      15189: <td>shebang</td>
1.269     leot     15190: </tr>
                   15191: <tr>
1.391   ! wiz      15192: <td>show</td>
1.376     wiz      15193: <td>show-all</td>
1.289     leot     15194: </tr>
                   15195: <tr>
1.391   ! wiz      15196: <td>show-build-defs</td>
1.376     wiz      15197: <td>show-depends</td>
1.269     leot     15198: </tr>
                   15199: <tr>
1.391   ! wiz      15200: <td>show-depends-dirs</td>
1.376     wiz      15201: <td>show-depends-pkgpaths</td>
1.269     leot     15202: </tr>
                   15203: <tr>
1.391   ! wiz      15204: <td>show-depends-recursive</td>
1.376     wiz      15205: <td>show-deps</td>
1.269     leot     15206: </tr>
                   15207: <tr>
1.391   ! wiz      15208: <td>show-distfiles</td>
1.376     wiz      15209: <td>show-downlevel</td>
1.269     leot     15210: </tr>
                   15211: <tr>
1.391   ! wiz      15212: <td>show-subdir-var</td>
1.376     wiz      15213: <td>show-tools</td>
1.296     rillig   15214: </tr>
                   15215: <tr>
1.391   ! wiz      15216: <td>show-var</td>
1.376     wiz      15217: <td>show-vars</td>
1.269     leot     15218: </tr>
                   15219: <tr>
1.391   ! wiz      15220: <td>snprintf</td>
1.376     wiz      15221: <td>socket</td>
1.337     gutterid 15222: </tr>
                   15223: <tr>
1.391   ! wiz      15224: <td>ssp</td>
1.376     wiz      15225: <td>st_mode</td>
1.338     nia      15226: </tr>
                   15227: <tr>
1.391   ! wiz      15228: <td>stage-install</td>
1.376     wiz      15229: <td>strcasestr</td>
1.269     leot     15230: </tr>
                   15231: <tr>
1.391   ! wiz      15232: <td>strict</td>
1.376     wiz      15233: <td>strip</td>
1.269     leot     15234: </tr>
                   15235: <tr>
1.391   ! wiz      15236: <td>strndup</td>
1.376     wiz      15237: <td>strnlen</td>
1.269     leot     15238: </tr>
                   15239: <tr>
1.391   ! wiz      15240: <td>strsep</td>
1.376     wiz      15241: <td>subst</td>
1.369     wiz      15242: </tr>
                   15243: <tr>
1.391   ! wiz      15244: <td>substitutions</td>
1.382     wiz      15245: <td>subversion</td>
                   15246: </tr>
                   15247: <tr>
1.391   ! wiz      15248: <td>sun</td>
1.369     wiz      15249: <td>sunpro</td>
1.329     leot     15250: </tr>
                   15251: <tr>
1.391   ! wiz      15252: <td>sunwspro</td>
1.382     wiz      15253: <td>svn</td>
1.378     leot     15254: </tr>
                   15255: <tr>
1.391   ! wiz      15256: <td>symlink</td>
1.368     gutterid 15257: <td>test</td>
1.367     gdt      15258: </tr>
                   15259: <tr>
1.391   ! wiz      15260: <td>test-env</td>
1.368     gutterid 15261: <td>tex</td>
1.327     wiz      15262: </tr>
                   15263: <tr>
1.391   ! wiz      15264: <td>texlive</td>
1.368     gutterid 15265: <td>tmp</td>
1.342     wiz      15266: </tr>
                   15267: <tr>
1.391   ! wiz      15268: <td>todo</td>
1.368     gutterid 15269: <td>tool</td>
1.338     nia      15270: </tr>
                   15271: <tr>
1.391   ! wiz      15272: <td>tools</td>
1.368     gutterid 15273: <td>tools-libtool-m4-override</td>
1.269     leot     15274: </tr>
                   15275: <tr>
1.391   ! wiz      15276: <td>transitive</td>
1.368     gutterid 15277: <td>type</td>
1.269     leot     15278: </tr>
                   15279: <tr>
1.391   ! wiz      15280: <td>ulimit</td>
1.368     gutterid 15281: <td>undefined</td>
1.269     leot     15282: </tr>
                   15283: <tr>
1.391   ! wiz      15284: <td>undo-replace</td>
1.368     gutterid 15285: <td>unlimit</td>
1.269     leot     15286: </tr>
                   15287: <tr>
1.391   ! wiz      15288: <td>unprivileged</td>
1.368     gutterid 15289: <td>unprivileged-install-hook</td>
1.269     leot     15290: </tr>
                   15291: <tr>
1.391   ! wiz      15292: <td>unstripped</td>
1.368     gutterid 15293: <td>update</td>
1.269     leot     15294: </tr>
                   15295: <tr>
1.391   ! wiz      15296: <td>updated</td>
1.368     gutterid 15297: <td>upload</td>
1.269     leot     15298: </tr>
                   15299: <tr>
1.391   ! wiz      15300: <td>upload-distfiles</td>
1.368     gutterid 15301: <td>use_tools</td>
1.269     leot     15302: </tr>
                   15303: <tr>
1.391   ! wiz      15304: <td>user</td>
1.368     gutterid 15305: <td>utimes</td>
1.269     leot     15306: </tr>
                   15307: <tr>
1.391   ! wiz      15308: <td>vasprintf</td>
1.368     gutterid 15309: <td>verbose</td>
1.269     leot     15310: </tr>
                   15311: <tr>
1.391   ! wiz      15312: <td>vsnprintf</td>
1.368     gutterid 15313: <td>warn</td>
1.269     leot     15314: </tr>
                   15315: <tr>
1.391   ! wiz      15316: <td>warning</td>
1.368     gutterid 15317: <td>warnings</td>
1.269     leot     15318: </tr>
                   15319: <tr>
1.391   ! wiz      15320: <td>warnx</td>
1.368     gutterid 15321: <td>wattr_off</td>
1.269     leot     15322: </tr>
                   15323: <tr>
1.391   ! wiz      15324: <td>wattr_on</td>
1.368     gutterid 15325: <td>work</td>
1.269     leot     15326: </tr>
                   15327: <tr>
1.391   ! wiz      15328: <td>wrapper</td>
1.289     leot     15329: <td>wrkdir</td>
1.269     leot     15330: </tr>
                   15331: </table>
1.267     rillig   15332: </div>
                   15333: <div class="appendix">
                   15334: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     15335: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   15336: <div class="toc">
                   15337: <p><b>Table of Contents</b></p>
1.210     leot     15338: <dl class="toc">
1.322     leot     15339: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   15340: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig   15341: </dl>
                   15342: </div>
1.79      rillig   15343: <p>This section contains information on editing the pkgsrc
                   15344:        guide itself.</p>
1.148     asau     15345: <div class="sect1">
1.75      rillig   15346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     15347: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79      rillig   15348: <p>The pkgsrc guide's source code is stored in
                   15349:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   15350:        are created from it:</p>
1.148     asau     15351: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      15352: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   15353: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     15354: <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>
                   15355: <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   15356:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     15357: <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   15358:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   15359: </ul></div>
                   15360: </div>
1.148     asau     15361: <div class="sect1">
1.75      rillig   15362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     15363: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79      rillig   15364: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      15365: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    15366: <li class="step"><p>Make sure you have checked out the htdocs repository
                   15367:        into a sibling directory of your pkgsrc directory.  You will need
                   15368:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     15369: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      15370:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   15371:        documentation) installed. These are automatically installed when
1.322     leot     15372:        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     15373: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   15374:        right directory. All further steps will take place
                   15375:        here.</p></li>
1.148     asau     15376: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   15377:        <code class="filename">files/</code>.</p></li>
1.148     asau     15378: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   15379:        guide for valid XML and to build the final output files. If you
                   15380:        get any errors at this stage, you can just edit the files, as
                   15381:        there are only symbolic links in the working directory, pointing
                   15382:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     15383: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   15384:        commit)</strong></span></p></li>
1.148     asau     15385: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   15386:        regenerate the output files with the proper RCS
                   15387:        Ids.</p></li>
1.148     asau     15388: <li class="step">
1.110     hubertf  15389: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   15390:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   15391:        <code class="filename">htdocs</code>.</p>
1.148     asau     15392: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   15393: <h3 class="title">Note</h3>
                   15394: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  15395:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   15396:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   15397:        directory.</p>
                   15398: </div>
                   15399: </li>
1.79      rillig   15400: </ol></div>
1.75      rillig   15401: </div>
                   15402: </div>
                   15403: </div></body>
1.1       grant    15404: </html>

CVSweb <webmaster@jp.NetBSD.org>