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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.392     wiz         4: <meta 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.394     wiz       126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk 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.394     wiz       128: <dt><span class="sect1"><a href="#bulk.bob">8.3. Running a bob build</a></span></dt>
                    129: <dt><span class="sect1"><a href="#bulk.scan">8.4. Speeding up bulk build scans</a></span></dt>
                    130: <dt><span class="sect1"><a href="#bulk.req">8.5. Requirements of a full bulk build</a></span></dt>
                    131: <dt><span class="sect1"><a href="#bulk.var">8.6. Bulk build variants</a></span></dt>
                    132: <dd><dl>
                    133: <dt><span class="sect2"><a href="#bulk.var.confopt">8.6.1. Detect unknown configure options</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.comperr">8.6.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.builderr">8.6.3. Force compiler options only in the build phase</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.dirs">8.6.4. Use custom directories</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.warn">8.6.5. Turn warnings into errors</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.6.6. Reject packages for which pkglint reports errors</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.strings">8.6.7. Reject packages that contain forbidden strings</a></span></dt>
                    140: <dt><span class="sect2"><a href="#bulk.var.test">8.6.8. Reject packages whose self-test fails</a></span></dt>
                    141: <dt><span class="sect2"><a href="#bulk.var.shvar">8.6.9. Reject packages that use undefined shell variables</a></span></dt>
                    142: <dt><span class="sect2"><a href="#bulk.var.quiet">8.6.10. Turn off verbose logging</a></span></dt>
1.293     rillig    143: </dl></dd>
1.394     wiz       144: <dt><span class="sect1"><a href="#creating-cdroms">8.7. Creating a multiple CD-ROM packages collection</a></span></dt>
                    145: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.7.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    146: </dl></dd>
                    147: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    148: <dd><dl>
                    149: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    150: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    151: </dl></dd>
                    152: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    153: <dd><dl>
                    154: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    156: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    157: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    158: <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>
                    159: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    160: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    161: <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>
                    162: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot      163: <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
                    164: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                    165: <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       166: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    167: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    169: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    170: <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      171: <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    172: </dl></dd>
                    173: </dl></dd>
                    174: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    175: <dd><dl>
1.267     rillig    176: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    177: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    178: <dd><dl>
1.299     rillig    179: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    180: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    181: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    182: <dd><dl>
1.299     rillig    183: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    186: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    187: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    188: </dl></dd>
1.299     rillig    189: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    190: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    191: <dd><dl>
                    192: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    194: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    195: </dl></dd>
                    196: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    197: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    198: </dl></dd>
1.299     rillig    199: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    200: <dd><dl>
1.299     rillig    201: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    203: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    204: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    205: <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    206: <dd><dl>
1.299     rillig    207: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    208: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    209: </dl></dd>
1.299     rillig    210: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    219: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    220: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    221: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    222: </dl></dd>
                    223: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    224: <dd><dl>
                    225: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    226: <dd><dl>
1.334     nia       227: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                    228: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                    229: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig    230: </dl></dd>
1.299     rillig    231: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    232: <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    233: </dl></dd>
1.299     rillig    234: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    235: <dd><dl>
1.299     rillig    236: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    237: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    238: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    239: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    240: <dd><dl>
1.299     rillig    241: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    242: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    243: <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>
                    244: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid  245: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig    246: </dl></dd>
                    247: </dl></dd>
1.299     rillig    248: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    249: <dd><dl>
1.299     rillig    250: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    251: <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>
                    252: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    253: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    254: </dl></dd>
1.299     rillig    255: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    256: <dd><dl>
1.299     rillig    257: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    258: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    259: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    260: </dl></dd>
                    261: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    262: <dd><dl>
                    263: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    264: <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    265: <dd><dl>
1.299     rillig    266: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    267: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       268:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    269:       and
                    270:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    271:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    272: </dl></dd>
1.299     rillig    273: <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    274: <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    275: </dl></dd>
                    276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig    277: <dd><dl>
1.299     rillig    278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    280: <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>
                    281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig    287: </dl></dd>
1.299     rillig    288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    289: <dd><dl>
                    290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    291: <dd><dl>
                    292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig    294: </dl></dd>
1.299     rillig    295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig    296: <dd><dl>
1.299     rillig    297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    298: <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  299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                    300: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                    301: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig    302: </dl></dd>
                    303: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    304: <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>
                    305: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    306: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    307: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    308: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    309: <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    310: </dl></dd>
                    311: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    312: <dd><dl>
                    313: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    314: <dd><dl>
                    315: <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>
                    316: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    317: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    318: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    319: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    320: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    321: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    322: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    323: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    324: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    325: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    326: </dl></dd>
                    327: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    328: <dd><dl>
                    329: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    330: <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>
                    331: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    332: </dl></dd>
                    333: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    334: <dd><dl>
                    335: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    336: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    337: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia       338: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz       339: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig    340: </dl></dd>
                    341: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    342: <dd><dl>
                    343: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    344: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz       345: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia       346: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                    347: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                    348: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                    349: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig    350: </dl></dd>
                    351: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    352: <dd><dl>
                    353: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    354: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    355: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot      356: <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    357: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    358: </dl></dd>
                    359: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    360: <dd><dl>
                    361: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    362: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    363: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    364: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    365: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia       366: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz       367: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                    368: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                    369: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                    370: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                    371: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                    372: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                    373: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                    374: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                    375: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                    376: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz       377:     emulation</a></span></dt>
1.369     wiz       378: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                    379: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig    380: </dl></dd>
1.267     rillig    381: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    382: </dl></dd>
1.299     rillig    383: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    384: <dd><dl>
                    385: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    386: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    387: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    388: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    389: </dl></dd>
1.267     rillig    390: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    391: <dd><dl>
1.267     rillig    392: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    394: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    395: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    396: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    397: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    398: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    399: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    400: </dl></dd>
1.382     wiz       401: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                    402: <dd><dl>
                    403: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                    404: <dd><dl>
                    405: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                    406: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                    407: </dl></dd>
                    408: </dl></dd>
                    409: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig    410: </dl></dd>
                    411: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    412: <dd><dl>
1.382     wiz       413: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    414: <dd><dl>
1.382     wiz       415: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    416: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    417: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig    418: <dd><dl>
1.382     wiz       419: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    420: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig    421: </dl></dd>
1.382     wiz       422: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    423: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    424: <dd><dl>
1.382     wiz       425: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    426: <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    427: </dl></dd>
1.382     wiz       428: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig    429: <dd><dl>
1.382     wiz       430: <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>
                    431: <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    432: </dl></dd>
                    433: </dl></dd>
1.382     wiz       434: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig    435: <dd><dl>
1.382     wiz       436: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    437: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig    438: <dd><dl>
1.382     wiz       439: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    440: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig    441: </dl></dd>
                    442: </dl></dd>
1.382     wiz       443: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    444: <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    445: </dl></dd>
                    446: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    447: <dd><dl>
                    448: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    449: <dd><dl>
                    450: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    451: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    452: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    453: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    454: </dl></dd>
                    455: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    456: </dl></dd>
1.322     leot      457: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75      rillig    458: <dd><dl>
1.322     leot      459: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                    460: <dd><dl>
                    461: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                    462: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                    463: </dl></dd>
                    464: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                    465: <dd><dl>
                    466: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                    467: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                    468: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                    469: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                    470: </dl></dd>
                    471: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                    472: <dd><dl>
                    473: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                    474: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                    475: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                    476: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                    477: </dl></dd>
                    478: </dl></dd>
                    479: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
                    480: <dd><dl>
                    481: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                    482: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75      rillig    483: </dl></dd>
1.322     leot      484: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76      rillig    485: <dd><dl>
1.322     leot      486: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    487: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    488: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    489: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    490: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261     leot      491: <code class="filename">stable</code>,
1.128     wiz       492: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    493: source packages</a></span></dt>
                    494: </dl></dd>
1.322     leot      495: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
                    496: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    497: <dd><dl>
1.322     leot      498: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                    499: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig    500: </dl></dd>
                    501: </dl>
                    502: </div>
1.82      rillig    503: <div class="list-of-tables">
                    504: <p><b>List of Tables</b></p>
                    505: <dl>
                    506: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    507: </dt>
1.299     rillig    508: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      509: </dt>
1.299     rillig    510: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      511: </dt>
1.82      rillig    512: </dl>
                    513: </div>
1.148     asau      514: <div class="chapter">
                    515: <div class="titlepage"><div><div><h1 class="title">
1.385     leot      516: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    517: <div class="toc">
                    518: <p><b>Table of Contents</b></p>
1.210     leot      519: <dl class="toc">
1.75      rillig    520: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    521: <dd><dl>
                    522: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    523: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    524: </dl></dd>
1.75      rillig    525: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    526: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       527: <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    528: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    529: </dl>
                    530: </div>
1.148     asau      531: <div class="sect1">
1.75      rillig    532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      533: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    534: <p>There is a lot of software freely available for Unix-based
                    535: systems, which is usually available in form of the source code. Before
                    536: such software can be used, it needs to be configured to the local
                    537: system, compiled and installed, and this is exactly what The NetBSD
                    538: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    539: to handle binary packages, so that not every user has to build the
                    540: packages for himself, which is a time-costly task.</p>
1.75      rillig    541: <p>pkgsrc currently contains several thousand packages,
                    542:       including:</p>
1.148     asau      543: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot      544: <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    545:          web server</p></li>
1.322     leot      546: <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    547:          web browser</p></li>
1.322     leot      548: <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    549:          Desktop Environment</p></li>
1.322     leot      550: <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    551:          Desktop Environment</p></li>
                    552: </ul></div>
1.385     leot      553: <p>… just to name a few.</p>
1.75      rillig    554: <p>pkgsrc has built-in support for handling varying dependencies,
                    555:       such as pthreads and X11, and extended features such as IPv6 support on
                    556:       a range of platforms.</p>
1.148     asau      557: <div class="sect2">
1.82      rillig    558: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      559: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
1.82      rillig    560: <p>
                    561: pkgsrc provides the following key features:
                    562: </p>
1.148     asau      563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       564: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    565:   and installation of binary packages. The source and latest
                    566:   patches are retrieved from a master or mirror download site, checksum
                    567:   verified, then built on your system. Support for binary-only
                    568:   distributions is available for both native platforms and NetBSD
                    569:   emulated platforms.</p></li>
1.128     wiz       570: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    571:   including binaries, libraries, man pages and other
                    572:   documentation.</p></li>
1.214     sevan     573: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    574:   performing updates, to ensure required packages are installed. The
                    575:   configuration files of various packages are handled automatically during
                    576:   updates, so local changes are preserved.</p></li>
1.128     wiz       577: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    578:   consists of highly portable code. This allows the greatest speed of
1.132     spz       579:   development when porting to a new platform. This portability also
1.82      rillig    580:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    581:   platforms</em></span>.</p></li>
1.128     wiz       582: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    583:   international encryption requirements and build-time options for a
                    584:   large number of packages are all set in a simple, central
                    585:   configuration file.</p></li>
1.128     wiz       586: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    587:   freely available under a BSD license, so you may extend and adapt
                    588:   pkgsrc to your needs. Support for local packages and patches is
                    589:   available right out of the box, so you can configure it specifically
                    590:   for your environment.</p></li>
                    591: </ul></div>
1.91      rillig    592: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      593: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.385     leot      594: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126     jakllsch  595: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    596: them and to complain about them rather than to just install the package
                    597: and hope that it works. There are numerous checks in pkgsrc that try to
1.322     leot      598: 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    599: of shell scripts), and post-installation checks (installed files,
                    600: references to shared libraries, script interpreters).</p></li>
1.385     leot      601: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126     jakllsch  602: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    603: pkgsrc has been ported to many operating systems. Care is taken that
                    604: packages behave the same on all platforms.</p></li>
                    605: </ul></div>
1.82      rillig    606: </div>
1.148     asau      607: <div class="sect2">
1.82      rillig    608: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      609: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
1.82      rillig    610: <p>pkgsrc consists of both a source distribution and a binary
                    611: distribution for these operating systems. After retrieving the required
                    612: source or binaries, you can be up and running with pkgsrc in just
                    613: minutes!</p>
1.75      rillig    614: <p>pkgsrc was derived from FreeBSD's ports system, and
                    615:       initially developed for NetBSD only. Since then, pkgsrc has
                    616:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    617: <div class="table">
1.385     leot      618: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       619: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    620: <colgroup>
                    621: <col>
                    622: <col>
1.202     sevan     623: <col>
1.82      rillig    624: </colgroup>
                    625: <thead><tr>
                    626: <th>Platform</th>
                    627: <th>Date Support Added</th>
1.202     sevan     628: <th>Notes</th>
1.82      rillig    629: </tr></thead>
                    630: <tbody>
                    631: <tr>
1.289     leot      632: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    633: <td align="center">Aug 1997</td>
1.385     leot      634: <td class="auto-generated"> </td>
1.82      rillig    635: </tr>
                    636: <tr>
1.110     hubertf   637: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    638: <td align="center">Mar 1999</td>
1.264     sevan     639: <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    640: </tr>
                    641: <tr>
1.289     leot      642: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    643: <td align="center">Jun 1999</td>
1.264     sevan     644: <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    645: </tr>
                    646: <tr>
                    647: <td>
1.230     sevan     648:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    649:         </td>
                    650: <td align="center">Oct 2001</td>
1.305     bacon     651: <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    652: </tr>
                    653: <tr>
1.289     leot      654: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    655: <td align="center">Nov 2002</td>
1.264     sevan     656: <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    657: </tr>
                    658: <tr>
1.289     leot      659: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    660: <td align="center">Nov 2002</td>
1.264     sevan     661: <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    662: </tr>
                    663: <tr>
1.289     leot      664: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    665: <td align="center">Dec 2002</td>
1.202     sevan     666: <td>
1.264     sevan     667:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202     sevan     668:        </td>
1.82      rillig    669: </tr>
                    670: <tr>
                    671: <td>BSD/OS</td>
                    672: <td align="center">Dec 2003</td>
1.381     dholland  673: <td align="center">Removed from pkgsrc Mar 2025</td>
1.82      rillig    674: </tr>
                    675: <tr>
1.289     leot      676: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    677: <td align="center">Dec 2003</td>
1.264     sevan     678: <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    679: </tr>
                    680: <tr>
                    681: <td>
1.289     leot      682:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    683:           (Microsoft Windows Services for Unix)
                    684:         </td>
                    685: <td align="center">Mar 2004</td>
1.383     wiz       686: <td align="center">Removed from pkgsrc Apr 2025</td>
1.82      rillig    687: </tr>
                    688: <tr>
1.289     leot      689: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    690: <td align="center">Oct 2004</td>
1.385     leot      691: <td class="auto-generated"> </td>
1.82      rillig    692: </tr>
                    693: <tr>
1.110     hubertf   694: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    695: <td align="center">Nov 2004</td>
1.264     sevan     696: <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    697: </tr>
1.98      wiz       698: <tr>
1.289     leot      699: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       700: <td align="center">Apr 2007</td>
1.264     sevan     701: <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       702: </tr>
1.128     wiz       703: <tr>
1.289     leot      704: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       705: <td align="center">Sep 2010</td>
1.264     sevan     706: <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       707: </tr>
1.151     obache    708: <tr>
1.289     leot      709: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  710: <td align="center">Jan 2011</td>
1.381     dholland  711: <td align="center">Removed from pkgsrc Mar 2025</td>
1.151     obache    712: </tr>
                    713: <tr>
1.289     leot      714: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    715: <td align="center">Nov 2011</td>
1.264     sevan     716: <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    717: </tr>
                    718: <tr>
1.289     leot      719: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    720: <td align="center">Mar 2013</td>
1.264     sevan     721: <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    722: </tr>
1.166     jnemeth   723: <tr>
1.289     leot      724: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   725: <td align="center">Jul 2013</td>
1.380     maya      726: <td>Removed from pkgsrc Mar 2025</td>
1.166     jnemeth   727: </tr>
1.214     sevan     728: <tr>
1.289     leot      729: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     730: <td align="center">Jun 2014</td>
1.344     gutterid  731: <td>Removed from pkgsrc Sep 2022</td>
1.214     sevan     732: </tr>
1.82      rillig    733: </tbody>
1.91      rillig    734: </table></div>
1.82      rillig    735: </div>
1.91      rillig    736: <br class="table-break">
1.82      rillig    737: </div>
1.75      rillig    738: </div>
1.148     asau      739: <div class="sect1">
1.75      rillig    740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      741: <a name="overview"></a>1.2. Overview</h2></div></div></div>
1.75      rillig    742: <p>This document is divided into three parts. The first,
1.385     leot      743:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    744:        describes how one can use one of the packages in the Package
                    745:        Collection, either by installing a precompiled binary package,
1.93      rillig    746:        or by building one's own copy using the NetBSD package system.
1.385     leot      747:        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    748:        package so it can be easily built by other NetBSD users without
                    749:        knowing about the package's building details. The third part,
1.385     leot      750:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    751:        is intended for those who want to understand how pkgsrc is
                    752:        implemented.</p>
                    753: <p>This document is available in various formats:
1.110     hubertf   754:        <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    755: </div>
1.148     asau      756: <div class="sect1">
1.75      rillig    757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      758: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    759: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
                    760:       <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75      rillig    761:       terminology used within this document.</p>
1.148     asau      762: <div class="variablelist"><dl class="variablelist">
1.75      rillig    763: <dt><span class="term">Package</span></dt>
                    764: <dd><p>A set of files and building instructions
                    765:            that describe what's necessary
                    766:            to build a certain piece of software using
                    767:             pkgsrc. Packages are traditionally stored under
1.236     wiz       768:            <code class="filename">/usr/pkgsrc</code>,
                    769:            but may be stored in any location,
                    770:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    771: <dt><span class="term">The NetBSD package system</span></dt>
1.385     leot      772: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>.  It
1.87      wiz       773:          is part of the NetBSD operating system and can be bootstrapped
                    774:          to run on non-NetBSD operating systems as well.  It handles
                    775:          building (compiling), installing, and removing of
                    776:          packages.</p></dd>
1.75      rillig    777: <dt><span class="term">Distfile</span></dt>
                    778: <dd><p>This term describes the file or files that are
                    779:            provided by the author of the piece of software to
                    780:            distribute his work. All the changes necessary to build on
                    781:            NetBSD are reflected in the corresponding package. Usually
                    782:            the distfile is in the form of a compressed tar-archive,
                    783:            but other types are possible, too. Distfiles are usually
                    784:            stored below
1.76      rillig    785:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    786: <dt><span class="term">Port</span></dt>
                    787: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    788:            for what we call a package.
1.385     leot      789:            In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75      rillig    790:            architecture.</p></dd>
                    791: <dt><span class="term">Precompiled/binary package</span></dt>
                    792: <dd>
                    793: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    794:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    795:            file so it can be installed on machines of the same
                    796:            machine architecture without the need to
                    797:            recompile. Packages are usually generated in
1.76      rillig    798:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       799:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.385     leot      800: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75      rillig    801:            especially in the context of precompiled packages.</p>
                    802: </dd>
                    803: <dt><span class="term">Program</span></dt>
1.88      wiz       804: <dd><p>The piece of software to be installed which will be
                    805:          constructed from all the files in the distfile by the
                    806:          actions defined in the corresponding package.</p></dd>
1.75      rillig    807: </dl></div>
1.148     asau      808: <div class="sect2">
1.75      rillig    809: <div class="titlepage"><div><div><h3 class="title">
1.385     leot      810: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      811: <div class="variablelist"><dl class="variablelist">
1.75      rillig    812: <dt><span class="term">pkgsrc users</span></dt>
                    813: <dd>
                    814: <p>The
                    815:        pkgsrc users are people who use the packages provided by pkgsrc.
                    816:        Typically they are system administrators. The people using the
1.385     leot      817:        software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
                    818:        users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    819: <p>There are two kinds of pkgsrc users: Some only want to
                    820:        install pre-built binary packages. Others build the pkgsrc
                    821:        packages from source, either for installing them directly or for
1.385     leot      822:        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    823:        documentation.</p>
                    824: </dd>
                    825: <dt><span class="term">package maintainers</span></dt>
                    826: <dd><p>A
1.385     leot      827:        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    828: <dt><span class="term">infrastructure developers</span></dt>
                    829: <dd><p>These people are involved in all those files
1.76      rillig    830:        that live in the <code class="filename">mk/</code> directory and below.
1.385     leot      831:        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    832:        too.</p></dd>
                    833: </dl></div>
                    834: </div>
                    835: </div>
1.148     asau      836: <div class="sect1">
1.75      rillig    837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot      838: <a name="typography"></a>1.4. Typography</h2></div></div></div>
1.75      rillig    839: <p>When giving examples for commands, shell prompts are used to
                    840:       show if the command should/can be issued as root, or if
1.385     leot      841:       <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226     sevan     842:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    843:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344     gutterid  844:       Bourne shell and derivatives.</p>
1.75      rillig    845: </div>
                    846: </div>
1.148     asau      847: <div class="part">
1.75      rillig    848: <div class="titlepage"><div><div><h1 class="title">
1.385     leot      849: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
1.75      rillig    850: <div class="toc">
                    851: <p><b>Table of Contents</b></p>
1.210     leot      852: <dl class="toc">
1.267     rillig    853: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    854: <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    855: <dd><dl>
1.267     rillig    856: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    857: <dd><dl>
1.267     rillig    858: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    859: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    860: </dl></dd>
1.267     rillig    861: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    862: <dd><dl>
1.267     rillig    863: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    864: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    865: </dl></dd>
                    866: </dl></dd>
1.267     rillig    867: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    868: <dd><dl>
1.267     rillig    869: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    870: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    871: </dl></dd>
1.267     rillig    872: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    873: <dd><dl>
1.267     rillig    874: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    875: <dd><dl>
1.267     rillig    876: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    877: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia       878: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    879: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    880: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    881: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    882: <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>
                    883: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig    884: </dl></dd>
1.267     rillig    885: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    886: <dd><dl>
1.267     rillig    887: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    888: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    889: <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    890: </dl></dd>
                    891: </dl></dd>
1.267     rillig    892: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    893: <dd><dl>
1.267     rillig    894: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    895: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig    896: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                    897: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                    898: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                    899: <dd><dl>
                    900: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                    901: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    902: <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       903: </dl></dd>
1.355     rillig    904: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                    905: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig    906: </dl></dd>
1.267     rillig    907: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    908: <dd><dl>
1.267     rillig    909: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    910: <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    911: </dl></dd>
1.267     rillig    912: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    913: builds)</a></span></dt>
1.75      rillig    914: <dd><dl>
1.267     rillig    915: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.394     wiz       916: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk build</a></span></dt>
1.267     rillig    917: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.394     wiz       918: <dt><span class="sect1"><a href="#bulk.bob">8.3. Running a bob build</a></span></dt>
                    919: <dt><span class="sect1"><a href="#bulk.scan">8.4. Speeding up bulk build scans</a></span></dt>
                    920: <dt><span class="sect1"><a href="#bulk.req">8.5. Requirements of a full bulk build</a></span></dt>
                    921: <dt><span class="sect1"><a href="#bulk.var">8.6. Bulk build variants</a></span></dt>
                    922: <dd><dl>
                    923: <dt><span class="sect2"><a href="#bulk.var.confopt">8.6.1. Detect unknown configure options</a></span></dt>
                    924: <dt><span class="sect2"><a href="#bulk.var.comperr">8.6.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                    925: <dt><span class="sect2"><a href="#bulk.var.builderr">8.6.3. Force compiler options only in the build phase</a></span></dt>
                    926: <dt><span class="sect2"><a href="#bulk.var.dirs">8.6.4. Use custom directories</a></span></dt>
                    927: <dt><span class="sect2"><a href="#bulk.var.warn">8.6.5. Turn warnings into errors</a></span></dt>
                    928: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.6.6. Reject packages for which pkglint reports errors</a></span></dt>
                    929: <dt><span class="sect2"><a href="#bulk.var.strings">8.6.7. Reject packages that contain forbidden strings</a></span></dt>
                    930: <dt><span class="sect2"><a href="#bulk.var.test">8.6.8. Reject packages whose self-test fails</a></span></dt>
                    931: <dt><span class="sect2"><a href="#bulk.var.shvar">8.6.9. Reject packages that use undefined shell variables</a></span></dt>
                    932: <dt><span class="sect2"><a href="#bulk.var.quiet">8.6.10. Turn off verbose logging</a></span></dt>
1.293     rillig    933: </dl></dd>
1.394     wiz       934: <dt><span class="sect1"><a href="#creating-cdroms">8.7. Creating a multiple CD-ROM packages collection</a></span></dt>
                    935: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.7.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    936: </dl></dd>
                    937: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    938: <dd><dl>
                    939: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    940: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    941: </dl></dd>
                    942: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    943: <dd><dl>
                    944: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    945: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    946: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    947: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    948: <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>
                    949: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    950: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    951: <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>
                    952: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot      953: <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
                    954: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                    955: <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       956: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig    957: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    958: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    959: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    960: <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      961: <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    962: </dl></dd>
                    963: </dl>
                    964: </div>
1.148     asau      965: <div class="chapter">
1.75      rillig    966: <div class="titlepage"><div><div><h2 class="title">
1.385     leot      967: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
1.267     rillig    968: <p>
                    969:        To get help when using pkgsrc, the definitive source is this
                    970:        document, the pkgsrc guide. If you don't find anything here,
                    971:        there are alternatives:
                    972: </p>
                    973: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    974: <li class="listitem">
                    975: <p>
                    976:        The built-in pkgsrc help, which is available after bootstrapping
1.385     leot      977:        pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.267     rillig    978:        help for any topic, such as a variable name like
                    979:        <code class="varname">BUILD_DEFS</code>, a make target like
                    980:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    981:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.385     leot      982: <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    983: </li>
                    984: <li class="listitem"><p>
1.278     rillig    985:        To see the value of a single variable, run <span class="command"><strong>bmake
                    986:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    987: </p></li>
                    988: <li class="listitem"><p>
                    989:        To see the values of the most common variables, run
                    990:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    991:        topic. To see the variables for a single topic, run
                    992:        <span class="command"><strong>bmake
                    993:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    994:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    995: </p></li>
                    996: <li class="listitem"><p>
1.267     rillig    997:        The pkgsrc-users mailing list, to which
                    998:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    999:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                   1000:        questions</a>.</p></li>
                   1001: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland 1002:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig   1003:        or by using a specialized chat program such as
                   1004:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   1005:        Pick any user name and join the channel #pkgsrc.</p></li>
                   1006: </ul></div>
                   1007: </div>
                   1008: <div class="chapter">
                   1009: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1010: <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   1011: <div class="toc">
                   1012: <p><b>Table of Contents</b></p>
1.210     leot     1013: <dl class="toc">
1.267     rillig   1014: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig   1015: <dd><dl>
1.267     rillig   1016: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                   1017: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig   1018: </dl></dd>
1.267     rillig   1019: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig   1020: <dd><dl>
1.267     rillig   1021: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                   1022: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig   1023: </dl></dd>
                   1024: </dl>
                   1025: </div>
1.91      rillig   1026: <p>Before you download and extract the files, you need to decide
                   1027: where you want to extract them. When using pkgsrc as root user, pkgsrc
                   1028: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                   1029: free to install the sources and binary packages wherever you want in
                   1030: your filesystem, provided that the pathname does not contain white-space
                   1031: or other characters that are interpreted specially by the shell and some
                   1032: other programs. A safe bet is to use only letters, digits, underscores
                   1033: and dashes.</p>
1.148     asau     1034: <div class="sect1">
1.75      rillig   1035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1036: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1037: <p>Before you download any pkgsrc files, you should decide
                   1038:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1039:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1040:        quarterly basis from the current branch and only gets modified
                   1041:        for security updates. The names of the stable branches are built
                   1042:        from the year and the quarter, for example
1.395     leot     1043:        <code class="literal">2026Q2</code>.</p>
1.75      rillig   1044: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1045:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1046:        Both ways are described here.</p>
1.157     asau     1047: <p>Note that tar archive contains CVS working copy.
                   1048:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1049: <div class="sect2">
1.75      rillig   1050: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1051: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1052: <p>The primary download location for all pkgsrc files is
1.264     sevan    1053:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1054:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1055:        (it points to the same location).
                   1056:        There are a number of subdirectories for different purposes,
1.385     leot     1057:        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     1058: <p>The tar archive for the current branch is in the directory
1.264     sevan    1059:        <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    1060:        It is autogenerated weekly.</p>
1.157     asau     1061: <p>To save download time we provide bzip2- and
                   1062:        xz-compressed archives which are published at
1.264     sevan    1063:        <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     1064:        and
1.264     sevan    1065:        <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     1066:        respectively.
                   1067:        </p>
                   1068: <p>You can fetch the same files using FTP.</p>
1.395     leot     1069: <p>The tar file for the stable branch 2026Q2 is in the
                   1070:        directory <code class="filename">pkgsrc-2026Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2026Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1071: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1072: <pre class="screen">
1.395     leot     1073: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2026Q2/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1074: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1075:        or your web browser.</p>
1.112     weinem   1076: <p>Then, extract it with:</p>
1.188     snj      1077: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1078: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1079:        in <code class="filename">/usr/</code> and all the package source will be 
                   1080:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1081: <p>To download pkgsrc-current, run:</p>
                   1082: <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   1083: </div>
1.148     asau     1084: <div class="sect2">
1.75      rillig   1085: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1086: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1087: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.395     leot     1088: <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-2026Q2 -P pkgsrc</code></strong>
1.128     wiz      1089: </pre>
                   1090: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1091:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1092:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1093: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1094: <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    1095: </pre>
1.289     leot     1096: <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      1097: <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      1098: <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      1099: </pre>
                   1100: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1101:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1102:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1103: <pre class="programlisting">
                   1104: # set CVS remote shell command
                   1105: CVS_RSH=ssh
                   1106: export CVS_RSH
                   1107: </pre>
                   1108: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1109:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1110:        in your home directory and saving the following lines to it.
                   1111:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1112:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1113: <pre class="programlisting">
                   1114: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1115: cvs -q
1.101     rillig   1116: checkout -P
1.103     wiz      1117: update -dP
                   1118: diff -upN
1.101     rillig   1119: rdiff -u
1.128     wiz      1120: release -d
1.101     rillig   1121: </pre>
1.75      rillig   1122: </div>
                   1123: </div>
1.148     asau     1124: <div class="sect1">
1.75      rillig   1125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1126: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1127: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1128:        (which also works if you have first installed it via a tar
                   1129:        file). It saves bandwidth and hard disk activity, compared to
                   1130:        downloading the tar file again.</p>
1.148     asau     1131: <div class="sect2">
1.75      rillig   1132: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1133: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1134: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1135: <h3 class="title">Warning</h3>
1.77      rillig   1136: <p>When updating from a tar file, you first need to
                   1137:        completely remove the old pkgsrc directory. Otherwise those
                   1138:        files that have been removed from pkgsrc in the mean time will
                   1139:        not be removed on your local disk, resulting in inconsistencies.
                   1140:        When removing the old files, any changes that you have done to
                   1141:        the pkgsrc files will be lost after updating. Therefore updating
                   1142:        via CVS is strongly recommended.</p>
1.75      rillig   1143: </div>
1.82      rillig   1144: <p>Note that by default the distfiles and the binary packages
                   1145:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1146:        before updating. You can also configure pkgsrc to store distfiles
                   1147:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1148:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.385     leot     1149:        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   1150: <p>To update pkgsrc from a tar file, download the tar file as
                   1151:        explained above. Then, make sure that you have not made any
                   1152:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1153:        directory and extract the new tar file. Done.</p>
                   1154: </div>
1.148     asau     1155: <div class="sect2">
1.75      rillig   1156: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1157: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1158: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1159: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1160: </pre>
                   1161: <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>
                   1162: <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>
                   1163: </pre>
1.148     asau     1164: <div class="sect3">
1.75      rillig   1165: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     1166: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1167: <p>When updating pkgsrc, the CVS program keeps track of the
                   1168:        branch you selected. But if you, for whatever reason, want to
                   1169:        switch from the stable branch to the current one, you can do it
1.385     leot     1170:        by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
                   1171:        <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75      rillig   1172:        back to the stable branch, add the
1.395     leot     1173:        <span class="quote">“<span class="quote">-rpkgsrc-2026Q2</span>”</span> option.</p>
1.75      rillig   1174: </div>
1.148     asau     1175: <div class="sect3">
1.75      rillig   1176: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     1177: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1178: <p>When you update pkgsrc, the CVS program will only touch
                   1179:        those files that are registered in the CVS repository. That
                   1180:        means that any packages that you created on your own will stay
                   1181:        unmodified. If you change files that are managed by CVS, later
                   1182:        updates will try to merge your changes with those that have been
                   1183:        done by others. See the CVS manual, chapter
1.385     leot     1184:        <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75      rillig   1185: </div>
                   1186: </div>
                   1187: </div>
                   1188: </div>
1.148     asau     1189: <div class="chapter">
1.75      rillig   1190: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1191: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1192: <div class="toc">
                   1193: <p><b>Table of Contents</b></p>
1.210     leot     1194: <dl class="toc">
1.267     rillig   1195: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1196: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1197: </dl>
                   1198: </div>
1.148     asau     1199: <div class="sect1">
1.75      rillig   1200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1201: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1202: <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   1203: </div>
1.148     asau     1204: <div class="sect1">
1.82      rillig   1205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1206: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1207: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1208:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1209:     to privileged one all programs are installed under one particular user
1.149     asau     1210:     and cannot utilise privileged operations (packages don't create
                   1211:     special users and all special file permissions like setuid are ignored).
                   1212:     </p>
1.82      rillig   1213: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1214: <pre class="screen">
1.167     asau     1215: <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   1216: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1217: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1218:     </pre>
1.385     leot     1219: <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     1220: <p>By default, in privileged mode pkgsrc uses
                   1221:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1222:     where programs will be installed in,
1.230     sevan    1223:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1224:     directory where pkgsrc will do its internal bookkeeping,
                   1225:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1226:     where packages install their persistent data.
                   1227:     In unprivileged mode pkgsrc uses
                   1228:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1229:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1230:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1231:     </p>
                   1232: <p>You can change default layout using command-line arguments.
1.385     leot     1233:     Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1.149     asau     1234:     </p>
1.148     asau     1235: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1236: <h3 class="title">Note</h3>
1.110     hubertf  1237: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1238:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1239:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.385     leot     1240:       instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75      rillig   1241: </div>
1.149     asau     1242: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1243: <h3 class="title">Note</h3>
                   1244: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1245:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1246:       corresponding to the installation you're working with to build
                   1247:       and install packages.
                   1248:       </p>
                   1249: </div>
1.75      rillig   1250: </div>
                   1251: </div>
1.148     asau     1252: <div class="chapter">
1.75      rillig   1253: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1254: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1255: <div class="toc">
                   1256: <p><b>Table of Contents</b></p>
1.210     leot     1257: <dl class="toc">
1.267     rillig   1258: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1259: <dd><dl>
1.267     rillig   1260: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1261: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317     nia      1262: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1263: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1264: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1265: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1266: <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>
                   1267: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267     rillig   1268: </dl></dd>
                   1269: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1270: <dd><dl>
                   1271: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1272: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1273: <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   1274: </dl></dd>
                   1275: </dl>
                   1276: </div>
                   1277: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1278: is to only install the package tools and to use binary packages
1.385     leot     1279: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
                   1280: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88      wiz      1281: of pkgsrc, too. Then you are able to build your own packages,
                   1282: and you can still use binary packages from someone else.</p>
1.148     asau     1283: <div class="sect1">
1.75      rillig   1284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1285: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317     nia      1286: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1287:   site and mirrors, there are collections of binary packages,
1.109     rillig   1288:   ready to be installed. These binary packages have been built using the
                   1289:   default settings for the directories, that is:</p>
1.148     asau     1290: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1291: <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>
                   1292: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1293: <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   1294: </ul></div>
                   1295: <p>If you cannot use these directories for whatever reasons (maybe
                   1296:   because you're not root), you cannot use these binary packages, but
1.385     leot     1297:   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     1298: <div class="sect2">
1.75      rillig   1299: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1300: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1301: <p>To install binary packages, you first need to know from where
                   1302:     to get them. The first place where you should look is on the main
1.317     nia      1303:     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   1304: <p>This directory contains binary packages for multiple
1.341     gutterid 1305:     platforms. First, select your operating system. Then, select your
                   1306:     hardware architecture, and in the third step, the OS version and
1.385     leot     1307:     the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.341     gutterid 1308: <p>In this directory, you may find a file called
1.109     rillig   1309:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1310:     management tools. If the file is missing, it is likely that your
                   1311:     operating system already provides those tools. Download the file and
                   1312:     extract it in the <code class="filename">/</code> directory. It will create
                   1313:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1314:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1315: </div>
1.148     asau     1316: <div class="sect2">
1.75      rillig   1317: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1318: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1319: <p>In the directory from the last section, there is a
1.196     wiz      1320:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1321:     binary packages that are available for the platform, excluding those
1.317     nia      1322:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1323: <p>To install packages directly from an FTP or HTTP server, run
                   1324:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1325:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1326: <pre class="screen">
1.317     nia      1327: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1328: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1329: <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   1330: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317     nia      1331: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1332: </pre>
                   1333: <p>Instead of URLs, you can also use local paths, for example if
                   1334:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1335:     repository. If you want to install packages from multiple sources,
                   1336:     you can separate them by a semicolon in
                   1337:     <code class="varname">PKG_PATH</code>.</p>
                   1338: <p>After these preparations, installing a package is very
                   1339:     easy:</p>
                   1340: <pre class="screen">
1.317     nia      1341: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1342: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1343: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1344: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1345: </pre>
                   1346: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1347:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1348: <p>Any prerequisite packages needed to run the
1.88      wiz      1349:     package in question will be installed, too, assuming they are
1.317     nia      1350:     present in the repository.</p>
1.75      rillig   1351: <p>After you've installed packages, be sure to have
1.88      wiz      1352:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1353:     <code class="varname">PATH</code> so you can actually start the just
                   1354:     installed program.</p>
1.75      rillig   1355: </div>
1.148     asau     1356: <div class="sect2">
1.75      rillig   1357: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1358: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1.317     nia      1359: <p>To update binary packages, it is recommended that you use
                   1360:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1361:     package repository to your locally installed packages and safely
                   1362:     replace any older packages.</p>
                   1363: <p>Note that pkgsrc is released as quarterly branches.
                   1364:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1365:     need to adjust the repository in
                   1366:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1367: </div>
                   1368: <div class="sect2">
                   1369: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1370: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1371: <p>To deinstall a package, it does not matter whether it was
1.317     nia      1372:     installed from source code or from a binary package. Neither the
                   1373:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1374:     command need to know.</p>
                   1375: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1376:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317     nia      1377:     name can be given with or without version number.</p>
1.82      rillig   1378: </div>
1.148     asau     1379: <div class="sect2">
1.82      rillig   1380: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1381: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1382: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317     nia      1383:     installed packages or binary package files.
                   1384:     As with other management tools, it works with packages installed
                   1385:     from source or binaries.</p>
1.82      rillig   1386: </div>
1.148     asau     1387: <div class="sect2">
1.82      rillig   1388: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1389: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1390: <p>
1.279     leot     1391:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317     nia      1392:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1393:       included in pkgsrc.  The list is available from the NetBSD
1.317     nia      1394:       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>.
                   1395:     </p>
                   1396: <p>
                   1397:       Please note that not every "vulnerability" with a CVE assignment is
                   1398:       exploitable in every configuration.
                   1399:       Some bugs are marked as active simply because an fix was not
                   1400:       marked as such.
                   1401:       Operating system specific hardening and mitigation features may also
                   1402:       reduce the impact of bugs.
1.88      wiz      1403:     </p>
1.82      rillig   1404: <p>
1.125     wiz      1405:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1406:       this list can be downloaded
                   1407:       automatically, and a security audit of all packages installed on a system
                   1408:       can take place.
                   1409:     </p>
1.82      rillig   1410: <p>
1.125     wiz      1411:       There are two components to auditing.  The first
                   1412:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1413:       is for downloading
1.88      wiz      1414:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1415:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1416:       installed packages are vulnerable.  If a package is vulnerable, you
                   1417:       will see output similar to the following:
                   1418:     </p>
1.82      rillig   1419: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1420:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1421: <p>
1.125     wiz      1422:       You may wish to have the
1.317     nia      1423:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1424:       file downloaded daily so that
                   1425:       it remains current.  This may be done by adding an appropriate entry
1.378     leot     1426:       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      1427:       </p>
                   1428: <pre class="screen">
1.233     sevan    1429: # Download vulnerabilities file
1.230     sevan    1430: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1431: # Audit the installed packages and email results to root
                   1432: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1433:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1434:       </pre>
                   1435: <p>
1.230     sevan    1436:       will update the vulnerability list every day at 3AM, followed by an audit
                   1437:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1438: 
1.230     sevan    1439:       On NetBSD this may be accomplished instead by adding the following
                   1440:       line to <code class="filename">/etc/daily.conf</code>:
                   1441:       </p>
                   1442: <pre class="screen">
                   1443: fetch_pkg_vulnerabilities=YES
                   1444:       </pre>
                   1445: <p>
                   1446:       to fetch the vulnerability list from the daily security script. The system
                   1447:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1448:       desired (not required), by adding the following line to
1.230     sevan    1449: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1450:       </p>
                   1451: <pre class="screen">
1.230     sevan    1452: check_pkg_vulnerabilities=YES
1.125     wiz      1453:       </pre>
                   1454: <p>
1.378     leot     1455:       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      1456:     </p>
1.82      rillig   1457: </div>
1.148     asau     1458: <div class="sect2">
1.82      rillig   1459: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1460: <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   1461: <p>
1.322     leot     1462:       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     1463:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317     nia      1464:       argument to check if any packages are stale, e.g.
1.88      wiz      1465:     </p>
                   1466: <pre class="screen">
                   1467: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1468: ...
1.88      wiz      1469: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1470:     </pre>
1.82      rillig   1471: </div>
1.148     asau     1472: <div class="sect2">
1.82      rillig   1473: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1474: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1475: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1476:     administrative functions on the package system.</p>
1.82      rillig   1477: </div>
1.75      rillig   1478: </div>
1.148     asau     1479: <div class="sect1">
1.75      rillig   1480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1481: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1482: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1483:   directory now contains a set of packages, organized into
                   1484:   categories. You can browse the online index of packages, or run
1.110     hubertf  1485:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1486:   directory to build local <code class="filename">README.html</code> files for
1.322     leot     1487:   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      1488: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1489:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1490:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1491:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1492:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1493:   system (inside a chroot is an exception). </p>
                   1494: <p>The rest of this chapter assumes that the package is already
1.385     leot     1495:   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      1496:   instructions how to create your own packages.</p>
1.148     asau     1497: <div class="sect2">
1.75      rillig   1498: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1499: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1500: <p>To build packages from source, you need a working C
1.88      wiz      1501:     compiler. On NetBSD, you need to install the
1.385     leot     1502:     <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88      wiz      1503:     sets. If you want to build X11-related packages, the
1.385     leot     1504:     <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88      wiz      1505:     sets are required, too.</p>
1.75      rillig   1506: </div>
1.148     asau     1507: <div class="sect2">
1.75      rillig   1508: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1509: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1510: <p>The first step for building a package is downloading the
1.88      wiz      1511:     distfiles (i.e. the unmodified source). If they have not yet been
                   1512:     downloaded, pkgsrc will fetch them automatically.</p>
                   1513: <p>If you have all files that you need in the
                   1514:     <code class="filename">distfiles</code> directory,
                   1515:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1516:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1517:     </p>
1.82      rillig   1518: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1519: <p>
1.110     hubertf  1520:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1521: <p>By default a list of distribution sites will be randomly
                   1522:     intermixed to prevent huge load on servers which holding popular
                   1523:     packages (for example, SourceForge.net mirrors). Thus, every
                   1524:     time when you need to fetch yet another distfile all the mirrors
                   1525:     will be tried in new (random) order. You can turn this feature
                   1526:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1527:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1528: <p>You can overwrite some of the major distribution sites to
                   1529:     fit to sites that are close to your own.  By setting one or two
                   1530:     variables you can modify the order in which the master sites are
                   1531:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1532:     delimited list of domain suffixes.
                   1533:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1534:     contains a whitespace delimited list of regular expressions.  It
                   1535:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1536:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1537:     some examples.  This may save some of your bandwidth and
                   1538:     time.</p>
1.75      rillig   1539: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1540:     if you want to keep the settings, by editing the
1.110     hubertf  1541:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1542:     and adding the definitions there.</p>
1.82      rillig   1543: <p>
1.88      wiz      1544:       If a package depends on many other packages (such as
1.322     leot     1545:       <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      1546:       alternate between periods of
                   1547:       downloading source, and compiling. To ensure you have all the source
                   1548:       downloaded initially you can run the command:
                   1549:       </p>
1.82      rillig   1550: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1551: <p>
1.88      wiz      1552:       which will output and run a set of shell commands to fetch the
                   1553:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1554:       also choose to download the files manually.
                   1555:     </p>
1.75      rillig   1556: </div>
1.148     asau     1557: <div class="sect2">
1.75      rillig   1558: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1559: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1560: <p>
1.88      wiz      1561:       Once the software has downloaded, any patches will be applied, then it
                   1562:       will be compiled for you. This may take some time depending on your
                   1563:       computer, and how many other packages the software depends on and their
                   1564:       compile time.
                   1565:     </p>
1.148     asau     1566: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1567: <h3 class="title">Note</h3>
                   1568: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1569:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.385     leot     1570:     <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75      rillig   1571: </div>
1.87      wiz      1572: <p>For example, type</p>
1.88      wiz      1573: <pre class="screen">
                   1574: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1575: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1576:     </pre>
1.75      rillig   1577: <p>at the shell prompt to build the various components of the
1.88      wiz      1578:     package.</p>
1.82      rillig   1579: <p>The next stage is to actually install the newly compiled
1.88      wiz      1580:     program onto your system. Do this by entering:
1.82      rillig   1581: 
1.88      wiz      1582:     </p>
1.82      rillig   1583: <pre class="screen">
1.88      wiz      1584: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1585:     </pre>
1.82      rillig   1586: <p>
                   1587: 
1.88      wiz      1588:     while you are still in the directory for whatever package you
                   1589:     are installing.</p>
1.82      rillig   1590: <p>Installing the package on your system may require you to
1.88      wiz      1591:     be root.  However, pkgsrc has a
                   1592:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1593:     to only become root for the actual installation step.</p>
1.82      rillig   1594: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1595:     You can now enter:
1.82      rillig   1596: 
1.88      wiz      1597:     </p>
1.82      rillig   1598: <pre class="screen">
1.88      wiz      1599: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1600:     </pre>
1.82      rillig   1601: <p>
                   1602: 
1.88      wiz      1603:     to remove the compiled files in the work directory, as you shouldn't need
                   1604:     them any more. If other packages were also added to your system
                   1605:     (dependencies) to allow your program to compile, you can tidy these up
                   1606:     also with the command:</p>
1.82      rillig   1607: <pre class="screen">
1.88      wiz      1608: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1609:     </pre>
1.75      rillig   1610: <p>Taking the figlet utility as an example, we can install it on our
1.385     leot     1611:     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      1612: <p>The program is installed under the default root of the
                   1613:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1614:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1615:     variable in your environment, and it will use that value as the
                   1616:     root of your packages tree. So, to use
                   1617:     <code class="filename">/usr/local</code>, set
                   1618:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1619:     Please note that you should use a directory which is dedicated to
                   1620:     packages and not shared with other programs (i.e., do not try and
                   1621:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1622:     to add any of your own files or directories (such as
                   1623:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1624:     <code class="filename">pkgsrc/</code>) below the
                   1625:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1626:     conflicts between programs and other files installed by the
                   1627:     package system and whatever else may have been installed
                   1628:     there.</p>
1.110     hubertf  1629: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1630:     alter some configuration options at build time.  Have a look at
                   1631:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1632:     of what will be set there by default.  Environment variables such
                   1633:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1634:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1635:     set them each time you want to use pkgsrc.</p>
1.385     leot     1636: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
                   1637:     covers</span>”</span> to see what is going on when a package is building
1.88      wiz      1638:     or being installed. This may be for debugging purposes, or out of
                   1639:     simple curiosity. A number of utility values have been added to
                   1640:     help with this.</p>
1.128     wiz      1641: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1642: <li class="listitem">
1.378     leot     1643: <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      1644:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1645:        information will be displayed. For example,</p>
1.75      rillig   1646: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1647: <p>will show all the commands that are invoked, up to and
1.385     leot     1648:        including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75      rillig   1649: </li>
1.128     wiz      1650: <li class="listitem">
1.378     leot     1651: <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      1652:        definition, then the <code class="varname">VARNAME</code> definition
                   1653:        should be used, in conjunction with the show-var
1.378     leot     1654:        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      1655:        variable <code class="varname">LOCALBASE</code>:</p>
                   1656: <pre class="screen">
                   1657: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1658: /usr/pkg
                   1659: <code class="prompt">%</code>
1.88      wiz      1660:        </pre>
1.75      rillig   1661: </li>
                   1662: </ol></div>
                   1663: <p>If you want to install a binary package that you've either
1.88      wiz      1664:     created yourself (see next section), that you put into
                   1665:     pkgsrc/packages manually or that is located on a remote FTP
                   1666:     server, you can use the "bin-install" target. This target will
1.378     leot     1667:     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  1668:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1669:     sites searched is kept in the variable
                   1670:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.378     leot     1671:     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      1672:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1673:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1674:     details.</p>
                   1675: <p>A final word of warning: If you set up a system that has a
                   1676:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1677:     set that before any packages are installed, as you cannot use
                   1678:     several directories for the same purpose. Doing so will result in
                   1679:     pkgsrc not being able to properly detect your installed packages,
                   1680:     and fail miserably. Note also that precompiled binary packages are
                   1681:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1682:     <code class="filename">/usr/pkg</code>, and that you should
                   1683:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1684:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1685: </div>
                   1686: </div>
                   1687: </div>
1.148     asau     1688: <div class="chapter">
1.75      rillig   1689: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     1690: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1691: <div class="toc">
                   1692: <p><b>Table of Contents</b></p>
1.210     leot     1693: <dl class="toc">
1.267     rillig   1694: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1695: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355     rillig   1696: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
                   1697: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
                   1698: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
                   1699: <dd><dl>
                   1700: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
                   1701: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1702: <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      1703: </dl></dd>
1.355     rillig   1704: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
                   1705: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75      rillig   1706: </dl>
                   1707: </div>
1.104     rillig   1708: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1709: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1710: that file depends on the installation. On NetBSD, when you use
1.378     leot     1711: <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   1712: <code class="filename">/etc/</code>. In all other cases the default location is
                   1713: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1714: bootstrap program to install the binary packages.</p>
                   1715: <p>The format of the configuration file is that of the usual
                   1716: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1717: is done by setting variables in this file. Note that you can define all
                   1718: kinds of variables, and no special error checking (for example for
1.223     rillig   1719: spelling mistakes) takes place.</p>
1.148     asau     1720: <div class="sect1">
1.75      rillig   1721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1722: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1723: <p>The following variables apply to all
1.89      rillig   1724:     pkgsrc packages. A complete list of the variables that can be
                   1725:     configured by the user is available in
                   1726:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1727:     comments that describe each variable's intent.</p>
1.148     asau     1728: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1729: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1730:            packages will be installed. The default is
1.76      rillig   1731:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1732:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1733: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1.385     leot     1734:            <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75      rillig   1735:            installed. The default is
1.76      rillig   1736:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1737: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1738:            X11 is installed on the system. The default is
1.194     bsiegert 1739:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1740: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1741:            downloaded copies of the original source distributions used
                   1742:            for building pkgsrc packages. The default is
1.76      rillig   1743:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1744: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1745:            database about installed packages is stored.  The default is
1.230     sevan    1746:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1747: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1748:            If set, override the packages'
                   1749:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1750: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1751:            Backup location(s) for distribution files and patch files
                   1752:            if not found locally or in
1.76      rillig   1753:            <code class="filename">${MASTER_SITES}</code> or
                   1754:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1755:            The defaults is
                   1756:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1757: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1758:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1759:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.385     leot     1760:            release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
                   1761:            (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1.128     wiz      1762: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1763:            List of acceptable licenses. License names are case-sensitive.
                   1764:            Whenever you try to build a package whose license is not in this
                   1765:            list, you will get an error message. If the license condition is
                   1766:            simple enough, the error message will include specific
                   1767:            instructions on how to change this variable.</p></li>
1.75      rillig   1768: </ul></div>
                   1769: </div>
1.148     asau     1770: <div class="sect1">
1.75      rillig   1771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1772: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1773: <p>
1.75      rillig   1774:       </p>
1.148     asau     1775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1776: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1777:            directory for the binary packages. The default is
1.76      rillig   1778:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1779: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1780:            The top level directory where, if defined, the separate
                   1781:            working directories will get created, and symbolically
1.76      rillig   1782:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1783:            This is useful for building packages on several
1.76      rillig   1784:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1785:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1786:            is local to every architecture. (It should be noted that
                   1787:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1788:            &mdash; it is an internal definition which refers to the
1.75      rillig   1789:            root of the pkgsrc tree. It is possible to have many
                   1790:            pkgsrc tree instances.)</p></li>
1.128     wiz      1791: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1792:            Directory for local patches that aren't part of pkgsrc.
1.385     leot     1793:            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   1794:            information.</p></li>
1.128     wiz      1795: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1796:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1797:            BSD-style Makefile. If this is not set,
                   1798:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1799:            <code class="filename">/dev/null</code> to avoid picking up
                   1800:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1801: </ul></div>
                   1802: </div>
1.148     asau     1803: <div class="sect1">
1.75      rillig   1804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1805: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1.355     rillig   1806: <p>Whenever a package depends on a package that has a
                   1807:     <code class="filename">builtin.mk</code> file, the dependent package can
                   1808:     either use the built-in (native) version from the base system or the
                   1809:     pkgsrc-provided version.  This only affects dependencies, so it is
                   1810:     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
                   1811:     on the native pcre++ version instead.</p>
                   1812: <p>To force using the pkgsrc-provided version for a particular
1.385     leot     1813:     package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
                   1814:     <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   1815:     using the native package, define
1.385     leot     1816:     <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
                   1817:     <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1.355     rillig   1818:     <em class="replaceable"><code>package-ID</code></em> is the one from the
                   1819:     <code class="filename">buildlink3.mk</code> of the package. In most cases,
                   1820:     this ID is the same as the directory name of the package, but for
                   1821:     example, <code class="filename">devel/pcre++</code> has the
1.385     leot     1822:     package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1.355     rillig   1823: <p>For the packages that are not listed by their package ID,
                   1824:     pkgsrc uses the pkgsrc-provided version if
                   1825:     <code class="varname">PREFER_PKGSRC</code> contains the word
1.385     leot     1826:     <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
                   1827:     contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1.355     rillig   1828:     version. For example, to require using the pkgsrc-provided versions
                   1829:     for all but the most basic bits on a NetBSD system, you can
                   1830:     set:</p>
                   1831: <pre class="programlisting">
                   1832: PREFER_PKGSRC=  yes
                   1833: PREFER_NATIVE=  getopt skey tcp_wrappers
                   1834: </pre>
                   1835: <p>A package <span class="emphasis"><em>must</em></span> have a
                   1836:     <code class="filename">builtin.mk</code> file to be listed in
                   1837:     <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
                   1838:     that list.</p>
                   1839: <p><code class="varname">PREFER_PKGSRC</code> and
                   1840:     <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
                   1841:     ensure that the bootstrap process does not use inapropriate native
                   1842:     tools as dependencies for core packages.</p>
                   1843: <pre class="screen">
                   1844: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   1845: </pre>
                   1846: <p>Switching between settings globally at a later date can
                   1847:     introduce complications with dependency resolution.  This is caused
                   1848:     by packages built with the opposite preference being installed
                   1849:     alongside each other.  Hence, when changing any of these variables
                   1850:     after bootstrap, you need to rebuild all packages depending on those
                   1851:     whose preference has been changed.  This is not trivial and should
                   1852:     be avoided.</p>
                   1853: <p>When using pkgsrc on Linux systems, there is high risk of
1.385     leot     1854:     <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1.355     rillig   1855:     inadvertently use a command or library not installed by pkgsrc, e.g.
                   1856:     those installed by yum or apt.  Such foreign dependencies may be
                   1857:     installed, removed, or upgraded to a version incompatible with the
                   1858:     pkgsrc package at any time, causing pkgsrc packages to subsequently
                   1859:     malfunction.  Pkgsrc cannot prevent this, as it has no control over
                   1860:     other package managers. Another potential problem is that under
                   1861:     Redhat Enterprise and related Linux systems, yum packages are only
                   1862:     patched and never upgraded, so eventually they may become too
                   1863:     outdated for use by pkgsrc.  Even intentionally using foreign
                   1864:     dependencies, not considered leakage, can lead to these problems, so
                   1865:     it is generally discouraged.  In order to minimize such problems,
1.385     leot     1866:     PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1.355     rillig   1867:     pkgsrc is aware of any changes to dependency packages and can
                   1868:     rebuild or upgrade the entire dependency tree as needed.  This
                   1869:     default can be overridden by setting --prefer-pkgsrc to a
1.385     leot     1870:     list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.355     rillig   1871: </div>
                   1872: <div class="sect1">
                   1873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1874: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1875: <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     1876:                 By default, binary packages of built packages are
1.263     leot     1877:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1878:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1879: <p>Packages have to support installation into a
1.103     wiz      1880:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1881:     to be built, before the actual filesystem is touched. DESTDIR
                   1882:     support exists in two variations:</p>
1.148     asau     1883: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1884: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1885:       installation and packaging is still run as root.</p></li>
                   1886: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1887:       build, installation and packaging as normal user. Root
                   1888:       privileges are only needed to add packages.</p></li>
                   1889: </ul></div>
1.103     wiz      1890: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1891:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1892: <p>Considering the <code class="filename">foo/bar</code> package,
                   1893:     DESTDIR full support can be tested using the following commands
                   1894: 
                   1895: </p>
                   1896: <pre class="programlisting">
                   1897: <code class="prompt">$</code> id
                   1898: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1899: <code class="prompt">$</code> mkdir $HOME/packages
                   1900: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1901: </pre>
                   1902: <p>
                   1903: 
                   1904:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1905:     should be needed
                   1906: 
                   1907: </p>
                   1908: <pre class="programlisting">
1.174     asau     1909: <code class="prompt">$</code> make stage-install
1.118     imil     1910: </pre>
                   1911: <p>
                   1912: 
                   1913:     Create a package without root privileges
                   1914: 
                   1915: </p>
                   1916: <pre class="programlisting">
1.174     asau     1917: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1918: </pre>
                   1919: <p>
                   1920: 
                   1921:     For the following command, you must be able to gain root
1.378     leot     1922:     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     1923: 
                   1924: </p>
                   1925: <pre class="programlisting">
1.174     asau     1926: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1927: </pre>
                   1928: <p>
                   1929: 
                   1930:     Then, as a simple user
                   1931: 
                   1932: </p>
                   1933: <pre class="programlisting">
                   1934: <code class="prompt">$</code> make clean
                   1935: </pre>
                   1936: <p>
                   1937: 
                   1938:     </p>
1.103     wiz      1939: </div>
1.148     asau     1940: <div class="sect1">
1.103     wiz      1941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     1942: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1943: <div class="sect2">
1.78      rillig   1944: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     1945: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1946: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1947:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1948: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1949: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1950: <dd>
                   1951: <p>This is a list of values specifying the chain of
                   1952:          compilers to invoke when building packages.  Valid values
                   1953:          are:</p>
1.148     asau     1954: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1955: <li class="listitem"><p><code class="varname">ccc</code>:
                   1956:            Compaq C Compilers (Tru64)</p></li>
                   1957: <li class="listitem"><p><code class="varname">ccache</code>:
                   1958:            compiler cache (chainable)</p></li>
                   1959: <li class="listitem"><p><code class="varname">clang</code>:
                   1960:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1961: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1962:            distributed C/C++ (chainable)</p></li>
1.174     asau     1963: <li class="listitem"><p><code class="varname">f2c</code>:
                   1964:            Fortran 77 to C compiler (chainable)</p></li>
                   1965: <li class="listitem"><p><code class="varname">icc</code>:
                   1966:            Intel C++ Compiler (Linux)</p></li>
                   1967: <li class="listitem"><p><code class="varname">ido</code>:
                   1968:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1969: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1970:            GNU C/C++ Compiler</p></li>
1.174     asau     1971: <li class="listitem"><p><code class="varname">hp</code>:
                   1972:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1973: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1974:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1975: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1976:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1977: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1978:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1979: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1980:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1981: </ul></div>
                   1982: <p>The default is
1.385     leot     1983:          <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>.  You can use
1.89      rillig   1984:          <code class="varname">ccache</code> and/or
                   1985:          <code class="varname">distcc</code> with an appropriate
                   1986:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.385     leot     1987:          e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>.  This
1.94      dmcmahil 1988:          variable should always be terminated with a value for
                   1989:          a real compiler.  Note that only one real compiler
1.385     leot     1990:          should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94      dmcmahil 1991:          is not allowed).</p>
1.89      rillig   1992: </dd>
                   1993: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1994: <dd><p>This specifies the minimum version of GCC to use
                   1995:          when building packages.  If the system GCC doesn't
                   1996:          satisfy this requirement, then pkgsrc will build and
                   1997:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1998: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1999: <dd><p>Specifies which version of python to use when several
                   2000:          options are available.</p></dd>
                   2001: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 2002: <dd><p>Specifies the Fortran compiler to use.
                   2003:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     2004: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   2005: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   2006:          <code class="varname">gfortran</code> is used, this option specifies which
                   2007:          version to use.</p></dd>
1.89      rillig   2008: </dl></div>
                   2009: </div>
1.148     asau     2010: <div class="sect2">
1.89      rillig   2011: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2012: <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   2013: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2014:        please make sure to use the <code class="literal">+=</code> operator
                   2015:        instead of the <code class="literal">=</code> operator:</p>
                   2016: <pre class="programlisting">
1.100     rillig   2017: CFLAGS+=        -your -flags
1.78      rillig   2018: </pre>
                   2019: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.385     leot     2020:        <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117     jnemeth  2021:        need to add their own flags.  You may want to take a look
1.322     leot     2022:        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      2023:        package if you're interested in optimization specifically
                   2024:        for the current CPU. </p>
1.78      rillig   2025: </div>
1.148     asau     2026: <div class="sect2">
1.88      wiz      2027: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2028: <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      2029: <p>If you want to pass flags to the linker, both in the configure
                   2030: step and the build step, you can do this in two ways.  Either set
                   2031: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2032: between the two is that <code class="varname">LIBS</code> will be appended to
                   2033: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2034: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2035: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2036: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2037: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2038: settings, use the <code class="literal">+=</code> operator:</p>
                   2039: <pre class="programlisting">
1.100     rillig   2040: LDFLAGS+=        -your -linkerflags
1.88      wiz      2041: </pre>
                   2042: </div>
1.78      rillig   2043: </div>
1.148     asau     2044: <div class="sect1">
1.78      rillig   2045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2046: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 2047: <p>
1.75      rillig   2048:       </p>
1.148     asau     2049: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2050: <li class="listitem">
1.75      rillig   2051: <p><code class="varname">PKG_DEVELOPER</code>:
1.347     gutterid 2052:         Run some sanity checks that package developers want:
                   2053:         </p>
1.148     asau     2054: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2055: <li class="listitem"><p>make sure patches apply with zero
1.347     gutterid 2056:             fuzz</p></li>
1.128     wiz      2057: <li class="listitem"><p>run check-shlibs to see that all
1.347     gutterid 2058:             binaries will find their shared libs.</p></li>
1.75      rillig   2059: </ul></div>
                   2060: </li>
1.347     gutterid 2061: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>: 
                   2062:         Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
                   2063:         </code> values in PLIST entries.
                   2064:         </p></li>
1.128     wiz      2065: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347     gutterid 2066:         of debugging output which is displayed whilst making and
                   2067:         installing the package.  The default value for this is 0,
                   2068:         which will not display the commands as they are executed
                   2069:         (normal, default, quiet operation); the value 1 will display
                   2070:         all shell commands before their invocation, and the value 2
                   2071:         will display both the shell commands before their invocation,
                   2072:         as well as their actual execution progress with <span class="command"><strong>set
                   2073:         -x</strong></span>.</p></li>
1.75      rillig   2074: </ul></div>
                   2075: <p>
                   2076:     </p>
                   2077: </div>
1.148     asau     2078: <div class="sect1">
1.75      rillig   2079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2080: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.88      wiz      2081: <p>Some packages have build time options, usually to select
                   2082:     between different dependencies, enable optional support for big
                   2083:     dependencies or enable experimental features.</p>
1.75      rillig   2084: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2085:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2086:     show-options</strong></span>, for example:</p>
1.75      rillig   2087: <pre class="programlisting">
                   2088:     The following options are supported by this package:
                   2089:         ssl      Enable SSL support.
                   2090:     Exactly one of the following gecko options is required:
                   2091:         firefox  Use firefox as gecko rendering engine.
                   2092:         mozilla  Use mozilla as gecko rendering engine.
                   2093:     At most one of the following database options may be selected:
                   2094:         mysql    Enable support for MySQL database.
                   2095:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2096: 
1.75      rillig   2097:     These options are enabled by default: firefox
                   2098:     These options are currently enabled: mozilla ssl
1.1       grant    2099: </pre>
1.75      rillig   2100: <p>The following variables can be defined in
1.110     hubertf  2101:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2102:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2103:     which can be used to select or disable options for all packages
                   2104:     that support them, and
                   2105:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2106:     which can be used to select or disable options specifically for
                   2107:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.385     leot     2108:     these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88      wiz      2109:     are disabled. A few examples:</p>
1.75      rillig   2110: <pre class="screen">
1.110     hubertf  2111: <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   2112: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2113: PKG_OPTIONS.kdebase=    debug -sasl
                   2114: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2115: <p>It is important to note that options that were specifically
1.120     snj      2116:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2117:     you do not wish to include the option.  If you are unsure you can view
                   2118:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2119: <p>The following settings are consulted in the order given, and
                   2120:     the last setting that selects or disables an option is
                   2121:     used:</p>
1.128     wiz      2122: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2123: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2124:       maintainer</p></li>
1.128     wiz      2125: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2126:       variables (see below)</p></li>
1.128     wiz      2127: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2128: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2129: </ol></div>
                   2130: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2131:     selected is used, all others are automatically disabled.  If an
                   2132:     option of the group is explicitly disabled, the previously
                   2133:     selected option, if any, is used.  It is an error if no option
                   2134:     from a required group of options is selected, and building the
                   2135:     package will fail.</p>
                   2136: <p>Before the options framework was introduced, build options
                   2137:     were selected by setting a variable (often named
                   2138:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2139:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2140:     transition to the options framework for the user, these legacy
                   2141:     variables are converted to the appropriate options setting
                   2142:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2143:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2144:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2145:     directly.  Support for the legacy variables will be removed
                   2146:     eventually.</p>
1.75      rillig   2147: </div>
                   2148: </div>
1.148     asau     2149: <div class="chapter">
1.75      rillig   2150: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2151: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2152: <div class="toc">
                   2153: <p><b>Table of Contents</b></p>
1.210     leot     2154: <dl class="toc">
1.267     rillig   2155: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2156: <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   2157: </dl>
                   2158: </div>
1.148     asau     2159: <div class="sect1">
1.75      rillig   2160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2161: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2162: <p>Once you have built and installed a package, you can create
                   2163:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.378     leot     2164:     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      2165:     the same package on a group of hosts and wasting CPU time. It also
                   2166:     provides a simple means for others to install your package, should
                   2167:     you distribute it.</p>
                   2168: <p>To create a binary package, change into the appropriate
1.110     hubertf  2169:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2170:     package</strong></span>:</p>
                   2171: <pre class="screen">
1.223     rillig   2172: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2173: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2174: </pre>
1.356     gutterid 2175: <p>This will build your package (if not already done) and package
                   2176:     it into a binary package. You can then use the
                   2177:     <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
                   2178:     created in <code class="varname">PACKAGES</code>, which defaults to
                   2179:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
1.385     leot     2180:     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 2181:     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>
                   2182:     example.</p>
1.385     leot     2183: <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      2184:     such a binary package.</p>
1.75      rillig   2185: </div>
1.148     asau     2186: <div class="sect1">
1.75      rillig   2187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2188: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2189: <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   2190: </div>
                   2191: </div>
1.148     asau     2192: <div class="chapter">
1.106     rillig   2193: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2194: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2195: builds)</h2></div></div></div>
                   2196: <div class="toc">
                   2197: <p><b>Table of Contents</b></p>
1.210     leot     2198: <dl class="toc">
1.267     rillig   2199: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.394     wiz      2200: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk build</a></span></dt>
1.267     rillig   2201: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.394     wiz      2202: <dt><span class="sect1"><a href="#bulk.bob">8.3. Running a bob build</a></span></dt>
                   2203: <dt><span class="sect1"><a href="#bulk.scan">8.4. Speeding up bulk build scans</a></span></dt>
                   2204: <dt><span class="sect1"><a href="#bulk.req">8.5. Requirements of a full bulk build</a></span></dt>
                   2205: <dt><span class="sect1"><a href="#bulk.var">8.6. Bulk build variants</a></span></dt>
                   2206: <dd><dl>
                   2207: <dt><span class="sect2"><a href="#bulk.var.confopt">8.6.1. Detect unknown configure options</a></span></dt>
                   2208: <dt><span class="sect2"><a href="#bulk.var.comperr">8.6.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                   2209: <dt><span class="sect2"><a href="#bulk.var.builderr">8.6.3. Force compiler options only in the build phase</a></span></dt>
                   2210: <dt><span class="sect2"><a href="#bulk.var.dirs">8.6.4. Use custom directories</a></span></dt>
                   2211: <dt><span class="sect2"><a href="#bulk.var.warn">8.6.5. Turn warnings into errors</a></span></dt>
                   2212: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.6.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2213: <dt><span class="sect2"><a href="#bulk.var.strings">8.6.7. Reject packages that contain forbidden strings</a></span></dt>
                   2214: <dt><span class="sect2"><a href="#bulk.var.test">8.6.8. Reject packages whose self-test fails</a></span></dt>
                   2215: <dt><span class="sect2"><a href="#bulk.var.shvar">8.6.9. Reject packages that use undefined shell variables</a></span></dt>
                   2216: <dt><span class="sect2"><a href="#bulk.var.quiet">8.6.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2217: </dl></dd>
1.394     wiz      2218: <dt><span class="sect1"><a href="#creating-cdroms">8.7. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2219: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.7.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2220: </dl>
                   2221: </div>
1.290     gutterid 2222: <p>For a number of reasons, you may want to build binary packages
                   2223: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2224: For instance, when you have multiple machines that should run the same software,
                   2225: it is wasted time if they all build their packages themselves from source.
                   2226: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2227: deploying onto production systems.
1.394     wiz      2228: There is a way of getting a set of binary packages using
                   2229: a bulk build system, for example pbulk ("p" stands for "parallel") or bob.
                   2230: This chapter describes how to set them up.</p>
1.148     asau     2231: <div class="sect1">
1.106     rillig   2232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2233: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2234: <p>First of all, you have to decide whether you build all packages
                   2235: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2236: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2237: A number of particularly heavy packages exist that are not actually
                   2238: interesting to a wide audience. (The approximate resource consumption for a
1.394     wiz      2239: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.5. Requirements of a full bulk build">Section 8.5, “Requirements of a full bulk build”</a>.)
1.290     gutterid 2240: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2241: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2242: </p>
1.394     wiz      2243: <p>During pbulk (but not bob) builds various packages are installed and deinstalled
1.180     wiz      2244: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2245: so make sure that you don't need any package during the builds.
1.223     rillig   2246: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2247: or something even more restrictive, depending on what the operating system provides,
                   2248: or dedicate the whole physical machine.
                   2249: As a useful side effect this makes sure that bulk builds cannot
                   2250: break anything in your system. There have been numerous cases where
1.106     rillig   2251: certain packages tried to install files outside the
                   2252: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2253: <code class="filename">/etc</code>.
                   2254: </p>
1.106     rillig   2255: </div>
1.148     asau     2256: <div class="sect1">
1.106     rillig   2257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.394     wiz      2258: <a name="bulk.pbulk"></a>8.2. Running a pbulk build</h2></div></div></div>
                   2259: <p>Running a pbulk build works roughly as follows:</p>
1.148     asau     2260: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2261: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2262: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2263: </ul></div>
1.148     asau     2264: <div class="sect2">
1.116     rillig   2265: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     2266: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2267: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2268: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2269: Configure network access to fetch distribution files.
1.223     rillig   2270: Create a user with name "pbulk".</p>
1.178     asau     2271: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2272: <pre class="screen">
1.264     sevan    2273: <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>
                   2274: <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      2275: <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     2276: </pre>
                   2277: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2278: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2279: <pre class="screen">
1.230     sevan    2280: <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     2281: <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>
                   2282: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2283: </pre>
                   2284: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2285: <h3 class="title">Note</h3>
                   2286: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2287: <code class="filename">mk.conf</code> that contains settings you want to
                   2288: apply to packages you build. For instance,</p>
                   2289: <pre class="programlisting">
1.223     rillig   2290: PKG_DEVELOPER=          yes     # perform more checks
                   2291: X11_TYPE=               modular # use pkgsrc X11
                   2292: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2293:                                 # when building all packages)
1.178     asau     2294: </pre>
                   2295: </div>
                   2296: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2297: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2298: <pre class="programlisting">
                   2299: www/firefox
                   2300: mail/thunderbird
                   2301: misc/libreoffice4
                   2302: </pre>
1.179     asau     2303: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2304: and make final amendments, if wanted.</p>
1.178     asau     2305: <p>Start it:</p>
                   2306: <pre class="screen">
                   2307: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2308: </pre>
                   2309: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2310: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2311: </p>
                   2312: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2313: <h3 class="title">Note</h3>
                   2314: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2315: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2316: The script is kept small enough for better understanding.</p>
                   2317: </div>
                   2318: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2319: <h3 class="title">Note</h3>
                   2320: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320     wiz      2321: unprivileged bulk build and helps configuring distributed bulk builds.
                   2322: Distributed bulk builds support either building in worker chroots
                   2323: (each node is a path to a different chroot)
                   2324: that replicate the target system, including the pbulk prefix,
                   2325: or remote machines (each node is
                   2326: an IP address that must be accessible over SSH without a password).</p>
1.178     asau     2327: </div>
1.106     rillig   2328: </div>
                   2329: </div>
1.148     asau     2330: <div class="sect1">
1.106     rillig   2331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.394     wiz      2332: <a name="bulk.bob"></a>8.3. Running a bob build</h2></div></div></div>
                   2333: <p>Bob is designed to be a simpler and more powerful alternative to
                   2334: pbulk.  To get started, install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/bob/index.html" target="_top"><code class="filename">pkgtools/bob</code></a> package, modify
                   2335: <code class="filename">${PKG_SYSCONFBASE}/bob/config.lua</code> to customize
                   2336: the packages you wish to build and tune the settings for your system,
                   2337: then run</p>
                   2338: <pre class="screen">
                   2339: <code class="prompt">#</code> <strong class="userinput"><code>bob build</code></strong>
                   2340: </pre>
                   2341: <p>This will build all of the packages you have selected inside
                   2342: clean sandboxes, and produce a <code class="filename">pkg_summary</code> file
                   2343: at the end, ready for <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>
                   2344: to upgrade the system.</p>
                   2345: <p>Any time you update your pkgsrc checkout, first run</p>
                   2346: <pre class="screen">
                   2347: <code class="prompt">#</code> <strong class="userinput"><code>bob clean</code></strong>
                   2348: </pre>
                   2349: <p>to remove the existing build metadata before starting a new build.</p>
                   2350: <p>Some other useful features include being able to run a scan separately first, so that you can see what packages will be built:</p>
                   2351: <pre class="screen">
                   2352: <code class="prompt">#</code> <strong class="userinput"><code>bob scan</code></strong>
                   2353: <code class="prompt">#</code> <strong class="userinput"><code>bob status</code></strong>
                   2354: </pre>
                   2355: <p>You can also add arbitrary packages to the current build by providing a <code class="varname">PKGPATH</code> as an argument:</p>
                   2356: <pre class="screen">
                   2357: <code class="prompt">#</code> <strong class="userinput"><code>bob build graphics/png</code></strong>
                   2358: </pre>
                   2359: <p>If a package fails to build you can view the log file:</p>
                   2360: <pre class="screen">
                   2361: <code class="prompt">#</code> <strong class="userinput"><code>bob log png</code></strong>
                   2362: </pre>
                   2363: <p>If you fix an issue and you only want to rebuild the previously failed packages without starting from scratch, you can run:</p>
                   2364: <pre class="screen">
                   2365: <code class="prompt">#</code> <strong class="userinput"><code>bob rebuild -a</code></strong>
                   2366: </pre>
                   2367: <p>Other useful commands:</p>
                   2368: <pre class="screen">
                   2369: <code class="prompt">#</code> <strong class="userinput"><code>bob dev # run an interactive sandbox for development work</code></strong>
                   2370: <code class="prompt">#</code> <strong class="userinput"><code>bob history # show package build history</code></strong>
                   2371: <code class="prompt">#</code> <strong class="userinput"><code>bob publish # generate build reports, emails, and publish packages</code></strong>
                   2372: </pre>
                   2373: <p>For more details, please see <a class="ulink" href="https://docs.rs/bob/latest/bob/" target="_top">https://docs.rs/bob/latest/bob/</a>.</p>
                   2374: </div>
                   2375: <div class="sect1">
                   2376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2377: <a name="bulk.scan"></a>8.4. Speeding up bulk build scans</h2></div></div></div>
1.390     wiz      2378: <p>At the start of a bulk build. pkgsrc is scanned for details
                   2379:   about the packages to build. This is needed e.g. to build a
                   2380:   dependency graph for building the packages in the correct
                   2381:   order.</p>
                   2382: <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
                   2383:   speed this up, some variables can be pre-computed and others can be
                   2384:   cached. This will greatly reduce the time needed for the scan part
                   2385:   of a bulk build.</p>
                   2386: <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>
                   2387:   package provides a Makefile target to precompute some often-used
                   2388:   variables for the build system that shouldn't change during one
                   2389:   build. Redirect its output to a file and include it from
                   2390:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>; for example:</p>
                   2391: <pre class="screen">
                   2392: <code class="prompt">$</code> <strong class="userinput"><code>cd pkgtools/varcache</code></strong>
                   2393: <code class="prompt">$</code> <strong class="userinput"><code>make show-varcache &gt; /etc/varcache.mk</code></strong>
                   2394: <code class="prompt">$</code> <strong class="userinput"><code>echo .include "varcache.mk" &gt;&gt; /etc/mk.conf</code></strong>
                   2395:   </pre>
                   2396: <p>Some system information is needed quite early in the build
                   2397:   and can not be cached this way. It must be set in the environment
                   2398:   for the next speed-up:</p>
                   2399: <pre class="screen">
                   2400: <code class="prompt">$</code> <strong class="userinput"><code>export HOST_MACHINE_ARCH=`uname -m`</code></strong>
                   2401: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS=`uname -s`</code></strong>
                   2402: <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>
                   2403: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OS_VERSION=`uname -r`</code></strong>
                   2404:   </pre>
                   2405: <p>Some settings that also affect the scan time strongly can be set in
                   2406:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
                   2407: <pre class="programlisting">
                   2408: NATIVE_PKG_TOOLS_BIN=/usr/sbin # location on NetBSD
                   2409: NO_PKGTOOLS_REQD_CHECK=yes     # assume pkg tools are up-to-date
                   2410: SKIP_LICENSE_CHECK=yes         # do not check license validity
                   2411: _SRC_TOP_=                     # bulk build is not running from inside /usr/src
                   2412: UNPRIVILEGED_USER=pbulk        # use the appropriate user for your system
                   2413: UNPRIVILEGED_GROUP=builder     # use the appropriate group for your system
                   2414: UNPRIVILEGED_GROUPS=builder    # use the appropriate groups for your system
                   2415: </pre>
                   2416: <p>Finally, some packages require information about build options
                   2417: of other packages. This information can be cached by setting
                   2418: <code class="varname">PBULK_CACHE_DIRECTORY</code>.</p>
                   2419: <pre class="programlisting">
                   2420: PBULK_CACHE_DIRECTORY=/tmp/pbulk_cache
                   2421: </pre>
                   2422: <p>For all of these: please make sure they are kept up-to-date for
                   2423: changes in your environment. The safest method is to re-create the
                   2424: varcache before each build, make sure the environment variables are
                   2425: still up-to-date, and to delete the
                   2426: <code class="varname">PBULK_CACHE_DIRECTORY</code> before builds.</p>
                   2427: </div>
                   2428: <div class="sect1">
                   2429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.394     wiz      2430: <a name="bulk.req"></a>8.5. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2431: <p>A complete bulk build requires lots of disk space. Some of the
                   2432: disk space can be read-only, some other must be writable. Some can be on
                   2433: remote filesystems (such as NFS) and some should be local. Some can be
                   2434: temporary filesystems, others must survive a sudden reboot.</p>
                   2435: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320     wiz      2436: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2437: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180     wiz      2438: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2439: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2440: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2441: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2442: </ul></div>
                   2443: </div>
                   2444: <div class="sect1">
                   2445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.394     wiz      2446: <a name="bulk.var"></a>8.6. Bulk build variants</h2></div></div></div>
1.293     rillig   2447: <p>To ensure that pkgsrc packages work in different configurations, it
                   2448: makes sense to run non-default bulk builds from time to time. This
                   2449: section lists some ideas for bulk builds that intentionally let packages
                   2450: fail if they don't follow the pkgsrc style.</p>
                   2451: <div class="sect2">
                   2452: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2453: <a name="bulk.var.confopt"></a>8.6.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2454: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2455: <pre class="programlisting">
                   2456: GNU_CONFIGURE_STRICT=   yes
                   2457: </pre>
                   2458: <p>When a package fails this additional check, the most common cause
                   2459: is that the configure option was valid for an older version of the
                   2460: package but does not apply anymore. In that case, just remove it.</p>
                   2461: </div>
                   2462: <div class="sect2">
                   2463: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2464: <a name="bulk.var.comperr"></a>8.6.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2465: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2466: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2467: compiler wrappers make it easy to force compiler options when the package
                   2468: is built. This can be used to find typical bugs across all packages that
                   2469: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2470: more reliable with the next updates.</p>
                   2471: <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   2472: <pre class="programlisting">
                   2473: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2474: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2475: </pre>
1.294     rillig   2476: <p>When a package fails to build using these stricter compiler
                   2477: options, document the circumstances in which the compiler produced the
                   2478: error message. This includes:</p>
1.293     rillig   2479: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2480: <li class="listitem"><p>The platform
                   2481: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2482: <li class="listitem"><p>The source file</p></li>
                   2483: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2484: part of the diagnostic.</p></li>
1.294     rillig   2485: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2486: </ul></div>
                   2487: <p>If a package produces these error messages, but the package is
1.294     rillig   2488: 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
                   2489: in the next builds:</p>
1.293     rillig   2490: <pre class="programlisting">
1.294     rillig   2491: .if ${PKGPATH} == category/package
1.293     rillig   2492: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2493: # error message
                   2494: # code
1.294     rillig   2495: # Reason why the code does not need to be fixed.
1.293     rillig   2496: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2497: .endif
1.293     rillig   2498: </pre>
                   2499: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2500: needs to be fixed, prepare a local patch (see
                   2501: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2502: authors of the package, providing them with the information you collected
                   2503: above.</p>
                   2504: <p>Patches that are not essential for the package to work should only
                   2505: be reported upstream but not committed to pkgsrc, to make future updates
                   2506: easier.</p>
1.293     rillig   2507: </div>
                   2508: <div class="sect2">
                   2509: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2510: <a name="bulk.var.builderr"></a>8.6.3. Force compiler options only in the build phase</h3></div></div></div>
1.296     rillig   2511: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2512: these apply to all phases of the package build process. Especially in the
                   2513: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2514: decisions. The GNU configure scripts feed many small test programs to the
                   2515: C compiler to see whether certain headers are available, functions are
                   2516: defined in a library and programs can be run. In many cases these
                   2517: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2518: -Wextra -Werror</code>.</p>
                   2519: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2520: options being added between the <code class="literal">configure</code> and
                   2521: <code class="literal">build</code> phases. It's a little more complicated than the
                   2522: other examples in this section but still easy enough.</p>
                   2523: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2524: desired compiler options. The compiler wrapper's original task is to hide
                   2525: unwanted directories of include files and to normalize compiler options.
                   2526: It does this by wrapping the compiler command and rewriting the command
                   2527: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2528: package directory and examine the
                   2529: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2530: individual configurations for the C compiler and the related tools. The
                   2531: plan is to find a hook between the configure and build phases, and to
                   2532: modify these configuration files at that point.</p>
                   2533: <p>To find this hook, have a look at
                   2534: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2535: <code class="literal">pre-build-checks-hook</code>. The word
                   2536: <code class="literal">checks</code> doesn't quite fit, but the
                   2537: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2538: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2539: <pre class="programlisting">
                   2540: # Just a few example options.
                   2541: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2542: 
                   2543: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2544: pre-build-checks-hook: add-build-only-cflags
                   2545: 
                   2546: add-build-only-cflags: .PHONY
                   2547:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2548:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2549:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2550:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2551:         done;                                   \
                   2552:         &gt; ${.TARGET}
                   2553: .endif
                   2554: </pre>
                   2555: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2556: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2557: not with spaces.)</p>
                   2558: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2559: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2560: should be undefined, possibly because it is only defined for a subset of
                   2561: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2562: at least one compiler option, to prevent a syntax error in the shell
                   2563: parser.</p>
                   2564: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2565: that the additional compiler options are only appended once, even if
                   2566: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2567: creates a marker file.</p>
                   2568: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2569: configure</strong></span> in a package directory. Up to now, everything works
                   2570: as usual. Examine the directory
                   2571: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2572: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2573: the file <code class="filename">cc</code>. Examine the tail of the
                   2574: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2575: options are used.</p>
                   2576: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2577: options to the file <code class="filename">cc</code> and will create the marker
                   2578: file in the same directory. After that, the build starts as usual, but
                   2579: with the added compiler options. Examine the tail of the file
                   2580: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2581: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2582: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2583: with these options.</p>
                   2584: <p>Building packages using this setup variant and fixing the resulting
1.394     wiz      2585: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.6.2. Detect classes of bugs by forcing compiler warnings">Section 8.6.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
1.296     rillig   2586: </div>
                   2587: <div class="sect2">
                   2588: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2589: <a name="bulk.var.dirs"></a>8.6.4. Use custom directories</h3></div></div></div>
1.293     rillig   2590: <p>Some directories like <code class="varname">PREFIX</code>,
                   2591: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2592: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2593: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2594: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2595: <pre class="programlisting">
                   2596: PREFIX=         /a-random-uuid
                   2597: PKG_SYSCONFDIR= /a-random-uuid
                   2598: VARBASE=        /a-random-uuid
                   2599: PKGMANDIR=     a-random-uuid
                   2600: PKG_INFODIR=   a-random-uuid
                   2601: </pre>
                   2602: </div>
                   2603: <div class="sect2">
                   2604: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2605: <a name="bulk.var.warn"></a>8.6.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2606: <p>When building a package, warnings are typically ignored since they
                   2607: just flow by and do not cause the build to fail immediately. To find
                   2608: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2609: <pre class="programlisting">
                   2610: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2611: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2612: </pre>
                   2613: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2614: them can be redefined with a simple definition like above.</p>
1.294     rillig   2615: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2616: the package Makefile, research whether the package actually needs Perl.
                   2617: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2618: Makefile, and if it doesn't, add
                   2619: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2620: </div>
                   2621: <div class="sect2">
                   2622: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2623: <a name="bulk.var.pkglint"></a>8.6.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2624: <p>Using pkglint as part of the regular build process is mostly a
                   2625: waste of time. If you want to fix some of the warnings, just run pkglint
                   2626: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2627: 10), which is much faster than a complete bulk build.</p>
                   2628: </div>
                   2629: <div class="sect2">
                   2630: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2631: <a name="bulk.var.strings"></a>8.6.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2632: <p>To ensure that the binary packages don't contain references to the
                   2633: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2634: that variable includes the item <code class="literal">extra</code>, it is
                   2635: possible to define additional patterns that must not appear in any
                   2636: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2637: <pre class="programlisting">
                   2638: CHECK_WRKREF=                   extra
                   2639: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2640: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2641: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2642: </pre>
                   2643: <p>The above patterns will probably generate many false positives,
                   2644: therefore the results need to be taken with a grain of salt.</p>
                   2645: </div>
                   2646: <div class="sect2">
                   2647: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2648: <a name="bulk.var.test"></a>8.6.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2649: <p>To run the test suites that come with each package, add this line
                   2650: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2651: <pre class="programlisting">
                   2652: PKGSRC_RUN_TEST=        yes
                   2653: </pre>
                   2654: <p>Be prepared that even the most basic packages fail this test. When
                   2655: doing a bulk build with this, it will often abort in the early phase
                   2656: where the packages are scanned for their dependencies since there are
                   2657: cyclic dependencies. There is still a lot to do in this area.</p>
                   2658: </div>
                   2659: <div class="sect2">
                   2660: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2661: <a name="bulk.var.shvar"></a>8.6.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2662: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2663: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2664: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2665: <pre class="programlisting">
                   2666: RUN=    @set -eu;
                   2667: </pre>
1.296     rillig   2668: <p>After that, ensure that none of the bulk build log files (even
                   2669: those for successfully built packages) contains the string
                   2670: <code class="literal">parameter not set</code> or whatever error message the
                   2671: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2672: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2673: definition.</p>
                   2674: </div>
                   2675: <div class="sect2">
                   2676: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2677: <a name="bulk.var.quiet"></a>8.6.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2678: <p>The build logs of a package are often quite long. This allows error
                   2679: messages or other interesting details to hide between the noise. To make
                   2680: the actual error message stand out more, add these lines to
                   2681: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2682: <pre class="programlisting">
                   2683: GNU_CONFIGURE_QUIET=    yes
                   2684: MAKE_FLAGS+=            -s
                   2685: </pre>
                   2686: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2687: Make. On exotic platforms with their own make, it may be a little
                   2688: different.</p>
                   2689: </div>
                   2690: </div>
                   2691: <div class="sect1">
                   2692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.394     wiz      2693: <a name="creating-cdroms"></a>8.7. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2694: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2695:     create a CD-ROM set of the resulting binary packages to assist
                   2696:     in installing packages on other machines.  The
1.322     leot     2697:     <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      2698:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2699:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2700:     way that keeps all the dependencies for a given package on the same
                   2701:     CD as that package.</p>
1.148     asau     2702: <div class="sect2">
1.75      rillig   2703: <div class="titlepage"><div><div><h3 class="title">
1.394     wiz      2704: <a name="cdpack-example"></a>8.7.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2705: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2706:       man page. The following short example assumes that the binary
                   2707:       packages are left in
                   2708:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2709:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2710:       hold the ISO 9660 images.</p>
                   2711: <pre class="screen">
                   2712: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2713: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2714: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2715:       </pre>
                   2716: <p>If you wish to include a common set of files
                   2717:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2718:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2719:       directory which contains these files, e.g.:</p>
1.87      wiz      2720: <pre class="screen">
                   2721: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2722: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2723: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2724: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2725: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2726: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2727: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2728:       </pre>
1.75      rillig   2729: <p>Now create the images:</p>
                   2730: <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   2731: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2732:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2733:       in their root directories.</p>
1.75      rillig   2734: </div>
                   2735: </div>
                   2736: </div>
1.148     asau     2737: <div class="chapter">
1.75      rillig   2738: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2739: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2740: <div class="toc">
                   2741: <p><b>Table of Contents</b></p>
1.210     leot     2742: <dl class="toc">
1.267     rillig   2743: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2744: <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   2745: </dl>
                   2746: </div>
                   2747: <p>The files that are installed by pkgsrc are organized in a way that
                   2748: is similar to what you find in the <code class="filename">/usr</code> directory
                   2749: of the base system. But some details are different. This is because
                   2750: pkgsrc initially came from FreeBSD and had adopted its file system
                   2751: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2752: which operating system you are using pkgsrc with, you can expect the
                   2753: same layout for pkgsrc.</p>
1.91      rillig   2754: <p>There are mainly four root directories for pkgsrc, which are all
                   2755: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2756: When pkgsrc has been installed as root, the default locations
                   2757: are:</p>
                   2758: <pre class="programlisting">
1.100     rillig   2759: LOCALBASE=              /usr/pkg
                   2760: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2761: VARBASE=                /var
1.231     sevan    2762: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2763: </pre>
                   2764: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2765: user), the default locations are:</p>
                   2766: <pre class="programlisting">
1.100     rillig   2767: LOCALBASE=              ${HOME}/pkg
                   2768: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2769: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2770: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2771: </pre>
                   2772: <p>What these four directories are for, and what they look like is
                   2773: explained below.</p>
1.148     asau     2774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2775: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2776: <code class="filename">/usr</code> directory in the base system. It is the
1.385     leot     2777: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90      rillig   2778: the well-known subdirectories like <code class="filename">bin</code>,
                   2779: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2780: <code class="filename">share</code> and
                   2781: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2782: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2783: <code class="filename">/var</code> in the base system. Some programs (especially
                   2784: games, network daemons) need write access to it during normal
                   2785: operation.</p></li>
1.128     wiz      2786: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2787: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2788: 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   2789: itself.</p></li>
                   2790: </ul></div>
1.148     asau     2791: <div class="sect1">
1.90      rillig   2792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2793: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2794: </h2></div></div></div>
1.90      rillig   2795: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2796: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2797: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2798: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2799: <dd><p>Contains executable programs that are intended to be
                   2800: directly used by the end user.</p></dd>
                   2801: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2802: <dd><p>Contains files for the emulation layers of various other
                   2803: operating systems, especially for
                   2804: NetBSD.</p></dd>
                   2805: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2806: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2807: <dd><p>Contains
                   2808: the configuration files.</p></dd>
                   2809: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2810: <dd><p>Contains headers for the C and C++ programming
                   2811: languages.</p></dd>
                   2812: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2813: <dd><p>Contains GNU info files of various
                   2814: packages.</p></dd>
                   2815: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2816: <dd><p>Contains shared and static
                   2817: libraries.</p></dd>
                   2818: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2819: <dd><p>Contains data files that don't change after
                   2820: installation. Other data files belong into
                   2821: <code class="filename">${VARBASE}</code>.</p></dd>
                   2822: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2823: <dd><p>Contains programs that are not intended to be used by
                   2824: end users, such as helper programs or network
                   2825: daemons.</p></dd>
                   2826: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2827: <dd><p>Contains programs that are intended to be executed as
                   2828: CGI scripts by a web server.</p></dd>
                   2829: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2830: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2831: <dd><p>Contains brief
                   2832: documentation in form of manual pages.</p></dd>
                   2833: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2834: <dd><p>Contains programs that are intended to be used only by
                   2835: the super-user.</p></dd>
                   2836: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2837: <dd><p>Contains platform-independent data files that don't
                   2838: change after installation.</p></dd>
                   2839: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2840: <dd><p>Contains documentation files provided by the
                   2841: packages.</p></dd>
                   2842: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2843: <dd><p>Contains example files provided by the packages. Among
                   2844: others, the original configuration files are saved here and copied to
                   2845: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2846: installation.</p></dd>
                   2847: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2848: <dd><p>Contains the original files for rc.d
                   2849: scripts.</p></dd>
                   2850: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2851: <code class="filename">${VARBASE}</code>)</span></dt>
                   2852: <dd><p>Contains files
                   2853: that may be modified after
                   2854: installation.</p></dd>
                   2855: </dl></div>
                   2856: </div>
1.148     asau     2857: <div class="sect1">
1.90      rillig   2858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2859: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2860: </h2></div></div></div>
1.148     asau     2861: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2862: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2863: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2864: <dd><p>Contains
                   2865: information about the currently installed
                   2866: packages.</p></dd>
                   2867: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2868: <dd><p>Contains highscore
                   2869: files.</p></dd>
                   2870: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2871: <dd><p>Contains log files.</p></dd>
                   2872: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2873: <dd><p>Contains informational files about daemons that are
                   2874: currently running.</p></dd>
                   2875: </dl></div>
                   2876: </div>
                   2877: </div>
1.148     asau     2878: <div class="chapter">
1.90      rillig   2879: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     2880: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2881: <div class="toc">
                   2882: <p><b>Table of Contents</b></p>
1.210     leot     2883: <dl class="toc">
1.267     rillig   2884: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2885: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2886: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2887: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2888: <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>
                   2889: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2891: <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>
                   2892: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.385     leot     2893: <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
                   2894: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
                   2895: <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      2896: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267     rillig   2897: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2898: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2899: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2900: <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     2901: <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   2902: </dl>
                   2903: </div>
                   2904: <p>This section contains hints, tips &amp; tricks on special things in
                   2905: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2906: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2907: <div class="sect1">
1.75      rillig   2908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2909: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2910: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2912: <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   2913:          This is a general purpose list for most issues regarding
                   2914:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2915:          for pkgsrc configuration, unexpected build failures, using
                   2916:          particular packages, upgrading pkgsrc installations,
                   2917:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2918:          proposals for changes that impact the pkgsrc user community,
                   2919:          e.g. major infrastructure changes, new features, package
                   2920:          removals, etc., may also be posted.</p></li>
1.289     leot     2921: <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   2922:          A list where the results of pkgsrc bulk builds are sent and
                   2923:          discussed.</p></li>
1.289     leot     2924: <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   2925:          This list is for those who are interested in getting a
                   2926:          commit message for every change committed to pkgsrc. It is
                   2927:          also available in digest form, meaning one daily message
                   2928:          containing all commit messages for changes to the package
                   2929:          source tree in that 24 hour period.</p></li>
                   2930: </ul></div>
                   2931: <p>To subscribe, do:</p>
                   2932: <pre class="programlisting">
1.100     rillig   2933: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2934: </pre>
                   2935: <p>Archives for all these mailing lists are available from
1.289     leot     2936: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2937: </div>
1.148     asau     2938: <div class="sect1">
1.75      rillig   2939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     2940: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2941: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2942: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2943: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2944: they might be useful, and not to duplicate the documentation that comes
                   2945: with each package.</p>
                   2946: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322     leot     2947: <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   2948:       Symlinks for use by buildlink.</p></li></ul></div>
                   2949: <p>OS tool augmentation (automatically installed when needed):</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/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2952:       Calculates various kinds of checksums (including SHA3).</p></li>
1.322     leot     2953: <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   2954:       Compatibility library for pkgsrc tools.</p></li>
1.322     leot     2955: <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      2956:       non-BSD systems due to lack of native mtree.</p></li>
1.322     leot     2957: <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   2958:       Up-to-date replacement for
1.76      rillig   2959:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2960:       systems where pkg_install is not present.</p></li>
                   2961: </ul></div>
                   2962: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2963: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2964: <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   2965:       Create a binary package from an
1.110     hubertf  2966:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2967:       save the old package.</p></li>
1.322     leot     2968: <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   2969:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2970:       from multiple locations. It currently supports the following
                   2971:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322     leot     2972: <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  2973:       the best compiler flags to optimise code for your current
1.128     wiz      2974:       CPU and compiler. </p></li>
1.75      rillig   2975: </ul></div>
                   2976: <p>Utilities for keeping track of installed packages, being up to date,
                   2977: etc:</p>
1.148     asau     2978: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2979: <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      2980:     update tool similar to apt(1). Download, install, and upgrade
                   2981:     binary packages easily.</p></li>
1.322     leot     2982: <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   2983:       packages whose installed versions do not match the latest pkgsrc
                   2984:       entries.</p></li>
1.322     leot     2985: <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   2986:       dependency graphs of packages, to aid in choosing a strategy for
                   2987:       updating.</p></li>
1.322     leot     2988: <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
                   2989:       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>
                   2990: <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   2991:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322     leot     2992: <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   2993:       does various checks on the complete pkgsrc system.</p></li>
1.322     leot     2994: <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   2995:       packages you have installed.</p></li>
                   2996: </ul></div>
                   2997: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2998: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     2999: <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   3000:       making and maintaining patches for a package (includes pkgdiff,
                   3001:       pkgvi, mkpatches, etc.).</p></li>
1.322     leot     3002: <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   3003:       converting to pkgsrc.</p></li>
                   3004: </ul></div>
                   3005: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3006: utilities)</p>
1.148     asau     3007: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     3008: <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   3009:       packages in a chrooted area.</p></li>
1.322     leot     3010: <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   3011:       kernel version for chrooted cross builds.</p></li>
                   3012: </ul></div>
                   3013: </div>
1.148     asau     3014: <div class="sect1">
1.75      rillig   3015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3016: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   3017: <p>To install packages from source as a non-root user, download
1.385     leot     3018: 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   3019: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   3020: --unprivileged</strong></span>.</p>
                   3021: <p>This will install the binary part of pkgsrc to
                   3022: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   3023: into <code class="filename">~/pkg/etc</code>.</p>
                   3024: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   3025: </div>
1.148     asau     3026: <div class="sect1">
1.75      rillig   3027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3028: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3029: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3030: enable this feature by adding the option
                   3031: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3032: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3033: distfile is found, pkgsrc will try to resume it.</p>
                   3034: <p>You can also
1.168     wiz      3035: use a different program than the platform default program by changing the
1.117     jnemeth  3036: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3037: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3038: by using the value manual.  A value of custom disables the system defaults
                   3039: and dependency tracking for the fetch program.  In that case you have to
                   3040: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3041: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3042: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3043: <p>For example, if you want to use
1.117     jnemeth  3044: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3045: like:</p>
                   3046: <pre class="programlisting">
1.223     rillig   3047: FETCH_USING=    wget
1.1       grant    3048: </pre>
1.75      rillig   3049: </div>
1.148     asau     3050: <div class="sect1">
1.75      rillig   3051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3052: <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      3053: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3054: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3055: you will have to add the following line into
1.110     hubertf  3056: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3057: <pre class="programlisting">
1.103     wiz      3058: X11_TYPE=modular
1.1       grant    3059: </pre>
1.75      rillig   3060: </div>
1.148     asau     3061: <div class="sect1">
1.75      rillig   3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3063: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3064: <p>If you are sitting behind a firewall which does not allow direct
                   3065: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3066: relevant proxy hosts.  This is done using an environment variable in the
                   3067: form of a URL, e.g. in Amdahl, the machine
1.385     leot     3068: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75      rillig   3069: port 80 as the proxy port number.  So the proxy environment variables
                   3070: are:</p>
                   3071: <pre class="programlisting">
1.100     rillig   3072: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3073: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3074: </pre>
1.75      rillig   3075: </div>
1.148     asau     3076: <div class="sect1">
1.75      rillig   3077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3078: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      3079: <p>Some fetch tools are not prepared to support HTTPS by default
                   3080: (for example, the one in NetBSD 6.0), or the one installed by the
                   3081: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   3082: dependency graph).</p>
                   3083: <p>Usually you won't notice, because distribution files are
1.385     leot     3084: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
1.173     wiz      3085: be often enough if you are following pkgsrc-current. In that case, set
                   3086: <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     3087: <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      3088: with HTTPS support by default. Of course, these tools need to be
                   3089: installed before you can use them this way.</p>
                   3090: </div>
                   3091: <div class="sect1">
                   3092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3093: <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   3094: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3095: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3096: the first available command from the following list:</p>
1.148     asau     3097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3098: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3099: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3100: </ul></div>
                   3101: <p>On a default NetBSD installation, this will be
1.76      rillig   3102: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3103: connections first, and falls back to active connections if the server
                   3104: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3105: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3106: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3107: <p>Having that option present will prevent
1.76      rillig   3108: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3109: transfers.</p>
                   3110: </div>
1.148     asau     3111: <div class="sect1">
1.75      rillig   3112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3113: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3114: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3115: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3116: 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   3117: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3118: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3119: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3120: resulting list to your machine at work/school and use it there.  If you
1.378     leot     3121: 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   3122: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3123: URL:</p>
                   3124: <p>At home:</p>
                   3125: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3126: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3127: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3128: <p>At work:</p>
                   3129: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3130: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3131: home.</p>
                   3132: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3133: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3134: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3135: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3136: directly by running:</p>
1.75      rillig   3137: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3138: <p>If you even decide to ignore
                   3139: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3140: by running:</p>
                   3141: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3142: </div>
1.148     asau     3143: <div class="sect1">
1.75      rillig   3144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3145: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
                   3146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322     leot     3147: <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   3148: package, you get the error from make that it doesn't know how to make
1.76      rillig   3149: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.385     leot     3150: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75      rillig   3151: the NetBSD base distribution on your machine.  It is recommended to do
                   3152: that to format man pages.</p>
1.322     leot     3153: <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   3154: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3155: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3156: </div>
1.148     asau     3157: <div class="sect1">
1.75      rillig   3158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3159: <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      3160: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3161: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3162: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3163: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3164: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3165: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3166: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3167: -r</strong></span>).</p>
                   3168: </div>
1.148     asau     3169: <div class="sect1">
1.75      rillig   3170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3171: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75      rillig   3172: <p>When installing packages as non-root user and using the just-in-time
1.378     leot     3173: <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   3174: password for each required package installed.  To avoid this, the sudo
                   3175: package can be used, which does password caching over a limited time.  To
1.336     nia      3176: use it, install <span class="command"><strong>sudo</strong></span> or
                   3177: <span class="command"><strong>priv</strong></span> (either as binary package, from
                   3178: <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     3179: <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  3180: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3181: <span class="emphasis"><em>after</em></span> the definition of the
                   3182: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3183: <pre class="programlisting">
1.100     rillig   3184: .if exists(${LOCALBASE}/bin/sudo)
1.379     wiz      3185: SU_CMD=        ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.100     rillig   3186: .endif
1.1       grant    3187: </pre>
1.379     wiz      3188: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
                   3189: <span class="command"><strong>sudo</strong></span> to preserve the environment.
                   3190: Without this, the bin-install target will fail when building a
                   3191: package with a non-default python version.
                   3192: </p>
1.75      rillig   3193: </div>
1.148     asau     3194: <div class="sect1">
1.75      rillig   3195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3196: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3197: <p>As the system administrator, you can choose where configuration files
                   3198: are installed.  The default settings make all these files go into
1.76      rillig   3199: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3200: be suboptimal depending on your expectations (e.g., a read-only,
                   3201: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3202: configuration of the provided packages).</p>
                   3203: <p>In order to change the defaults, you can modify the
                   3204: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3205: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3206: directory; some common examples include <code class="filename">/etc</code> or
                   3207: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3208: <p>Furthermore, you can change this value on a per-package basis by
                   3209: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3210: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3211: package you would like to modify, that is, the contents of
                   3212: <code class="varname">PKGBASE</code>.</p>
                   3213: <p>Note that after changing these settings, you must rebuild and
                   3214: reinstall any affected packages.</p>
                   3215: </div>
1.148     asau     3216: <div class="sect1">
1.75      rillig   3217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3218: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3219: <p>Please be aware that there can often be bugs in third-party software,
                   3220: and some of these bugs can leave a machine vulnerable to exploitation by
                   3221: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3222: maintains a database of known-exploits to packages which have at one time
                   3223: been included in pkgsrc.  The database can be downloaded automatically, and
                   3224: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3225: do this, refer to the following two tools (installed as part of the
1.322     leot     3226: <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      3227: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3228: <li class="listitem">
1.122     reed     3229: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3230:     download a list of the security vulnerabilities information.  This list
1.132     spz      3231:     is kept up to date by the pkgsrc security team, and is distributed
                   3232:     from the NetBSD ftp server:</p>
1.292     leot     3233: <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   3234: </li>
1.128     wiz      3235: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3236:     current machine, checking each known vulnerability.  If a
1.75      rillig   3237:     vulnerable package is installed, it will be shown by output to stdout,
                   3238:     including a description of the type of vulnerability, and a URL
                   3239:     containing more information.</p></li>
                   3240: </ol></div>
1.233     sevan    3241: <p>Use of these tools is strongly recommended!
1.385     leot     3242: 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    3243: reporting.</p>
                   3244: <p>If this database is installed, pkgsrc builds will use it to
                   3245: perform a security check before building any package.</p>
1.75      rillig   3246: </div>
1.148     asau     3247: <div class="sect1">
1.75      rillig   3248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3249: <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   3250: <p>When you add your own preferences to the
                   3251:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3252:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3253:        environment variables to the <code class="filename">./configure</code>
1.378     leot     3254:        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   3255:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3256:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3257:        package.</p>
                   3258: <p>Currently there is no solution to this problem. If you
                   3259:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3260:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3261:        directory and then inspect any <code class="filename">Makefile</code> and
                   3262:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3263:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.385     leot     3264:        these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75      rillig   3265:        programmers write so bad code that it only works for the
                   3266:        specific combination of <code class="varname">CFLAGS</code> they have
                   3267:        chosen.</p>
1.287     rillig   3268: <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>
                   3269: <pre class="programlisting">
                   3270: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3271: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3272: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3273: </pre>
                   3274: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3275: to see whether the above flags are passed to the actual build
                   3276: commands in general.</p>
                   3277: <p>To find out whether the flags are passed to individual compiler
                   3278: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3279: most cases, the flags from the original command lines (the lines starting
                   3280: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3281: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3282: missing from the actual compiler command, it must have been removed by
1.385     leot     3283: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3284: </div>
1.148     asau     3285: <div class="sect1">
1.80      rillig   3286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3287: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3288: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3289: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3290:        case that occurs often is that people only update pkgsrc in
                   3291:        parts, because of performance reasons. Since pkgsrc is one large
                   3292:        system, not a collection of many small systems, there are
                   3293:        sometimes changes that only work when the whole pkgsrc tree is
                   3294:        updated.</p></li>
1.148     asau     3295: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.385     leot     3296:        Search for <span class="quote">“<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>”</span> or
                   3297:        <span class="quote">“<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>”</span> in all your pkgsrc
1.80      rillig   3298:        files.</p></li>
1.148     asau     3299: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3300:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3301:        verify this.</p></li>
1.218     rillig   3302: <li class="step"><p>If you are a package developer who wants to invest
1.385     leot     3303:        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     3304: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3305:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3306: </ol></div>
                   3307: </div>
1.148     asau     3308: <div class="sect1">
1.88      wiz      3309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3310: <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   3311: <p>You have modified a file from pkgsrc, and someone else has
                   3312: modified that same file afterwards in the CVS repository. Both changes
                   3313: are in the same region of the file, so when you updated pkgsrc, the
                   3314: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3315: file. Because of these markers, the file is no longer a valid
                   3316: <code class="filename">Makefile</code>.</p>
                   3317: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3318: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3319: -dP</strong></span> in that directory to download the current version.</p>
                   3320: </div>
1.75      rillig   3321: </div>
                   3322: </div>
1.148     asau     3323: <div class="part">
1.75      rillig   3324: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     3325: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3326: <div class="partintro">
1.77      rillig   3327: <div></div>
                   3328: <p>This part of the book deals with creating and
1.385     leot     3329:        modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77      rillig   3330:        guide on creating a new package. The remaining chapters are more
                   3331:        like a reference manual for pkgsrc.</p>
1.75      rillig   3332: <div class="toc">
                   3333: <p><b>Table of Contents</b></p>
1.210     leot     3334: <dl class="toc">
1.267     rillig   3335: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3336: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3337: <dd><dl>
1.299     rillig   3338: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3339: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3340: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3341: <dd><dl>
1.299     rillig   3342: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3343: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3344: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3345: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3346: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3347: </dl></dd>
1.299     rillig   3348: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3349: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3350: <dd><dl>
                   3351: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3352: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3353: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3354: </dl></dd>
                   3355: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3356: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3357: </dl></dd>
1.299     rillig   3358: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3359: <dd><dl>
1.299     rillig   3360: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3361: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3362: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3363: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3364: <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   3365: <dd><dl>
1.299     rillig   3366: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3367: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3368: </dl></dd>
1.299     rillig   3369: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3370: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3371: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3372: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3373: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3374: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3375: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3376: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3377: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3378: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3379: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3380: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3381: </dl></dd>
                   3382: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3383: <dd><dl>
                   3384: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3385: <dd><dl>
1.334     nia      3386: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   3387: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   3388: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106     rillig   3389: </dl></dd>
1.299     rillig   3390: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3391: <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   3392: </dl></dd>
1.299     rillig   3393: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3394: <dd><dl>
1.299     rillig   3395: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3396: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3397: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3398: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3399: <dd><dl>
1.299     rillig   3400: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3401: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3402: <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>
                   3403: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 3404: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106     rillig   3405: </dl></dd>
                   3406: </dl></dd>
1.299     rillig   3407: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3408: <dd><dl>
1.299     rillig   3409: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3410: <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>
                   3411: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3412: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3413: </dl></dd>
1.299     rillig   3414: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3415: <dd><dl>
1.299     rillig   3416: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3417: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3418: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3419: </dl></dd>
                   3420: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3421: <dd><dl>
                   3422: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3423: <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   3424: <dd><dl>
1.299     rillig   3425: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3426: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3427:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3428:       and
                   3429:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3430:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3431: </dl></dd>
1.299     rillig   3432: <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   3433: <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   3434: </dl></dd>
                   3435: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3436: <dd><dl>
1.299     rillig   3437: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3438: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3439: <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>
                   3440: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3441: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3442: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3443: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3444: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3445: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3446: </dl></dd>
1.299     rillig   3447: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3448: <dd><dl>
                   3449: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3450: <dd><dl>
                   3451: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3452: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3453: </dl></dd>
1.299     rillig   3454: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3455: <dd><dl>
1.299     rillig   3456: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3457: <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 3458: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   3459: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   3460: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   3461: </dl></dd>
                   3462: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3463: <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>
                   3464: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3465: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3466: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3467: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3468: <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   3469: </dl></dd>
                   3470: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3471: <dd><dl>
                   3472: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3473: <dd><dl>
                   3474: <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>
                   3475: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3476: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3477: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3478: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3479: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3480: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3481: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3482: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3483: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3484: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3485: </dl></dd>
                   3486: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3487: <dd><dl>
                   3488: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3489: <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>
                   3490: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3491: </dl></dd>
                   3492: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3493: <dd><dl>
                   3494: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3495: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3496: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      3497: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      3498: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   3499: </dl></dd>
                   3500: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3501: <dd><dl>
                   3502: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3503: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      3504: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      3505: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   3506: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   3507: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   3508: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   3509: </dl></dd>
                   3510: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3511: <dd><dl>
                   3512: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3513: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3514: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot     3515: <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   3516: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3517: </dl></dd>
                   3518: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3519: <dd><dl>
                   3520: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3521: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3522: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3523: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3524: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      3525: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      3526: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   3527: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   3528: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   3529: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   3530: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   3531: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   3532: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   3533: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   3534: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   3535: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      3536:     emulation</a></span></dt>
1.369     wiz      3537: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   3538: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77      rillig   3539: </dl></dd>
1.267     rillig   3540: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3541: </dl></dd>
1.299     rillig   3542: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3543: <dd><dl>
                   3544: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3545: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3546: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3547: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3548: </dl></dd>
1.267     rillig   3549: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3550: <dd><dl>
1.267     rillig   3551: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3552: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3553: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3554: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3555: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3556: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3557: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3558: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3559: </dl></dd>
1.382     wiz      3560: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
                   3561: <dd><dl>
                   3562: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   3563: <dd><dl>
                   3564: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   3565: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   3566: </dl></dd>
                   3567: </dl></dd>
                   3568: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.75      rillig   3569: </dl>
                   3570: </div>
1.77      rillig   3571: </div>
1.148     asau     3572: <div class="chapter">
1.77      rillig   3573: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     3574: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
1.267     rillig   3575: <p>
                   3576:        To get help when developing pkgsrc, the definitive source is this
                   3577:        document, the pkgsrc guide. If you don't find anything here,
                   3578:        there are alternatives:
                   3579: </p>
                   3580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3581: <li class="listitem">
                   3582: <p>
                   3583:        The built-in pkgsrc help, which is available after bootstrapping
1.385     leot     3584:        pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.267     rillig   3585:        help for any topic, such as a variable name like
                   3586:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3587:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3588:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.385     leot     3589: <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   3590: </li>
                   3591: <li class="listitem"><p>
1.278     rillig   3592:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3593:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3594: </p></li>
                   3595: <li class="listitem"><p>
                   3596:        To see the values of the most common variables, run
                   3597:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3598:        topic. To see the variables for a single topic, run
                   3599:        <span class="command"><strong>bmake
                   3600:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3601:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3602: </p></li>
                   3603: <li class="listitem"><p>
1.267     rillig   3604:        The tech-pkg mailing list, to which
                   3605:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3606:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3607:        questions</a>.</p></li>
                   3608: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.381     dholland 3609:        <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.267     rillig   3610:        or by using a specialized chat program such as
                   3611:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3612:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3613: </ul></div>
                   3614: </div>
                   3615: <div class="chapter">
                   3616: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     3617: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3618: <div class="toc">
                   3619: <p><b>Table of Contents</b></p>
1.210     leot     3620: <dl class="toc">
1.299     rillig   3621: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3622: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3623: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3624: <dd><dl>
                   3625: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3626: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3627: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3628: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3629: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3630: </dl></dd>
                   3631: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3632: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3633: <dd><dl>
                   3634: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3635: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3636: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3637: </dl></dd>
1.299     rillig   3638: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3639: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3640: </dl>
                   3641: </div>
1.299     rillig   3642: <p>Whenever you're preparing a package, there are a number of
                   3643: files involved which are described in the following
                   3644: sections.</p>
                   3645: <div class="sect1">
                   3646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3647: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
1.299     rillig   3648: </h2></div></div></div>
                   3649: <p>Building, installation and creation of a binary package are all
                   3650:   controlled by the package's <code class="filename">Makefile</code>.
                   3651:   The <code class="filename">Makefile</code> describes various things about
                   3652:   a package, for example from where to get it, how to configure,
                   3653:   build, and install it.</p>
                   3654: <p>A package <code class="filename">Makefile</code> contains several
                   3655:   sections that describe the package.</p>
                   3656: <p>In the first section there are the following variables, which
                   3657:   should appear exactly in the order given here.  The order and
                   3658:   grouping of the variables is mostly historical and has no further
                   3659:   meaning.</p>
                   3660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3661: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3662:     distribution file to be downloaded from the package's
                   3663:     website.</p></li>
                   3664: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3665:     package, as used by pkgsrc. You need to provide it if
                   3666:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3667:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3668:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3669:     directory name together with the version number. It must match the
                   3670:     regular expression
                   3671:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3672:     starts with a letter or digit, and contains only letters, digits,
1.319     nia      3673:     dashes, underscores, dots and plus signs.
                   3674:     New packages should have entirely lower-case names, with the exception
                   3675:     of some that must follow pre-existing conventions
                   3676:     (e.g. R packages begin with <code class="varname">R-</code>).
                   3677:     You can use the <code class="code">:tl</code> variable modifier to lower-case
                   3678:     the package name.</p></li>
1.299     rillig   3679: <li class="listitem">
                   3680: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3681:     which the package fits in. You can choose any of the top-level
                   3682:     directories of pkgsrc for it.</p>
                   3683: <p>Currently the following values are available for
                   3684:     <code class="varname">CATEGORIES</code>. If more than
                   3685:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3686: <pre class="programlisting">
1.299     rillig   3687: archivers     cross         geography     meta-pkgs     security
                   3688: audio         databases     graphics      misc          shells
                   3689: benchmarks    devel         ham           multimedia    sysutils
                   3690: biology       editors       inputmethod   net           textproc
                   3691: cad           emulators     lang          news          time
                   3692: chat          finance       mail          parallel      wm
                   3693: comms         fonts         math          pkgtools      www
                   3694: converters    games         mbone         print         x11
1.77      rillig   3695: </pre>
                   3696: </li>
1.299     rillig   3697: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3698:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3699:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3700:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.385     leot     3701:     <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   3702: </ul></div>
                   3703: <p>The second section contains information about separately
                   3704:   downloaded patches, if any.
                   3705:   </p>
                   3706: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3707: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3708:     Name(s) of additional files that contain distribution patches.
                   3709:     There is no default. pkgsrc will look for them at
                   3710:     <code class="varname">PATCH_SITES</code>.
                   3711:     They will automatically be uncompressed before patching if
                   3712:     the names end with <code class="filename">.gz</code> or
                   3713:     <code class="filename">.Z</code>.</p></li>
                   3714: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3715:     Primary location(s) for distribution patch files (see
                   3716:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3717: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.378     leot     3718:     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   3719:     help find the correct files to patch. It defaults to
1.396   ! wiz      3720:     <span class="command"><strong>-p1</strong></span>.</p></li>
1.299     rillig   3721: </ul></div>
                   3722: <p>The third section contains the following variables.
                   3723:   </p>
                   3724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.367     gdt      3725: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
                   3726:     of the person who is currently responsible for this package.  In
                   3727:     theory, the maintainer will be aware of upstream release, keep it
                   3728:     updated, and generally resolve problems.  Others contemplating
                   3729:     significant changes should ask the maintainer for advice or review
                   3730:     of a proposed change.  This is not necessary for micro updates,
                   3731:     bug fixes, pkgsrc-wide changes affecting many packages, and other
                   3732:     things expected to be uncontroversial.  It goes with this "should
                   3733:     ask" that the maintainer should respond to inquiries reasonably
                   3734:     promptly (most of the time), and either approve changes or provide
                   3735:     reasons why not.  Typically, when packaging a new program, set
                   3736:     <code class="varname">MAINTAINER</code> to yourself.  If you don't intend to
                   3737:     maintain the package (especially if you feel you have no special
                   3738:     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
                   3739:     special value is a code point indicating that there is no
1.392     wiz      3740:     maintainer.</p></li>
1.299     rillig   3741: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3742:     find more information about the package.</p></li>
                   3743: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3744:     description of the package (should not include the package
                   3745:     name).</p></li>
                   3746: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.385     leot     3747:     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   3748: </ul></div>
                   3749: <p>Other variables that affect the build:
                   3750:   </p>
                   3751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3752: <p><code class="varname">WRKSRC</code>: The directory where the
                   3753:       interesting distribution files of the package are found. The
                   3754:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3755:       works for most packages.</p>
                   3756: <p>If a package doesn't create a subdirectory for itself
                   3757:       (most GNU software does, for instance), but extracts itself in
                   3758:       the current directory, you should set
                   3759:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3760: <p>If a package doesn't create a subdirectory with the
                   3761:       name of <code class="varname">DISTNAME</code> but some different name,
                   3762:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3763:       <code class="filename">${WRKDIR}</code>, for example
                   3764:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322     leot     3765:       <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   3766: <p>The name of the working directory created by pkgsrc is
                   3767:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3768:       variable. By default, its value is
                   3769:       <code class="filename">work</code>. If you want to use the same
                   3770:       pkgsrc tree for building different kinds of binary packages,
                   3771:       you can change the variable according to your needs. Two
                   3772:       other variables handle common cases of setting
                   3773:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3774:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3775:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3776:       the host's name is attached to the directory name. If
                   3777:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3778:       is attached, which might look like
                   3779:       <code class="filename">work.i386</code> or
                   3780:       <code class="filename">work.sparc</code>.</p>
                   3781: </li></ul></div>
                   3782: <p>Please pay attention to the following gotchas:</p>
                   3783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3784: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3785:       installed in compressed form by the package.  For packages using
                   3786:       BSD-style makefiles which honor MANZ, there is
                   3787:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3788: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
1.385     leot     3789:       <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.299     rillig   3790:       below).</p></li>
1.385     leot     3791: <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   3792: </ul></div>
                   3793: </div>
1.148     asau     3794: <div class="sect1">
1.91      rillig   3795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3796: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
1.299     rillig   3797: </h2></div></div></div>
                   3798: <p>The <code class="filename">distinfo</code> file contains the message
                   3799:   digest, or checksum, of each distfile needed for the package. This
                   3800:   ensures that the distfiles retrieved from the Internet have not been
                   3801:   corrupted during transfer or altered by a malign force to introduce
                   3802:   a security hole. To provide maximum security, all distfiles are
1.357     gutterid 3803:   protected using two different message digest algorithms (BLAKE2s
                   3804:   and SHA512), as well as the file size.</p>
1.299     rillig   3805: <p>The <code class="filename">distinfo</code> file also contains the
                   3806:   checksums for all the patches found in the
1.385     leot     3807:   <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   3808:   are only applied intentionally and that they don't accidentally change,
                   3809:   e.g. when merging different changes together. They also make sure that
                   3810:   new patches are actually added to CVS and old ones are removed.
                   3811:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3812:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3813: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3814:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3815: <p>Some packages have different sets of distfiles depending on
1.322     leot     3816:   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   3817:   <code class="filename">distinfo</code> file and care should be taken when
                   3818:   upgrading such a package to ensure distfile information is not
                   3819:   lost.</p>
                   3820: </div>
                   3821: <div class="sect1">
                   3822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     3823: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
1.299     rillig   3824: </h2></div></div></div>
                   3825: <p>Some packages don't work out-of-the box on the various
                   3826:   platforms that are supported by pkgsrc. These packages need
                   3827:   to be patched to make them work. The patch files can be
                   3828:   found in the <code class="filename">patches/</code> directory.</p>
                   3829: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3830:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3831:   extracting them, in alphabetic order.</p>
1.148     asau     3832: <div class="sect2">
1.91      rillig   3833: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3834: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
1.299     rillig   3835: <p>The <code class="filename">patch-*</code> files should be in
                   3836:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3837:   problems. (To force patches to apply with fuzz you can set
                   3838:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3839:   should contain only changes for a single file, and no file should be
                   3840:   patched by more than one patch file. This helps to keep future
                   3841:   modifications simple.</p>
                   3842: <p>Each patch file is structured as follows: In the first line,
                   3843:   there is the RCS Id of the patch itself. The second line should be
                   3844:   empty for aesthetic reasons. After that, there should be a comment for
                   3845:   each change that the patch does. There are a number of standard
                   3846:   cases:</p>
                   3847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3848: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3849:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3850: <li class="listitem"><p>Patches that change source code should mention the
                   3851:   platform and other environment (for example, the compiler) that the
                   3852:   patch is needed for.</p></li>
                   3853: </ul></div>
                   3854: <p>The patch should be commented so that any
                   3855:   developer who knows the code of the application can make some use of
                   3856:   the patch. Special care should be taken for the upstream developers,
                   3857:   since we generally want that they accept our patches, so we have less
                   3858:   work in the future.</p>
1.91      rillig   3859: </div>
1.148     asau     3860: <div class="sect2">
1.91      rillig   3861: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3862: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
1.299     rillig   3863: <p>One important thing to mention is to pay attention that no RCS
                   3864:   IDs get stored in the patch files, as these will cause problems when
                   3865:   later checked into the NetBSD CVS tree. Use the
1.322     leot     3866:   <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   3867:   problems.</p>
                   3868: <p>For even more automation, we recommend using
                   3869:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337     gutterid 3870:   whole set of patches. You just have to back up files before you
                   3871:   edit them to <code class="filename">filename.orig</code>, e.g., with
1.299     rillig   3872:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3873:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3874:   you upgrade a package this way, you can easily compare the new
                   3875:   set of patches with the previously existing one with
                   3876:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3877:   are replaced by new files, so carefully check if you want to take all
                   3878:   the changes.</p>
                   3879: <p>When you have finished a package, remember to generate
                   3880:   the checksums for the patch files by using the <span class="command"><strong>make
1.385     leot     3881:   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   3882: <p>When adding a patch that corrects a problem in the
                   3883:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3884:   man pages should go), send the patch as a bug report to the
                   3885:   maintainer.  This benefits non-pkgsrc users of the package,
                   3886:   and usually makes it possible to remove the patch in future
                   3887:   version.</p>
                   3888: <p>The file names of the patch files are usually of the form
                   3889:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3890:   Many packages still use the previous convention
                   3891:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3892:   but new patches should be of the form containing the filename.
1.322     leot     3893:   <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   3894:   automatically.</p>
1.337     gutterid 3895: <p>When updating pre-existing patch files, if a file uses the old
                   3896:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
                   3897:   convention, it's best not to change it to the new form, as that will
                   3898:   just cause churn that makes it harder to track changes to patching
                   3899:   over time. Similarly, if a patch now applies at different line offsets,
                   3900:   but still applies cleanly as-is, there's no need to update it, as that
                   3901:   also unnecessarily complicates the patch history.</p>
1.118     imil     3902: </div>
1.275     brook    3903: <div class="sect2">
                   3904: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3905: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
1.299     rillig   3906: <p>If you want to share patches between multiple packages
                   3907:   in pkgsrc, e.g. because they use the same distfiles, set
                   3908:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3909:   can be found, e.g.:</p>
                   3910: <pre class="programlisting">
                   3911: PATCHDIR=       ../../editors/xemacs/patches
                   3912: </pre>
                   3913: <p>Patch files that are distributed by the author or other
                   3914:     maintainers can be listed in
                   3915:     <code class="varname">PATCHFILES</code>.</p>
                   3916: <p>If it is desired to store any patches that should not be
                   3917:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3918:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3919:     directory tree there is expected to have the same
1.385     leot     3920:     <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.299     rillig   3921:     patches are expected to be stored inside these dirs (also
                   3922:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3923:     example, if you want to keep a private patch for
                   3924:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3925:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3926:     files in the named directory are expected to be patch files,
                   3927:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3928:     applied</em></span>.</p>
1.275     brook    3929: </div>
                   3930: <div class="sect2">
                   3931: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     3932: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
1.299     rillig   3933: <p>When fixing a portability issue in the code do not use
                   3934:       preprocessor magic to check for the current operating system nor
                   3935:       platform.  Doing so hurts portability to other platforms because
                   3936:       the OS-specific details are not abstracted appropriately.</p>
                   3937: <p>The general rule to follow is: instead of checking for the
                   3938:       operating system the application is being built on, check for the
                   3939:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3940:       instead of assuming that kqueue is available under NetBSD and
                   3941:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3942:       kqueue support, add a check that detects kqueue itself &mdash;
                   3943:       yes, this generally involves patching the
                   3944:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3945:       that prevents some OSes from adopting interfaces from other OSes
                   3946:       (e.g. Linux implementing kqueue), something that the above checks
                   3947:       cannot take into account.</p>
                   3948: <p>Of course, checking for features generally involves more
                   3949:       work on the developer's side, but the resulting changes are
                   3950:       cleaner and there are chances they will work on many other
                   3951:       platforms.  Not to mention that there are higher chances of being
                   3952:       later integrated into the mainstream sources.  Remember:
                   3953:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3954: <p>Some typical examples:</p>
                   3955: <div class="table">
1.385     leot     3956: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
1.299     rillig   3957: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3958: <colgroup>
                   3959: <col>
                   3960: <col>
                   3961: <col>
                   3962: </colgroup>
                   3963: <thead><tr>
                   3964: <th>Where</th>
                   3965: <th>Incorrect</th>
                   3966: <th>Correct</th>
                   3967: </tr></thead>
                   3968: <tbody>
                   3969: <tr>
                   3970: <td>configure script</td>
                   3971: <td>
1.275     brook    3972: <pre class="programlisting">
1.299     rillig   3973: case ${target_os} in
                   3974: netbsd*) have_kvm=yes ;;
                   3975: *)       have_kvm=no  ;;
                   3976: esac
1.275     brook    3977: </pre>
1.299     rillig   3978:              </td>
                   3979: <td>
1.275     brook    3980: <pre class="programlisting">
1.299     rillig   3981: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3982: </pre>
1.299     rillig   3983:              </td>
                   3984: </tr>
                   3985: <tr>
                   3986: <td>C source file</td>
                   3987: <td>
1.91      rillig   3988: <pre class="programlisting">
1.299     rillig   3989: #if defined(__NetBSD__)
                   3990: #  include &lt;sys/event.h&gt;
                   3991: #endif
1.91      rillig   3992: </pre>
1.299     rillig   3993:              </td>
                   3994: <td>
1.91      rillig   3995: <pre class="programlisting">
1.299     rillig   3996: #if defined(HAVE_SYS_EVENT_H)
                   3997: #  include &lt;sys/event.h&gt;
                   3998: #endif
1.91      rillig   3999: </pre>
1.299     rillig   4000:              </td>
                   4001: </tr>
                   4002: <tr>
                   4003: <td>C source file</td>
                   4004: <td>
1.91      rillig   4005: <pre class="programlisting">
1.299     rillig   4006: int
                   4007: monitor_file(...)
                   4008: {
                   4009: #if defined(__NetBSD__)
                   4010:         int fd = kqueue();
                   4011:         ...
                   4012: #else
                   4013:         ...
                   4014: #endif
                   4015: }
1.91      rillig   4016: </pre>
1.299     rillig   4017:              </td>
                   4018: <td>
1.91      rillig   4019: <pre class="programlisting">
1.299     rillig   4020: int
                   4021: monitor_file(...)
                   4022: {
                   4023: #if defined(HAVE_KQUEUE)
                   4024:         int fd = kqueue();
                   4025:         ...
                   4026: #else
                   4027:         ...
                   4028: #endif
                   4029: }
1.91      rillig   4030: </pre>
1.299     rillig   4031:              </td>
                   4032: </tr>
                   4033: </tbody>
                   4034: </table></div>
                   4035: </div>
                   4036: <br class="table-break">
                   4037: </div>
                   4038: <div class="sect2">
                   4039: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4040: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
1.299     rillig   4041: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4042:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4043:       improvements you do to a package to the mainstream developers.
                   4044:       This is the only way to get their attention on portability issues
                   4045:       and to ensure that future versions can be built out-of-the box on
                   4046:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4047:       the fixes straight from the packaged code.</p>
                   4048: <p>This generally involves cleaning up the patches
                   4049:       (because sometimes the patches that are
                   4050:       added to pkgsrc are quick hacks), filing bug reports in the
                   4051:       appropriate trackers for the projects and working with the
                   4052:       mainstream authors to accept your changes.  It is
                   4053:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4054:       the packages in pkgsrc are kept simple and thus further changes
                   4055:       can be done without much hassle.</p>
                   4056: <p>When you have done this, please add a URL to the upstream
                   4057:       bug report to the patch comment.</p>
                   4058: <p>Support the idea of free software!</p>
                   4059: </div>
1.91      rillig   4060: </div>
1.299     rillig   4061: <div class="sect1">
                   4062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4063: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
1.299     rillig   4064: <div class="variablelist"><dl class="variablelist">
                   4065: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4066: <dd><p>A multi-line description of the piece of software.  This should include
                   4067:          any credits where they are due.  Please bear in mind that others do not
                   4068:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4069:          will read everything that you write here.</p></dd>
                   4070: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4071: <dd><p>This file governs the files that are installed on your
                   4072:          system: all the binaries, manual pages, etc. There are other
                   4073:          directives which may be entered in this file, to control the
                   4074:          creation and deletion of directories, and the location of
1.385     leot     4075:          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   4076:          information.</p></dd>
                   4077: </dl></div>
                   4078: </div>
                   4079: <div class="sect1">
                   4080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4081: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
1.299     rillig   4082: <div class="sect2">
                   4083: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4084: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
1.299     rillig   4085: <div class="variablelist"><dl class="variablelist">
                   4086: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   4087: <dd>
1.378     leot     4088: <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   4089:            First time after package extraction and before files are
                   4090:            moved in place, the second time after the files to install
                   4091:            are moved in place. This can be used to do any custom
                   4092:            procedures not possible with @exec commands in
1.378     leot     4093:            <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     4094:            <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   4095:            Please note that you can modify variables in it easily by using
                   4096:            <code class="varname">FILES_SUBST</code> in the package's
                   4097:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4098: <pre class="programlisting">
1.299     rillig   4099: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4100: </pre>
1.385     leot     4101: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
1.299     rillig   4102:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4103:            performed for <code class="varname">PREFIX</code>,
                   4104:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4105:            <code class="varname">VARBASE</code>, and a few others, type
                   4106:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4107:            complete list.</p>
                   4108: </dd>
                   4109: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4110: <dd><p>This script is executed before and after any files are removed.  It is
                   4111:            this script's responsibility to clean up any additional messy details
                   4112:            around the package's installation, since all pkg_delete knows is how to
                   4113:            delete the files created in the original distribution.
1.378     leot     4114:            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>
                   4115:            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   4116:            The same methods to replace variables can be used as for
                   4117:            the <code class="filename">INSTALL</code> file.</p></dd>
                   4118: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4119: <dd>
                   4120: <p>This file is displayed after installation of the package.
1.312     gdt      4121:            While this was used often in the past, it has two
                   4122:            problems: the display will be missed if many packages are
1.375     jkoshy   4123:            installed at once, and the person installing the package
1.312     gdt      4124:            and the one using or configuring it may be different.  It
                   4125:            should therefore be used only in exceptional circumstances
                   4126:            where lasting negative consequences would result from
                   4127:            someone not reading it.</p>
                   4128: <p>MESSAGE should not be used for:</p>
                   4129: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4130: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   4131: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   4132: <li class="listitem"><p>anything that should be explained in the
                   4133:              installation/configuration documentation that should
                   4134:              come with the package</p></li>
                   4135: </ul></div>
                   4136: <p>If the documentation provided by upstream needs
1.313     leot     4137:            enhancing, create e.g. files/README.pkgsrc and install it
                   4138:            in the package's documentation directory.
1.312     gdt      4139:            </p>
                   4140: <p>Note that MESSAGE is shown for all operating
                   4141:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     4142:            it should be narrowed to only those operating systems and
1.312     gdt      4143:            init systems to which it applies.</p>
                   4144: <p>Note that you can modify variables in it easily by using
1.299     rillig   4145:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4146:            <code class="filename">Makefile</code>:</p>
1.91      rillig   4147: <pre class="programlisting">
1.299     rillig   4148: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   4149: </pre>
1.385     leot     4150: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.299     rillig   4151:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4152:            performed for <code class="varname">PKGNAME</code>,
                   4153:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4154:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4155:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4156:            <code class="varname">ROOT_GROUP</code>, and
                   4157:            <code class="varname">ROOT_USER</code>.</p>
                   4158: <p>You can display a different or additional files by
                   4159:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4160:            default is <code class="filename">MESSAGE</code>, if the file
                   4161:            exists.</p>
                   4162: </dd>
                   4163: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4164: <dd>
                   4165: <p>This file is used by the alternatives framework.
                   4166:            It creates, configures, and destroys generic wrappers used to
                   4167:            run programs with similar interfaces.
                   4168:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4169:             for more information.</p>
                   4170: <p>Each line of the file contains two filenames, first
                   4171:            the wrapper and then the alternative provided by the package.
                   4172:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4173: </dd>
                   4174: </dl></div>
                   4175: </div>
                   4176: <div class="sect2">
                   4177: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4178: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
1.299     rillig   4179: <div class="variablelist"><dl class="variablelist">
                   4180: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4181: <dd><p>This file contains arbitrary things that could
                   4182:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4183:        to be used by more than one package. This file should only be
                   4184:        used when the packages that will use the file are known in
                   4185:        advance. For other purposes it is often better to write a
                   4186:        <code class="filename">*.mk</code> file and give it a good name that
                   4187:        describes what it does.</p></dd>
                   4188: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4189: <dd><p>This file contains the dependency information
1.385     leot     4190:        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   4191: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4192: <dd><p>This file contains workarounds for compiler bugs
                   4193:        and similar things. It is included automatically by the pkgsrc
                   4194:        infrastructure, so you don't need an extra
                   4195:        <code class="literal">.include</code> line for
                   4196:        it.</p></dd>
                   4197: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4198: <dd><p>This file contains the code for the
1.385     leot     4199:        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   4200:        selected by the user. If a package has only one or two options,
                   4201:        it is equally acceptable to put the code directly into the
                   4202:        <code class="filename">Makefile</code>.</p></dd>
                   4203: </dl></div>
                   4204: </div>
                   4205: <div class="sect2">
                   4206: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4207: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
1.299     rillig   4208: <div class="variablelist"><dl class="variablelist">
                   4209: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4210: <dd><p>These files do not take place in the creation of
                   4211:        a package and thus are purely informative to the package
                   4212:        developer.</p></dd>
                   4213: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4214: <dd><p>This file contains things that need to be done
                   4215:        to make the package even
                   4216:        better.</p></dd>
                   4217: </dl></div>
                   4218: </div>
                   4219: </div>
                   4220: <div class="sect1">
                   4221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4222: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
1.299     rillig   4223: </h2></div></div></div>
                   4224: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   4225:     unpacked into the directory denoted by
                   4226:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4227:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   4228:     directory is also used to keep various timestamp files.
                   4229:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4230:     The default is <code class="filename">${.CURDIR}/work</code>
                   4231:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4232:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   4233: </div>
1.299     rillig   4234: <div class="sect1">
                   4235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4236: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
1.299     rillig   4237: </h2></div></div></div>
                   4238: <p>If you have any files that you wish to be placed in the package
                   4239:     prior to configuration or building, you can place these files here
                   4240:     and use a <span class="command"><strong>${CP}</strong></span> command in the
1.385     leot     4241:     <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.299     rillig   4242: <p>If you want to share files in this way with other
                   4243:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4244:     to the other package's <code class="filename">files</code> directory,
                   4245:     e.g.:</p>
1.91      rillig   4246: <pre class="programlisting">
1.299     rillig   4247: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4248: </pre>
                   4249: </div>
                   4250: </div>
1.148     asau     4251: <div class="chapter">
1.75      rillig   4252: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     4253: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4254: <div class="toc">
                   4255: <p><b>Table of Contents</b></p>
1.210     leot     4256: <dl class="toc">
1.299     rillig   4257: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4258: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4259: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4260: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4261: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4262: <dd><dl>
                   4263: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4264: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4265: </dl></dd>
                   4266: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4267: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4268: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4269: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4270: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4271: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4272: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4273: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4274: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4275: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4276: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4277: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4278: </dl>
                   4279: </div>
1.148     asau     4280: <div class="sect1">
1.75      rillig   4281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4282: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
1.299     rillig   4283: <p>This chapter gives a detailed description on how a package is
                   4284:     built. Building a package is separated into different
                   4285:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4286:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4287:     described in the following sections. Each phase is split into
                   4288:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4289:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4290:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4291:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4292:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4293: <p>Never override the regular targets (like
                   4294:     <code class="varname">fetch</code>), if you have to, override the
                   4295:     <code class="varname">do-*</code> ones instead.</p>
                   4296: <p>The basic steps for building a program are always the same.  First
                   4297:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4298:     the local system and then extracted. After any pkgsrc-specific patches
                   4299:     to compile properly are applied, the software can be configured, then
                   4300:     built (usually by compiling), and finally the generated binaries, etc.
                   4301:     can be put into place on the system.</p>
                   4302: <p>To get more details about what is happening at each step,
                   4303:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4304:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4305:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4306: </div>
                   4307: <div class="sect1">
                   4308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4309: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
1.299     rillig   4310: <p>Before outlining the process performed by the NetBSD package system in
                   4311:     the next section, here's a brief discussion on where programs are
                   4312:     installed, and which variables influence this.</p>
                   4313: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4314:     where all files of the final program shall be installed. It is
                   4315:     usually set to <code class="varname">LOCALBASE</code>
                   4316:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4317:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4318:     <code class="varname">PREFIX</code> needs to be put
                   4319:     into the various places in the program's source where paths to
1.385     leot     4320:     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   4321: <p>When choosing which of these variables to use,
                   4322:     follow the following rules:</p>
1.148     asau     4323: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4324: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4325:        where the current pkg will be installed.  When referring to a
                   4326:        pkg's own installation path, use
1.385     leot     4327:        <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.338     nia      4328: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299     rillig   4329:        are installed.  If you need to construct a -I or -L argument
                   4330:        to the compiler to find includes and libraries installed by
1.385     leot     4331:        another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.299     rillig   4332:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4333:        installed all packages in <code class="filename">/usr/local</code>. As
                   4334:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4335:        administrator, this variable is a misnomer.</p></li>
                   4336: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4337:        distribution (from xsrc, etc.) is installed. When looking for
                   4338:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.385     leot     4339:        installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.299     rillig   4340: <li class="listitem"><p>X11-based packages using imake must set
                   4341:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4342:        <code class="varname">LOCALBASE</code>.</p></li>
                   4343: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.378     leot     4344:        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   4345:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4346:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4347: </ul></div>
                   4348: </div>
                   4349: <div class="sect1">
                   4350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4351: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
1.299     rillig   4352: <p>When building a package, various directories are used to store
                   4353:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4354:     directories are explained here.</p>
                   4355: <p>Some of the directory variables contain relative pathnames. There
                   4356:     are two common base directories for these relative directories:
                   4357:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4358:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4359:     inside the package itself.</p>
                   4360: <div class="variablelist"><dl class="variablelist">
                   4361: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4362: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4363:       root directory. Generally, you don't need
                   4364:       it.</p></dd>
                   4365: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4366: <dd><p>This is an absolute pathname that points to the
                   4367:       current package.</p></dd>
                   4368: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343     gutterid 4369: <dd>
                   4370: <p>This is a pathname relative to
                   4371:       <code class="varname">PKGSRCDIR</code> that points to the current package.
                   4372:       It is defined after including <code class="filename">bsd.prefs.mk</code>
                   4373:       and can be used in makefile fragments that are used by several
                   4374:       packages to distinguish between these packages. Other variables
                   4375:       that would serve the same purpose are <code class="varname">PKGBASE</code>
                   4376:       and <code class="varname">PKGNAME</code>, but these are only defined after
                   4377:       including <code class="filename">bsd.pkg.mk</code>, which is too
                   4378:       late.</p>
                   4379: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
                   4380:       <code class="varname">PKGPATH</code> to tweak variables like
                   4381:       <code class="varname">MAKE_JOBS</code> and
                   4382:       <code class="varname">CFLAGS</code>.</p>
                   4383: </dd>
1.299     rillig   4384: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4385: <dd><p>This is an absolute pathname pointing to the directory
                   4386:       where all work takes place. The distfiles are extracted to this
                   4387:       directory. It also contains temporary directories and log files used by
                   4388:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4389:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4390: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4391: <dd><p>This is an absolute pathname pointing to the directory
                   4392:       where the distfiles are extracted. It is usually a direct subdirectory
                   4393:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4394:       that isn't hidden. This variable may be changed by a package
                   4395:       <code class="filename">Makefile</code>.</p></dd>
                   4396: </dl></div>
                   4397: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4398:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4399:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4400:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4401:     If users would like to have their pkgsrc trees behave in a
                   4402:     read-only manner, then the value of
                   4403:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4404:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4405: </div>
1.148     asau     4406: <div class="sect1">
1.75      rillig   4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4408: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
1.299     rillig   4409: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343     gutterid 4410:     <em class="replaceable"><code>phase</code></em></strong></span>, where
                   4411:     <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
                   4412:     automatically run all phases that are required for this phase. The
                   4413:     default phase is <code class="varname">build</code>, that is, when you run
                   4414:     <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299     rillig   4415:     the package will be built, but not installed.</p>
1.75      rillig   4416: </div>
1.148     asau     4417: <div class="sect1">
1.75      rillig   4418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4419: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.299     rillig   4420: <p>The first step in building a package is to fetch the
                   4421:     distribution files (distfiles) from the sites that are providing
                   4422:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4423:     phase.</p>
1.148     asau     4424: <div class="sect2">
1.93      rillig   4425: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4426: <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   4427: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4428:       defines all URLs from where the distfile, whose name is
                   4429:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4430:       fetched. The more complicated cases are described
                   4431:       below.</p>
                   4432: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4433:       the list of distfiles that have to be fetched. Its value
                   4434:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4435:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4436:       so that most packages don't need to define it at all.
                   4437:       <code class="varname">EXTRACT_SUFX</code> is
                   4438:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4439:       freely. Note that if your package requires additional
                   4440:       distfiles to the default one, you cannot just append the
                   4441:       additional filenames using the <code class="literal">+=</code>
                   4442:       operator, but you have write for example:</p>
                   4443: <pre class="programlisting">
                   4444: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4445: </pre>
                   4446: <p>Each distfile is fetched from a list of sites, usually
                   4447:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4448:       <code class="varname">DISTFILES</code> or multiple
                   4449:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4450:       set
                   4451:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4452:       to the list of URLs where the file
                   4453:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4454:       (including the suffix) can be found.</p>
                   4455: <pre class="programlisting">
                   4456: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4457: DISTFILES+=     foo-file.tar.gz
                   4458: SITES.foo-file.tar.gz= \
                   4459: https://www.somewhere.com/somehow/ \
                   4460: https://www.somewhereelse.com/mirror/somehow/
                   4461: </pre>
                   4462: <p>When actually fetching the distfiles, each item from
                   4463:       <code class="varname">MASTER_SITES</code> or
                   4464:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4465:       appended to it, without an intermediate slash. Therefore,
                   4466:       all site values have to end with a slash or other separator
                   4467:       character. This allows for example to set
                   4468:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4469:       that gets the name of the distfile as a parameter. In this
                   4470:       case, the definition would look like:</p>
                   4471: <pre class="programlisting">
                   4472: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4473: </pre>
                   4474: <p> The exception to this rule are URLs starting with a dash.
                   4475:       In that case the URL is taken as is, fetched and the result
                   4476:       stored under the name of the distfile. You can use this style
                   4477:       for the case when the download URL style does not match the
                   4478:       above common case. For example, if permanent download URL is a
                   4479:       redirector to the real download URL, or the download file name
                   4480:       is offered by an HTTP Content-Disposition header. In the
                   4481:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4482:       created instead of the default
                   4483:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4484: <pre class="programlisting">
                   4485: DISTNAME=       foo-1.0.0
                   4486: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4487: </pre>
                   4488: <p>There are some predefined values for
                   4489:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4490:       packages.  The names of the variables should speak for
                   4491:       themselves.</p>
                   4492: <table border="0" summary="Simple list" class="simplelist">
                   4493: <tr>
                   4494: <td>MASTER_SITE_APACHE</td>
                   4495: <td>MASTER_SITE_BACKUP</td>
                   4496: </tr>
                   4497: <tr>
1.396   ! wiz      4498: <td>MASTER_SITE_CODEBERG</td>
1.299     rillig   4499: <td>MASTER_SITE_CRATESIO</td>
1.396   ! wiz      4500: </tr>
        !          4501: <tr>
1.299     rillig   4502: <td>MASTER_SITE_CYGWIN</td>
1.396   ! wiz      4503: <td>MASTER_SITE_DEBIAN</td>
1.299     rillig   4504: </tr>
                   4505: <tr>
                   4506: <td>MASTER_SITE_FREEBSD</td>
1.396   ! wiz      4507: <td>MASTER_SITE_FREEBSD_LOCAL</td>
1.299     rillig   4508: </tr>
                   4509: <tr>
                   4510: <td>MASTER_SITE_GENTOO</td>
1.396   ! wiz      4511: <td>MASTER_SITE_GITHUB</td>
1.299     rillig   4512: </tr>
                   4513: <tr>
1.340     gutterid 4514: <td>MASTER_SITE_GITLAB</td>
1.396   ! wiz      4515: <td>MASTER_SITE_GNOME</td>
1.340     gutterid 4516: </tr>
                   4517: <tr>
                   4518: <td>MASTER_SITE_GNU</td>
1.396   ! wiz      4519: <td>MASTER_SITE_GNUPG</td>
1.299     rillig   4520: </tr>
                   4521: <tr>
                   4522: <td>MASTER_SITE_GNUSTEP</td>
1.396   ! wiz      4523: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299     rillig   4524: </tr>
                   4525: <tr>
                   4526: <td>MASTER_SITE_IFARCHIVE</td>
1.396   ! wiz      4527: <td>MASTER_SITE_KDE</td>
1.299     rillig   4528: </tr>
                   4529: <tr>
                   4530: <td>MASTER_SITE_MOZILLA</td>
1.396   ! wiz      4531: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299     rillig   4532: </tr>
                   4533: <tr>
                   4534: <td>MASTER_SITE_MYSQL</td>
1.396   ! wiz      4535: <td>MASTER_SITE_NETLIB</td>
1.299     rillig   4536: </tr>
                   4537: <tr>
                   4538: <td>MASTER_SITE_OPENBSD</td>
1.396   ! wiz      4539: <td>MASTER_SITE_OPENOFFICE</td>
1.299     rillig   4540: </tr>
                   4541: <tr>
                   4542: <td>MASTER_SITE_OSDN</td>
1.396   ! wiz      4543: <td>MASTER_SITE_PERL_CPAN</td>
1.299     rillig   4544: </tr>
                   4545: <tr>
                   4546: <td>MASTER_SITE_PGSQL</td>
1.396   ! wiz      4547: <td>MASTER_SITE_PYPI</td>
1.299     rillig   4548: </tr>
                   4549: <tr>
                   4550: <td>MASTER_SITE_RUBYGEMS</td>
1.396   ! wiz      4551: <td>MASTER_SITE_R_CRAN</td>
1.299     rillig   4552: </tr>
                   4553: <tr>
                   4554: <td>MASTER_SITE_SOURCEFORGE</td>
1.396   ! wiz      4555: <td>MASTER_SITE_SUNSITE</td>
1.299     rillig   4556: </tr>
1.85      jmmv     4557: <tr>
1.299     rillig   4558: <td>MASTER_SITE_SUSE</td>
1.396   ! wiz      4559: <td>MASTER_SITE_TEX_CTAN</td>
1.85      jmmv     4560: </tr>
                   4561: <tr>
1.299     rillig   4562: <td>MASTER_SITE_XCONTRIB</td>
1.396   ! wiz      4563: <td>MASTER_SITE_XEMACS</td>
1.85      jmmv     4564: </tr>
                   4565: <tr>
1.299     rillig   4566: <td>MASTER_SITE_XORG</td>
1.396   ! wiz      4567: <td> </td>
1.299     rillig   4568: </tr>
                   4569: </table>
                   4570: <p>Some explanations for the less self-explaining ones:
                   4571:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.369     wiz      4572:       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   4573:       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>
                   4574: <p>If you choose one of these predefined sites, you may
                   4575:       want to specify a subdirectory of that site. Since these
                   4576:       macros may expand to more than one actual site, you
                   4577:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4578:       specify a subdirectory:</p>
1.100     rillig   4579: <pre class="programlisting">
1.299     rillig   4580: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4581: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4582: </pre>
1.299     rillig   4583: <p>Note the trailing slash after the subdirectory
                   4584:       name.</p>
                   4585: </div>
                   4586: <div class="sect2">
                   4587: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     4588: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
1.299     rillig   4589: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4590:       all the distfiles exist in a local directory
                   4591:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4592:       user). If the files do not exist, they are fetched using
                   4593:       commands of the form</p>
1.100     rillig   4594: <pre class="programlisting">
1.299     rillig   4595: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4596: </pre>
                   4597: <p>where <code class="literal">${site}</code> varies through
                   4598:       several possibilities in turn: first,
                   4599:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4600:       sites specified in either <code class="varname">SITES.file</code> if
                   4601:       defined, else <code class="varname">MASTER_SITES</code> or
                   4602:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4603:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4604:       all except the first and the last can be optionally sorted
                   4605:       by the user, via setting either
                   4606:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4607:       <code class="varname">MASTER_SORT_AWK</code> or
                   4608:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4609: <p> The specific command and arguments used depend on the
                   4610:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4611:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4612: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4613:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4614:       distfiles, if they are freely distributable.  Packages setting
                   4615:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.385     leot     4616:       <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.299     rillig   4617:       mirrored.</p>
1.85      jmmv     4618: </div>
                   4619: </div>
1.299     rillig   4620: <div class="sect1">
                   4621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4622: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.299     rillig   4623: <p>After the distfile(s) are fetched, their checksum is
                   4624:     generated and compared with the checksums stored in the
                   4625:     distinfo file. If the checksums don't match, the build is
                   4626:     aborted. This is to ensure the same distfile is used for
                   4627:     building, and that the distfile wasn't changed, e.g. by some
                   4628:     malign force, deliberately changed distfiles on the master
                   4629:     distribution site or network lossage.</p>
1.75      rillig   4630: </div>
1.148     asau     4631: <div class="sect1">
1.75      rillig   4632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4633: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.299     rillig   4634: <p>When the distfiles are present on the local system, they
                   4635:     need to be extracted, as they usually come in the form of some
                   4636:     compressed archive format.</p>
                   4637: <p>By default, all <code class="varname">DISTFILES</code> are
                   4638:     extracted. If you only need some of them, you can set the
                   4639:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4640:     files.</p>
                   4641: <p>Extracting the files is usually done by a little
                   4642:     program, <code class="filename">mk/extract/extract</code>, which
                   4643:     already knows how to extract various archive formats, so most
                   4644:     likely you will not need to change anything here. But if you
                   4645:     need, the following variables may help you:</p>
1.148     asau     4646: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4647: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4648: <dd><p>Use these variables to override the default
                   4649:       options for an extract command, which are defined in
                   4650:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4651: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4652: <dd><p>This variable can be set to
                   4653:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4654:       (which is the default value), <code class="literal">pax</code>, or an
                   4655:       absolute pathname pointing to the command with which tar
                   4656:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4657:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4658: </dl></div>
1.299     rillig   4659: <p>If the <code class="filename">extract</code> program doesn't
                   4660:     serve your needs, you can also override the
                   4661:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4662:     command used for extracting the files. This command is
                   4663:     executed in the <code class="filename">${WRKSRC}</code>
                   4664:     directory. During execution of this command, the shell
                   4665:     variable <code class="varname">extract_file</code> holds the absolute
                   4666:     pathname of the file that is going to be extracted.</p>
                   4667: <p>And if that still does not suffice, you can override the
                   4668:     <code class="varname">do-extract</code> target in the package
                   4669:     Makefile.</p>
1.75      rillig   4670: </div>
1.148     asau     4671: <div class="sect1">
1.75      rillig   4672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4673: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.299     rillig   4674: <p>After extraction, all the patches named by the
                   4675:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4676:     subdirectory of the package as well as in
                   4677:     $LOCALPATCHES/$PKGPATH (e.g.
                   4678:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4679:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4680:     <code class="filename">.gz</code> are uncompressed before they are
                   4681:     applied, files ending in <code class="filename">.orig</code> or
                   4682:     <code class="filename">.rej</code> are ignored. Any special options to
1.378     leot     4683:     <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     4684:     <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     4685: <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   4686:     fail if the expected text from the patch context is not found in the
                   4687:     patched file. If that happens, fix the patch file by comparing it
                   4688:     with the actual text in the file to be patched.</p>
1.78      rillig   4689: </div>
1.148     asau     4690: <div class="sect1">
1.75      rillig   4691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4692: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4693: <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   4694:     </p>
1.75      rillig   4695: </div>
1.148     asau     4696: <div class="sect1">
1.75      rillig   4697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4698: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.299     rillig   4699: <p>This phase creates wrapper programs for the compilers and
                   4700:     linkers. The following variables can be used to tweak the
                   4701:     wrappers.</p>
                   4702: <div class="variablelist"><dl class="variablelist">
                   4703: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4704: <dd><p>The command used to print progress
                   4705:       messages. Does nothing by default. Set to
                   4706:       <code class="literal">${ECHO}</code> to see the progress
                   4707:       messages.</p></dd>
                   4708: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4709: <dd><p>This variable can be set to
                   4710:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4711:       depending on whether you want additional information in the
                   4712:       wrapper log file.</p></dd>
                   4713: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4714: <dd><p>This variable can be set to
                   4715:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4716:       on whether the wrapper should use its cache, which will
                   4717:       improve the speed. The default value is
                   4718:       <code class="literal">yes</code>, but is forced to
                   4719:       <code class="literal">no</code> if the platform does not support
                   4720:       it.</p></dd>
                   4721: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4722: <dd><p>A list of reordering commands. A reordering
                   4723:       command has the form
                   4724:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4725:       It ensures that that
                   4726:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4727:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4728:       </p></dd>
                   4729: </dl></div>
                   4730: </div>
                   4731: <div class="sect1">
                   4732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4733: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.299     rillig   4734: <p>Most pieces of software need information on the header
                   4735:     files, system calls, and library routines which are available
                   4736:     on the platform they run on. The process of determining this
                   4737:     information is known as configuration, and is usually
                   4738:     automated. In most cases, a script is supplied with the
                   4739:     distfiles, and its invocation results in generation of header
                   4740:     files, Makefiles, etc.</p>
                   4741: <p>If the package contains a configure script, this can be
                   4742:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.385     leot     4743:     <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.299     rillig   4744:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.385     leot     4745:     <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
1.301     rillig   4746: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4747:     equivalent of the following command is run. See
                   4748:     <code class="filename">mk/configure/configure.mk</code>, target
                   4749:     <code class="literal">do-configure-script</code> for the exact
                   4750:     definition.</p>
                   4751: <pre class="programlisting">
                   4752: .for dir in ${CONFIGURE_DIRS}
                   4753:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4754:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4755:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4756: .endfor
1.100     rillig   4757: </pre>
1.299     rillig   4758: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.385     leot     4759:     <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.299     rillig   4760:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4761:     configure script is run with the environment
                   4762:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4763:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4764:     <code class="varname">CONFIGURE_ENV</code>,
                   4765:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.385     leot     4766:     <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.299     rillig   4767:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4768:     package.</p>
                   4769: <p>If the program uses the Perl way of configuration (mainly Perl
                   4770:     modules, but not only), i.e. a file called
                   4771:     <code class="filename">Makefile.PL</code>, it should include
                   4772:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4773:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4774:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4775: <p>If the program uses an <code class="filename">Imakefile</code>
                   4776:     for configuration, the appropriate steps can be invoked by
                   4777:     setting <code class="varname">USE_IMAKE</code> to
1.385     leot     4778:     <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   4779:     You can add variables to xmkmf's environment by adding them to the
                   4780:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4781: <p>If the program uses <code class="filename">cmake</code>
                   4782:     for configuration, the appropriate steps can be invoked by
1.348     wiz      4783:     including <code class="filename">../../devel/cmake/build.mk</code>.
1.299     rillig   4784:     You can add variables to cmake's environment by adding them to the
                   4785:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.373     wiz      4786:     by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.348     wiz      4787:     If you want to add arguments only for particular stages, you can use the
                   4788:     <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
                   4789:     <code class="varname">CMAKE_BUILD_ARGS</code>, and
                   4790:     <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
                   4791:     You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
                   4792:     directories in which CMake should be run, relative to
1.385     leot     4793:     <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
1.348     wiz      4794:     </p>
1.374     wiz      4795: <p>Any package using the now-deprecated
                   4796:     <code class="varname">USE_CMAKE=yes</code> should be converted.
                   4797:     Essentially, replace with an include of
                   4798:     <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
                   4799:     directory and settings to use it, and check/fix settings that
                   4800:     intend to perform the build in a subdirectory.
                   4801:     </p>
1.299     rillig   4802: <p>If there is no configure step at all, set
1.385     leot     4803:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75      rillig   4804: </div>
1.148     asau     4805: <div class="sect1">
1.75      rillig   4806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4807: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4808: <p>For building a package, a rough equivalent of the following
                   4809:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4810:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4811: <pre class="programlisting">
1.301     rillig   4812: .for dir in ${BUILD_DIRS}
                   4813:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4814:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4815:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4816:                 -f ${MAKE_FILE} \
                   4817:                 ${BUILD_TARGET}
                   4818: .endfor
1.97      rillig   4819: </pre>
1.299     rillig   4820: <p><code class="varname">BUILD_DIRS</code> (default:
1.385     leot     4821:     <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.299     rillig   4822:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4823:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4824:     <code class="varname">MAKE_ENV</code> and arguments
                   4825:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4826:     <code class="varname">MAKE_ENV</code>,
                   4827:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4828:     <code class="varname">MAKE_FILE</code> and
                   4829:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4830:     package.</p>
                   4831: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.385     leot     4832:     <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
                   4833:     <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.299     rillig   4834:     default value of <code class="varname">MAKE_FILE</code> is
1.385     leot     4835:     <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
                   4836:     defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.299     rillig   4837: <p>If there is no build step at all, set
1.385     leot     4838:     <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97      rillig   4839: </div>
1.148     asau     4840: <div class="sect1">
1.97      rillig   4841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4842: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.391     wiz      4843: <p>The test phase is for running a program's self
                   4844:     tests. Dependencies that are only required for testing can be
                   4845:     specified using <code class="varname">TEST_DEPENDS</code>.</p>
                   4846: <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
                   4847:     <code class="varname">TEST_TARGET</code>. Often, the proper value is
                   4848:     <span class="quote">“<span class="quote">check</span>”</span> or <span class="quote">“<span class="quote">test</span>”</span>. If more elaborate
                   4849:     steps are needed, you can define a <code class="literal">do-test</code>
                   4850:     target.</p>
                   4851: <p>To run the tests, call <span class="quote">“<span class="quote">make test</span>”</span>.</p>
                   4852: <p>When building a package, the tests are not run
                   4853:     automatically, except if <code class="varname">PKGSRC_RUN_TEST</code> is set
                   4854:     to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75      rillig   4855: </div>
1.148     asau     4856: <div class="sect1">
1.75      rillig   4857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4858: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.299     rillig   4859: <p>Once the build stage has completed, the final step is to
                   4860:     install the software in public directories, so users can
                   4861:     access the programs and files.</p>
1.301     rillig   4862: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4863:     of the following code is executed; see
                   4864:     <code class="filename">mk/install/install.mk</code>, target
                   4865:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4866:     before and after this code, several consistency checks are run
                   4867:     against the files-to-be-installed, see
                   4868:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4869: <pre class="programlisting">
                   4870: .for dir in ${INSTALL_DIRS}
                   4871:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4872:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4873:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4874:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4875: .endfor
1.220     wiz      4876: </pre>
1.299     rillig   4877: <p>The variable's meanings are analogous to the ones in the
                   4878:     <span class="emphasis"><em>build</em></span> phase.
                   4879:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4880:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.385     leot     4881:     is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
                   4882:     <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.299     rillig   4883:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4884:     defined.</p>
                   4885: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4886:     variables are useful. They are all variations of the
1.378     leot     4887:     <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   4888:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4889:     install command. The specialized variants, together with their
                   4890:     intended use, are:</p>
                   4891: <div class="variablelist"><dl class="variablelist">
                   4892: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4893: <dd><p>directories that contain
                   4894:       binaries</p></dd>
                   4895: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4896: <dd><p>directories that contain
                   4897:       scripts</p></dd>
                   4898: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4899: <dd><p>directories that contain shared and static
                   4900:       libraries</p></dd>
                   4901: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4902: <dd><p>directories that contain data
                   4903:       files</p></dd>
                   4904: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4905: <dd><p>directories that contain man
                   4906:       pages</p></dd>
                   4907: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4908: <dd><p>directories that contain data files for games
                   4909:       </p></dd>
                   4910: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4911: <dd><p>binaries that can be stripped from debugging
                   4912:       symbols</p></dd>
                   4913: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4914: <dd><p>binaries that cannot be
                   4915:       stripped</p></dd>
                   4916: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4917: <dd><p>game
                   4918:       binaries</p></dd>
                   4919: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4920: <dd><p>shared and static
                   4921:       libraries</p></dd>
                   4922: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4923: <dd><p>data files</p></dd>
                   4924: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4925: <dd><p>data files for
                   4926:       games</p></dd>
                   4927: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4928: <dd><p>man pages</p></dd>
                   4929: </dl></div>
                   4930: <p>Some other variables are:</p>
                   4931: <div class="variablelist"><dl class="variablelist">
                   4932: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.378     leot     4933: <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   4934:       when installing binaries. Any debugging sections and symbols present in
                   4935:       binaries will be preserved.
                   4936:       </p></dd>
                   4937: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4938: <dd><p>A list of directories relative to
                   4939:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4940:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4941:       The package is supposed to create all needed directories itself
                   4942:       before installing files to it and list all other directories here.
                   4943:       </p></dd>
                   4944: </dl></div>
                   4945: <p>In the rare cases that a package shouldn't install anything,
1.385     leot     4946:     set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.299     rillig   4947:     mostly relevant for packages in the <code class="filename">regress</code>
                   4948:     category.</p>
1.75      rillig   4949: </div>
1.148     asau     4950: <div class="sect1">
1.75      rillig   4951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4952: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.299     rillig   4953: <p>Once the install stage has completed, a binary package of
                   4954:     the installed files can be built.  These binary packages can be
                   4955:     used for quick installation without previous compilation, e.g. by
                   4956:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4957:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4958: <p>By default, the binary packages are created in
                   4959:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4960:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4961:     one for each category in the <code class="varname">CATEGORIES</code>
                   4962:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4963:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4964: </div>
1.148     asau     4965: <div class="sect1">
1.75      rillig   4966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4967: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
1.299     rillig   4968: <p>Once you're finished with a package, you can clean the work
                   4969:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4970:     to clean the work directories of all dependencies too, use
                   4971:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4972: </div>
1.148     asau     4973: <div class="sect1">
1.75      rillig   4974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     4975: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4976: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4977: <dt><span class="term">pre/post-*</span></dt>
                   4978: <dd>
                   4979: <p>For any of the main targets described in the previous
                   4980:          section (configure, build, install, etc.), two auxiliary
                   4981:          targets exist with
1.385     leot     4982:          <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   4983:          prefix for the main target's name.  These targets are
                   4984:          invoked before and after the main target is called,
                   4985:          allowing extra configuration or installation steps be
                   4986:          performed from a package's Makefile, for example, which
                   4987:          a program's configure script or install target
                   4988:          omitted.</p>
                   4989: <p>About 5% of the pkgsrc packages define their custom
                   4990:          post-extract target, another 5% define pre-configure, and 10%
                   4991:          define post-install. The other pre/post-* targets are defined
                   4992:          even less often.</p>
                   4993: </dd>
                   4994: <dt><span class="term">do-*</span></dt>
1.75      rillig   4995: <dd>
1.299     rillig   4996: <p>Should one of the main targets do the wrong thing,
                   4997:          and should there be no variable to fix this, you can
                   4998:          redefine it with the do-* target.  (Note that redefining
                   4999:          the target itself instead of the do-* target is a bad
                   5000:          idea, as the pre-* and post-* targets won't be called
                   5001:          anymore, etc.)</p>
                   5002: <p>About 15% of the pkgsrc packages override the default
                   5003:          do-install, the other do-* targets are overridden even less
                   5004:          often.</p>
1.75      rillig   5005: </dd>
1.299     rillig   5006: <dt><span class="term">reinstall</span></dt>
1.75      rillig   5007: <dd>
1.299     rillig   5008: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   5009:          you noticed some file was not installed properly, you
                   5010:          can repeat the installation with this target, which will
1.385     leot     5011:          ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.299     rillig   5012: <p>This is the default value of
                   5013:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   5014:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   5015:          package</strong></span>, where the defaults are
1.385     leot     5016:          <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.299     rillig   5017:          respectively.</p>
1.75      rillig   5018: </dd>
1.299     rillig   5019: <dt><span class="term">deinstall</span></dt>
                   5020: <dd>
1.378     leot     5021: <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   5022:          current directory, effectively de-installing the
                   5023:          package. The following variables can be used to tune the
                   5024:          behaviour:</p>
                   5025: <div class="variablelist"><dl class="variablelist">
                   5026: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.378     leot     5027: <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   5028: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   5029: <dd><p>Remove all packages that require (depend on)
                   5030:                the given package.  This can be used to remove any
                   5031:                packages that may have been pulled in by a given
                   5032:                package, e.g. if <span class="command"><strong>make deinstall
                   5033:                DEINSTALLDEPENDS=1</strong></span> is done in
                   5034:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   5035:                likely to remove whole KDE. Works by adding
1.385     leot     5036:                <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   5037:                command line.</p></dd>
                   5038: </dl></div>
                   5039: </dd>
                   5040: <dt><span class="term">bin-install</span></dt>
                   5041: <dd><p>Install a binary package from local disk and via FTP
                   5042:          from a list of sites (see the
                   5043:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   5044:          <span class="command"><strong>make package</strong></span> if no binary package is
                   5045:          available anywhere.  The arguments given to
                   5046:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   5047:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   5048:          operation, etc.</p></dd>
                   5049: <dt><span class="term">install-clean</span></dt>
                   5050: <dd><p>This target removes the state files for the "install" and later
                   5051:          phases so that the "install" target may be re-invoked. This can be
                   5052:          used after editing the PLIST to install the package without
                   5053:          rebuilding it.</p></dd>
                   5054: <dt><span class="term">build-clean</span></dt>
                   5055: <dd><p>This target removes the state files for the "build" and later
                   5056:          phases so that the "build" target may be re-invoked.</p></dd>
                   5057: <dt><span class="term">update</span></dt>
                   5058: <dd>
                   5059: <p>This target causes the current package to be
                   5060:          updated to the latest version.  The package and all
                   5061:          depending packages first get de-installed, then current
                   5062:          versions of the corresponding packages get compiled and
                   5063:          installed.  This is similar to manually noting which
                   5064:          packages are currently installed, then performing a
                   5065:          series of <span class="command"><strong>make deinstall</strong></span> and
                   5066:          <span class="command"><strong>make install</strong></span> (or whatever
                   5067:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   5068:          packages.</p>
1.385     leot     5069: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.299     rillig   5070:          resume package updating in case a previous <span class="command"><strong>make
                   5071:          update</strong></span> was interrupted for some reason.
                   5072:          However, in this case, make sure you don't call
                   5073:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   5074:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   5075:          Otherwise, you lose the ability to automatically update
                   5076:          the current package along with the dependent packages
                   5077:          you have installed.</p>
                   5078: <p>Resuming an interrupted <span class="command"><strong>make
                   5079:          update</strong></span> will only work as long as the package
                   5080:          tree remains unchanged.  If the source code for one of
                   5081:          the packages to be updated has been changed, resuming
                   5082:          <span class="command"><strong>make update</strong></span> will most certainly
                   5083:          fail!</p>
                   5084: <p>The following variables can be used either on the
                   5085:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   5086:          alter the behaviour of <span class="command"><strong>make
                   5087:          update</strong></span>:</p>
                   5088: <div class="variablelist"><dl class="variablelist">
                   5089: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   5090: <dd><p>Install target to recursively use for the
                   5091:                updated package and the dependent packages.
                   5092:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.385     leot     5093:                set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.299     rillig   5094:                <span class="command"><strong>make update</strong></span>.  Other good
1.385     leot     5095:                targets are <span class="quote">“<span class="quote">package</span>”</span> or
                   5096:                <span class="quote">“<span class="quote">bin-install</span>”</span>.  Do not set this to
                   5097:                <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.299     rillig   5098:                endless loop!</p></dd>
                   5099: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   5100: <dd><p>Don't clean up after updating.  Useful if
                   5101:                you want to leave the work sources of the updated
                   5102:                packages around for inspection or other purposes.
                   5103:                Be sure you eventually clean up the source tree
1.385     leot     5104:                (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.299     rillig   5105:                or you may run into troubles with old source code
                   5106:                still lying around on your next
                   5107:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   5108:                update</strong></span>.</p></dd>
                   5109: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   5110: <dd><p>Deinstall each package before installing
                   5111:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   5112:                may be necessary if the
1.385     leot     5113:                <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.299     rillig   5114:                called after interrupting a running <span class="command"><strong>make
                   5115:                update</strong></span>.</p></dd>
                   5116: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   5117: <dd><p>Allows you to disable recursion and hardcode
                   5118:                the target for packages.  The default is
1.385     leot     5119:                <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.299     rillig   5120:                facilitating a recursive update of prerequisite
                   5121:                packages.  Only set
                   5122:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   5123:                disable recursive updates. Use
                   5124:                <code class="varname">UPDATE_TARGET</code> instead to just
                   5125:                set a specific target for each package to be
                   5126:                installed during <span class="command"><strong>make update</strong></span>
                   5127:                (see above).</p></dd>
                   5128: </dl></div>
                   5129: </dd>
                   5130: <dt><span class="term">clean-update</span></dt>
                   5131: <dd>
                   5132: <p>Clean the source tree for all packages that would
                   5133:          get updated if <span class="command"><strong>make update</strong></span> was called
                   5134:          from the current directory.  This target should not be
                   5135:          used if the current package (or any of its depending
                   5136:          packages) have already been de-installed (e.g., after
                   5137:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   5138:          some packages you intended to update. As a rule of
                   5139:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   5140:          the first time you run <span class="command"><strong>make update</strong></span>
                   5141:          and only if you have a dirty package tree (e.g., if you
                   5142:          used <code class="varname">NOCLEAN</code>).</p>
                   5143: <p>If you are unsure about whether your tree is
                   5144:          clean, you can either perform a <span class="command"><strong>make
                   5145:          clean</strong></span> at the top of the tree, or use the
                   5146:          following sequence of commands from the directory of the
                   5147:          package you want to update (<span class="emphasis"><em>before</em></span>
                   5148:          running <span class="command"><strong>make update</strong></span> for the first
                   5149:          time, otherwise you lose all the packages you wanted to
                   5150:          update!):</p>
                   5151: <pre class="screen">
                   5152: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   5153: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   5154: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   5155:          </pre>
                   5156: <p>The following variables can be used either on the
                   5157:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   5158:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   5159: <div class="variablelist"><dl class="variablelist">
                   5160: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   5161: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   5162:                reconstruct the list of directories to update for
                   5163:                this package.  Only use this if <span class="command"><strong>make
                   5164:                update</strong></span> successfully installed all
                   5165:                packages you wanted to update.  Normally, this is
                   5166:                done automatically on <span class="command"><strong>make
                   5167:                update</strong></span>, but may have been suppressed by
                   5168:                the <code class="varname">NOCLEAN</code> variable (see
                   5169:                above).</p></dd>
                   5170: </dl></div>
                   5171: </dd>
                   5172: <dt><span class="term">replace</span></dt>
                   5173: <dd>
                   5174: <p>Update the installation of the current package.  This
                   5175:          differs from update in that it does not replace dependent
1.322     leot     5176:          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   5177:          target to work.</p>
                   5178: <p><span class="emphasis"><em>Be careful when using this
                   5179:          target!</em></span> There are no guarantees that dependent
                   5180:          packages will still work, in particular they will most
                   5181:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   5182:          library package whose shared library major version changed
                   5183:          between your installed version and the new one.  For this
                   5184:          reason, this target is not officially supported and only
                   5185:          recommended for advanced users.</p>
                   5186: </dd>
                   5187: <dt><span class="term">info</span></dt>
1.378     leot     5188: <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   5189:          package. You can use this to check which version of a
                   5190:          package is installed.</p></dd>
                   5191: <dt><span class="term">index</span></dt>
                   5192: <dd>
                   5193: <p>This is a top-level command, i.e. it should be used in
                   5194:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   5195:          database of all packages in the local pkgsrc tree, including
                   5196:          dependencies, comment, maintainer, and some other useful
                   5197:          information.  Individual entries are created by running
                   5198:          <span class="command"><strong>make describe</strong></span> in the packages'
                   5199:          directories.  This index file is saved as
                   5200:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   5201:          verbose format by running <span class="command"><strong>make
                   5202:          print-index</strong></span>.  You can search in it with
                   5203:          <span class="command"><strong>make search
                   5204:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   5205:          extract a list of all packages that depend on a particular
                   5206:          one by running <span class="command"><strong>make show-deps
                   5207:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   5208: <p>Running this command takes a very long time, some
                   5209:          hours even on fast machines!</p>
                   5210: </dd>
                   5211: <dt><span class="term">readme</span></dt>
                   5212: <dd>
                   5213: <p>This target generates a
1.314     nia      5214:          <code class="filename">index.html</code> file, which can be
1.322     leot     5215:          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   5216:          contain references to any packages which are in the
                   5217:          <code class="varname">PACKAGES</code> directory on the local
                   5218:          host. The generated files can be made to refer to URLs
                   5219:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   5220:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      5221:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   5222:          files which pointed to binary packages on the local
                   5223:          machine, in the directory
                   5224:          <code class="filename">/usr/packages</code>, set
                   5225:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   5226:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   5227:          <code class="varname">${PACKAGES}</code> directory and its
                   5228:          subdirectories will be searched for all the binary
                   5229:          packages.</p>
                   5230: <p>The target can be run at the toplevel or in category
                   5231:          directories, in which case it descends recursively.</p>
                   5232: </dd>
                   5233: <dt><span class="term">readme-all</span></dt>
                   5234: <dd><p>This is a top-level command, run it in
                   5235:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   5236:          file <code class="filename">README-all.html</code> which contains a
                   5237:          list of all packages currently available in the NetBSD
                   5238:          Packages Collection, together with the category they belong
                   5239:          to and a short description. This file is compiled from the
1.314     nia      5240:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   5241:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   5242:          readme</strong></span>.</p></dd>
                   5243: <dt><span class="term">cdrom-readme</span></dt>
                   5244: <dd><p>This is very much the same as the
1.385     leot     5245:          <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.299     rillig   5246:          used when generating a pkgsrc tree to be written to a
                   5247:          CD-ROM.  This target also produces
1.314     nia      5248:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   5249:          to refer to URLs based on
                   5250:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   5251:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   5252: <dt><span class="term">show-distfiles</span></dt>
                   5253: <dd><p>This target shows which distfiles and patchfiles
                   5254:          are needed to build the package
                   5255:          (<code class="varname">ALLFILES</code>, which contains all
                   5256:          <code class="varname">DISTFILES</code> and
                   5257:          <code class="varname">PATCHFILES</code>, but not
                   5258:          <code class="filename">patches/*</code>).</p></dd>
                   5259: <dt><span class="term">show-downlevel</span></dt>
                   5260: <dd><p>This target shows nothing if the package is not
                   5261:          installed. If a version of this package is installed,
                   5262:          but is not the version provided in this version of
                   5263:          pkgsrc, then a warning message is displayed. This target
                   5264:          can be used to show which of your installed packages are
                   5265:          downlevel, and so the old versions can be deleted, and
                   5266:          the current ones added.</p></dd>
                   5267: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   5268: <dd><p>This target shows the directory in the pkgsrc
                   5269:          hierarchy from which the package can be built and
                   5270:          installed. This may not be the same directory as the one
                   5271:          from which the package was installed. This target is
                   5272:          intended to be used by people who may wish to upgrade
                   5273:          many packages on a single host, and can be invoked from
                   5274:          the top-level pkgsrc Makefile by using the
1.385     leot     5275:          <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.299     rillig   5276: <dt><span class="term">show-installed-depends</span></dt>
                   5277: <dd><p>This target shows which installed packages match
                   5278:          the current package's <code class="varname">DEPENDS</code>. Useful
                   5279:          if out of date dependencies are causing build
                   5280:          problems.</p></dd>
                   5281: <dt><span class="term">print-build-depends-list</span></dt>
                   5282: <dd><p>This target shows the list of packages that the current package
                   5283:            depends on for building.</p></dd>
                   5284: <dt><span class="term">print-run-depends-list</span></dt>
                   5285: <dd><p>This target shows the list of packages that the current package
                   5286:            depends on for running.</p></dd>
                   5287: <dt><span class="term">check-shlibs</span></dt>
                   5288: <dd><p>After a package is installed, check all its
                   5289:          binaries and (on ELF platforms) shared libraries to see
                   5290:          if they find the shared libs they need.  Run by default
                   5291:          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>
                   5292: <dt><span class="term">print-PLIST</span></dt>
                   5293: <dd>
1.385     leot     5294: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.299     rillig   5295:          upgraded pkg, this prints out an attempt to generate a
                   5296:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5297:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5298:          to care for shared libs etc., but it is
                   5299:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5300:          result before putting it into
                   5301:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5302:          diff the output of this command against an already
                   5303:          existing <code class="filename">PLIST</code> file.</p>
1.378     leot     5304: <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   5305:          other methods that don't update file access times, be
                   5306:          sure to add these files manually to your
1.385     leot     5307:          <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
                   5308:          -newer</span>”</span> command used by this target won't catch
1.299     rillig   5309:          them!</p>
1.385     leot     5310: <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   5311:          information on this target.</p>
                   5312: </dd>
1.371     cheusov  5313: <dt><span class="term">rebuild</span></dt>
                   5314: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
                   5315:          noticed some further modifications of sources are needed,
                   5316:          you can repeat the build with this target, which will ignore
1.385     leot     5317:          the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
1.371     cheusov  5318:          helpful while working with patches.</p></dd>
                   5319: <dt><span class="term">repackage</span></dt>
                   5320: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
                   5321:          noticed some further modifications of sources are needed,
                   5322:          you can repeat the package with this target, which will ignore
1.385     leot     5323:          the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
1.371     cheusov  5324:          helpful while working with patches, PLIST* files etc.</p></dd>
                   5325: <dt><span class="term">retest</span></dt>
                   5326: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
                   5327:          noticed some further modifications of sources are needed,
                   5328:          you can repeat the test with this target, which will ignore
1.385     leot     5329:          the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
1.371     cheusov  5330:          helpful while working with patches.</p></dd>
1.299     rillig   5331: </dl></div>
                   5332: </div>
                   5333: </div>
                   5334: <div class="chapter">
                   5335: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     5336: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.299     rillig   5337: <div class="toc">
                   5338: <p><b>Table of Contents</b></p>
                   5339: <dl class="toc">
                   5340: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5341: <dd><dl>
1.334     nia      5342: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
                   5343: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
                   5344: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299     rillig   5345: </dl></dd>
                   5346: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5347: <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>
                   5348: </dl>
                   5349: </div>
                   5350: <p>When you find a package that is not yet in pkgsrc, you
                   5351: most likely have a URL from where you can download the source
                   5352: code. Starting with this URL, creating a package involves only a
                   5353: few steps.</p>
                   5354: <div class="procedure"><ol class="procedure" type="1">
                   5355: <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
                   5356: enable the basic quality checks.</p></li>
                   5357: <li class="step">
1.322     leot     5358: <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   5359: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5360: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5361: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5362: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5363: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5364: </li>
                   5365: <li class="step">
                   5366: <p>Choose one of the top-level directories as the category in
                   5367: which you want to place your package. You can also create a directory of
1.334     nia      5368: your own (maybe called <code class="filename">local</code>). Change into that
                   5369: category directory:</p>
                   5370: <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   5371: </li>
                   5372: <li class="step">
1.334     nia      5373: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
                   5374: argument the URL of the distribution file (in most cases a
                   5375: <code class="filename">.tar.gz</code> file). This will download the distribution
                   5376: file and create the necessary files of the package, based on what's in
                   5377: the distribution file:</p>
1.299     rillig   5378: <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>
                   5379: </li>
                   5380: <li class="step">
                   5381: <p>Examine the extracted files to determine the dependencies of
                   5382: your package. Ideally, this is mentioned in some
                   5383: <code class="filename">README</code> file, but things may differ. For each of
                   5384: these dependencies, look where it exists in pkgsrc, and if there is a
                   5385: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5386: line to your package <code class="filename">Makefile</code> which includes that
                   5387: file just before the last line. If the
                   5388: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5389: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5390: that the package's include files and libraries are provided.</p>
1.334     nia      5391: <p>If you just need binaries from a dependent package, add a
1.299     rillig   5392: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5393: version of the dependency and where it can be found in pkgsrc. This line
                   5394: should be placed in the third paragraph. If the dependency is only
                   5395: needed for building the package, but not when using it, use
                   5396: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5397: instead of <code class="varname">DEPENDS</code>.
                   5398: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5399: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5400: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334     nia      5401: packages, i.e. packages for the platform where the package is built;
1.299     rillig   5402: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334     nia      5403: packages, i.e. packages for the platform for which the package
                   5404: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
                   5405: specifies a dependency used only for testing the resulting package
                   5406: built, using the upstream project's included test suite, on the native
                   5407: platform.
1.299     rillig   5408: Your package may then look like this:</p>
                   5409: <pre class="programlisting">
                   5410: [...]
                   5411: 
                   5412: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5413: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5414: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5415: 
                   5416: [...]
                   5417: 
                   5418: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5419: .include "../../devel/glib2/buildlink3.mk"
                   5420: .include "../../mk/bsd.pkg.mk"
                   5421: </pre>
                   5422: </li>
                   5423: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.385     leot     5424: 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   5425: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5426: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5427: additional explanations.</p></li>
                   5428: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.385     leot     5429: 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   5430: over there, you can hopefully continue here.</p></li>
                   5431: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5432: directory from the extracted files. Besides these files, a lot of cache
1.334     nia      5433: files and other system information have been saved in the working
                   5434: directory, which may have become outdated after you edited the
1.299     rillig   5435: <code class="filename">Makefile</code>.</p></li>
                   5436: <li class="step">
                   5437: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.385     leot     5438: 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      5439: <p>If the extracted files from the package need to be fixed, run
                   5440: multiple rounds of these commands:</p>
                   5441: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299     rillig   5442: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5443: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334     nia      5444: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
                   5445: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299     rillig   5446: </li>
                   5447: <li class="step"><p>When the package builds fine, the next step is to install
                   5448: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5449: everything works.</p></li>
                   5450: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5451: contains a list of the files that are installed by the package, is
                   5452: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5453: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5454: the file using your preferred text editor to see if the list of
                   5455: files looks plausible.</p></li>
                   5456: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5457: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5458: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5459: had been registered in the database of installed files, but with an
                   5460: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5461: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5462: registered with the list of files from
                   5463: <code class="filename">PLIST</code>.</p></li>
                   5464: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5465: from above again in a single step, making sure that the PLIST is correct
                   5466: and the whole package is created as intended.</p></li>
1.334     nia      5467: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
                   5468: left to do.</p></li>
1.385     leot     5469: <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   5470: </ol></div>
                   5471: <div class="sect1">
                   5472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5473: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
1.299     rillig   5474: <div class="sect2">
                   5475: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5476: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299     rillig   5477: <p>Python modules and programs packages are easily created using a
                   5478: set of predefined variables.</p>
                   5479: <p>
                   5480: If some Python versions are not supported by the software, set the
                   5481: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5482: that are not supported, e.g.
                   5483: </p>
                   5484: <pre class="programlisting">
                   5485: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5486: </pre>
                   5487: <p>
1.363     gutterid 5488: If the packaged software is a Python module, include
1.372     wiz      5489: <code class="filename">../../lang/python/wheel.mk</code>.  Note per PEP-518,
1.376     wiz      5490: 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
                   5491: other possible tools that projects can use. Thus inclusion of
1.372     wiz      5492: <code class="filename">wheel.mk</code> does not imply these defaults are
                   5493: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
                   5494: specifically requires as packaging tools must be defined in the
                   5495: package Makefile.
1.330     wiz      5496: </p>
1.362     wiz      5497: <p>The package directory should be called
1.385     leot     5498: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
                   5499: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.299     rillig   5500: </p>
                   5501: <pre class="programlisting">
                   5502: DISTNAME=   foopymodule-1.2.10
                   5503: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5504: </pre>
1.341     gutterid 5505: <p>
                   5506: For software in PyPi, the name should match what PyPi specifies for
                   5507: "pip install software".
                   5508: </p>
1.299     rillig   5509: <p>If it is an application, include
1.385     leot     5510: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
1.299     rillig   5511: In order to correctly set the path to the Python interpreter, use the
                   5512: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5513: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5514: For example:
                   5515: </p>
                   5516: <pre class="programlisting">
                   5517: REPLACE_PYTHON=   *.py
                   5518: </pre>
                   5519: </div>
                   5520: <div class="sect2">
                   5521: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5522: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299     rillig   5523: <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>
                   5524: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322     leot     5525: 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   5526: Individual packages (and optionally their dependencies) may be created
                   5527: and updated.  R packages generally follow the same form, and most of
                   5528: the relevant information needed is contained in a
                   5529: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5530: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5531: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5532: creates or updates a package in the canonical form.  The resulting
                   5533: package should be reviewed for correctness.</p>
                   5534: </div>
                   5535: <div class="sect2">
                   5536: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5537: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299     rillig   5538: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322     leot     5539: <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   5540: <p>If the TeXlive package name is not known, it may be useful to
                   5541: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
1.385     leot     5542: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
1.299     rillig   5543: 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
                   5544: archive</a>.</p>
                   5545: <p>If the TeXlive package name is known, download the files from
                   5546: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5547: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5548: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5549: also have associated documentation packages, so download
                   5550: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5551: should be placed in the appropriate category directory, which is often
                   5552: but not always <code class="filename">print</code>.  Then run the following
                   5553: command in the category directory.</p>
                   5554: <pre class="programlisting">
                   5555: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5556: </pre>
                   5557: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5558: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5559: are correct.</p>
                   5560: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5561: currently does not include version information in package filenames
                   5562: and changes their contents periodically when updates occur.
                   5563: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5564: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5565: main one and the corresponding documentation, upload the distfiles
                   5566: with the following command in each package directory.</p>
                   5567: <pre class="programlisting">
                   5568: make upload-distfiles
                   5569: </pre>
                   5570: </div>
                   5571: </div>
                   5572: <div class="sect1">
                   5573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5574: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
1.299     rillig   5575: <div class="sect2">
                   5576: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5577: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.299     rillig   5578: <div class="sect3">
                   5579: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5580: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
1.299     rillig   5581: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.385     leot     5582: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.299     rillig   5583: pkgsrc. As the description says it has to do with the web, the obvious
1.385     leot     5584: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.299     rillig   5585: <pre class="programlisting">
                   5586: <code class="prompt">$</code> mkdir www/nvu
                   5587: <code class="prompt">$</code> cd www/nvu
                   5588: </pre>
                   5589: <p>The web site says that the sources are available as a tar file, so
                   5590: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5591: <pre class="programlisting">
                   5592: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5593: </pre>
                   5594: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5595: below the <code class="varname">DISTNAME</code> line, as the package name should
1.385     leot     5596: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.299     rillig   5597: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5598: <code class="varname">COMMENT</code> fields. Then the package
                   5599: <code class="filename">Makefile</code> looked like that:</p>
                   5600: <pre class="programlisting">
                   5601: # $NetBSD $
                   5602: #
                   5603: 
                   5604: DISTNAME=       nvu-1.0-sources
                   5605: PKGNAME=        nvu-1.0
                   5606: CATEGORIES=     www
                   5607: MASTER_SITES=   http://cvs.nvu.com/download/
                   5608: EXTRACT_SUFX=   .tar.bz2
                   5609: 
                   5610: MAINTAINER=     rillig@NetBSD.org
                   5611: HOMEPAGE=       http://cvs.nvu.com/
                   5612: COMMENT=        Web Authoring System
                   5613: 
                   5614: # url2pkg-marker (please do not remove this line.)
                   5615: .include "../../mk/bsd.pkg.mk"
                   5616: </pre>
                   5617: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5618: this is a workaround to prevent CVS expanding to the filename of the
                   5619: guide.</p>
                   5620: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5621: source archive:</p>
                   5622: <pre class="programlisting">
                   5623: url2pkg&gt; Running "make makesum" ...
                   5624: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5625: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5626: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5627: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5628: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5629: url2pkg&gt; Running "make extract" ...
                   5630: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5631: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5632: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5633: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5634: ===&gt; Installing dependencies for nvu-1.0
                   5635: ===&gt; Overriding tools for nvu-1.0
                   5636: ===&gt; Extracting for nvu-1.0
                   5637: url2pkg&gt; Adjusting the Makefile.
                   5638: 
                   5639: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5640: 
                   5641: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5642: </pre>
                   5643: </div>
                   5644: <div class="sect3">
                   5645: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5646: <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   5647: <p>Now that the package has been extracted, let's see what's inside
                   5648: it. The package has a <code class="filename">README.txt</code>, but that only
                   5649: says something about mozilla, so it's probably useless for seeing what
                   5650: dependencies this package has. But since there is a GNU configure script
                   5651: in the package, let's hope that it will complain about everything it
                   5652: needs.</p>
                   5653: <pre class="programlisting">
                   5654: <code class="prompt">$</code> bmake
                   5655: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5656: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5657: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5658: ===&gt; Patching for nvu-1.0
                   5659: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5660: ===&gt; Configuring for nvu-1.0
                   5661: [...]
                   5662: configure: error: Perl 5.004 or higher is required.
                   5663: [...]
                   5664: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5665: [...]
                   5666: </pre>
                   5667: <p>That worked quite well. So I opened the package Makefile in my
                   5668: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.385     leot     5669: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.299     rillig   5670: package have changed now, and since a perl wrapper is automatically
1.385     leot     5671: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.299     rillig   5672: from scratch.</p>
                   5673: <pre class="programlisting">
                   5674: <code class="prompt">$</code> bmake clean
                   5675: ===&gt; Cleaning for nvu-1.0
                   5676: <code class="prompt">$</code> bmake
                   5677: [...]
                   5678: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5679: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5680: [...]
                   5681: </pre>
1.385     leot     5682: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.299     rillig   5683: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5684: <pre class="programlisting">
                   5685: [...]
                   5686: checking for GTK - version &gt;= 1.2.0... no
                   5687: *** Could not run GTK test program, checking why...
                   5688: [...]
                   5689: </pre>
                   5690: <p>Now to the other dependencies. The first question is: Where is the
                   5691: GTK package hidden in pkgsrc?</p>
                   5692: <pre class="programlisting">
                   5693: <code class="prompt">$</code> echo ../../*/gtk*
                   5694: [many packages ...]
                   5695: <code class="prompt">$</code> echo ../../*/gtk
                   5696: ../../x11/gtk
                   5697: <code class="prompt">$</code> echo ../../*/gtk2
                   5698: ../../x11/gtk2
                   5699: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5700: ../../x11/gtk2/buildlink3.mk
                   5701: </pre>
                   5702: <p>The first try was definitely too broad. The second one had exactly
                   5703: one result, which is very good. But there is one pitfall with GNOME
                   5704: packages. Before GNOME 2 had been released, there were already many
                   5705: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5706: packages, the GNOME 2 packages were imported as separate packages, and
1.385     leot     5707: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.299     rillig   5708: whether this was the case here, and indeed it was.</p>
                   5709: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5710: file, adding the dependency is very easy. I just inserted an
                   5711: <code class="literal">.include</code> line before the last line of the package
                   5712: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5713: <pre class="programlisting">
                   5714: [...]
                   5715: .include "../../x11/gtk2/buildlink3.mk"
                   5716: .include "../../mk/bsd.pkg.mk
                   5717: </pre>
                   5718: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5719: was:</p>
1.75      rillig   5720: <pre class="programlisting">
1.299     rillig   5721: [...]
                   5722: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5723: checking for GTK - version &gt;= 1.2.0... no
                   5724: *** Could not run GTK test program, checking why...
                   5725: *** The test program failed to compile or link. See the file config.log for the
                   5726: *** exact error that occured. This usually means GTK was incorrectly installed
                   5727: *** or that you have moved GTK since it was installed. In the latter case, you
                   5728: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5729: configure: error: Test for GTK failed.
                   5730: [...]
1.222     sevan    5731: </pre>
1.385     leot     5732: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
                   5733: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.299     rillig   5734: told me that this package really wanted to have the GNOME 1 version of
                   5735: GTK. If the package had looked for GTK2, it would have looked for
                   5736: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5737: So I changed the <code class="literal">x11/gtk2</code> to
                   5738: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5739: and tried again.</p>
1.119     mishka   5740: <pre class="programlisting">
1.299     rillig   5741: [...]
                   5742: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5743: In file included from xpidl.c:42:
                   5744: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5745: In file included from xpidl.c:42:
                   5746: xpidl.h:132: error: parse error before "IDL_ns"
                   5747: [...]
1.222     sevan    5748: </pre>
1.299     rillig   5749: <p>The package still does not find all of its dependencies. Now the
                   5750: question is: Which package provides the
                   5751: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5752: <pre class="programlisting">
1.299     rillig   5753: <code class="prompt">$</code> echo ../../*/*idl*
                   5754: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5755: <code class="prompt">$</code> echo ../../*/*IDL*
                   5756: ../../net/libIDL
1.222     sevan    5757: </pre>
1.299     rillig   5758: <p>Let's take the one from the second try. So I included the
                   5759: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5760: again. But the error didn't change. After digging through some of the
                   5761: code, I concluded that the build process of the package was broken and
                   5762: couldn't have ever worked, but since the Mozilla source tree is quite
                   5763: large, I didn't want to fix it. So I added the following to the package
                   5764: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5765: <pre class="programlisting">
1.299     rillig   5766: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5767: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5768: </pre>
1.299     rillig   5769: <p>The latter line is needed because the package expects the library
                   5770: <code class="filename">libIDL.so</code>, but only
                   5771: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5772: wrapper to rewrite that on the fly.</p>
                   5773: <p>The next problem was related to a recent change of the FreeType
1.322     leot     5774: 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   5775: which patch files were relevant for this issue and copied them to the
                   5776: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5777: patches so that they applied cleanly and retried again. This time,
                   5778: everything worked.</p>
1.197     wiz      5779: </div>
1.299     rillig   5780: <div class="sect3">
                   5781: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     5782: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5783: <pre class="programlisting">
1.299     rillig   5784: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5785: [...]
                   5786: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5787: <code class="prompt">$</code> bmake deinstall
                   5788: <code class="prompt">$</code> bmake install
1.222     sevan    5789: </pre>
1.299     rillig   5790: </div>
                   5791: </div>
1.75      rillig   5792: </div>
                   5793: </div>
1.148     asau     5794: <div class="chapter">
1.75      rillig   5795: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     5796: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5797: <div class="toc">
                   5798: <p><b>Table of Contents</b></p>
1.210     leot     5799: <dl class="toc">
1.299     rillig   5800: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5801: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5802: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5803: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5804: <dd><dl>
                   5805: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5806: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5807: <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>
                   5808: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344     gutterid 5809: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75      rillig   5810: </dl></dd>
                   5811: </dl>
                   5812: </div>
1.299     rillig   5813: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5814:   each of which forms a well-defined part of the pkgsrc system. Using
1.378     leot     5815:   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   5816:   like pkgsrc requires some discipline to keep the code correct and
                   5817:   understandable.</p>
                   5818: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5819:   programming are variables and shell
                   5820:   commands. Among these shell commands may even be more complex ones
1.378     leot     5821:   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   5822:   as intended it is necessary to quote all variables correctly when they
                   5823:   are used.</p>
                   5824: <p>This chapter describes some patterns that appear quite often in
                   5825:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5826:   with them.</p>
1.148     asau     5827: <div class="sect1">
1.75      rillig   5828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5829: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
1.299     rillig   5830: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5831: <p>When you are creating a file as a
                   5832:     target of a rule, always write the data to a temporary file first
                   5833:     and finally rename that file. Otherwise there might occur an error
                   5834:     in the middle of generating the file, and when the user runs
1.378     leot     5835:     <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   5836:     regenerated properly. Example:</p>
1.75      rillig   5837: <pre class="programlisting">
1.299     rillig   5838: wrong:
                   5839:         @echo "line 1" &gt; ${.TARGET}
                   5840:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5841:         @false
                   5842: 
                   5843: correct:
                   5844:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5845:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5846:         @false
                   5847:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5848: </pre>
1.299     rillig   5849: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5850:     <code class="filename">wrong</code> will exist, although there was an error
                   5851:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5852:     correct</strong></span> gives an error message twice, as expected.</p>
1.378     leot     5853: <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   5854:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5855:     happens when it is interrupted, for example by pressing
                   5856:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.378     leot     5857:     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   5858: </li></ul></div>
                   5859: </div>
                   5860: <div class="sect1">
                   5861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5862: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.299     rillig   5863: <p><code class="filename">Makefile</code> variables contain strings that
                   5864:     can be processed using the five operators <code class="code">=</code>,
                   5865:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.378     leot     5866:     <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   5867:     page.</p>
                   5868: <p>When a variable's value is parsed from a
                   5869:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5870:     the backslash character <code class="code">\</code> are handled specially. If a
                   5871:     backslash is the last character in a line, that backslash is removed
                   5872:     from the line and the line continues with the next line of the file.</p>
                   5873: <p>The <code class="code">#</code> character starts a comment that reaches
                   5874:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5875:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5876: <p>The evaluation of variables either happens immediately or lazy.
                   5877:     It happens immediately when the variable occurs on the right-hand
                   5878:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5879:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5880:     In the other cases, it is evaluated lazily.</p>
                   5881: <p>Some of the modifiers split the string into words and then
                   5882:     operate on the words, others operate on the string as a whole. When a
                   5883:     string is split into words, double quotes and single quotes are
1.378     leot     5884:     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   5885: <div class="sect2">
                   5886: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5887: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
1.299     rillig   5888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5889: <li class="listitem"><p>All variable names starting with an underscore
                   5890:        are reserved for use by the pkgsrc infrastructure. They shall
                   5891:        not be used by packages.</p></li>
                   5892: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5893:        lowercase variable names for the iteration
                   5894:        variables.</p></li>
                   5895: <li class="listitem"><p>All list variables should have a plural name,
                   5896:        such as <code class="varname">PKG_OPTIONS</code> or
                   5897:        <code class="varname">DISTFILES</code>.</p></li>
                   5898: </ul></div>
                   5899: </div>
                   5900: </div>
                   5901: <div class="sect1">
                   5902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     5903: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
1.299     rillig   5904: <div class="sect2">
                   5905: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5906: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
1.299     rillig   5907: <p>When adding a string that possibly contains whitespace or quotes to
                   5908: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5909: modifier.</p>
                   5910: <p>When adding another list to a list (example 2), it must not be
                   5911: quoted, since its elements are already quoted.</p>
1.75      rillig   5912: <pre class="programlisting">
1.299     rillig   5913: STRING=         foo * bar `date`
                   5914: LIST=           # empty
                   5915: ANOTHER_LIST=   a=b c=d
                   5916: 
                   5917: LIST+=          ${STRING:Q}       # 1
                   5918: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5919: </pre>
1.299     rillig   5920: </div>
                   5921: <div class="sect2">
                   5922: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5923: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.299     rillig   5924: <p>Echoing a string containing special characters needs special
                   5925: work.</p>
1.75      rillig   5926: <pre class="programlisting">
1.299     rillig   5927: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5928: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5929: 
                   5930: all:
                   5931:         echo ${STRING}                  # 1
                   5932:         echo ${STRING:Q}                # 2
                   5933:         printf '%s\n' ${STRING:Q}''     # 3
                   5934:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5935: </pre>
1.299     rillig   5936: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5937: are just copied.</p>
                   5938: <p>Example 2 quotes the string so that the shell interprets it
                   5939: correctly. But the echo command may additionally interpret strings with a
                   5940: leading dash or those containing backslashes.</p>
1.378     leot     5941: <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   5942: interprets the format string, but not the next argument. The trailing
                   5943: single quotes handle the case when the string is empty. In that case, the
                   5944: :Q modifier would result in an empty string too, which would then be
1.378     leot     5945: 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   5946: but other programs may care.</p>
                   5947: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5948: need to be quoted because the quoting has already been done
                   5949: when adding elements to the list.</p>
1.75      rillig   5950: </div>
1.148     asau     5951: <div class="sect2">
1.75      rillig   5952: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5953: <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   5954: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5955: GNU-style configure script (especially those that call other configure
                   5956: scripts), it must not have leading or trailing whitespace, since
                   5957: otherwise the configure script gets confused. To trim leading and
                   5958: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5959: following example:</p>
1.75      rillig   5960: <pre class="programlisting">
1.299     rillig   5961: CPPFLAGS=               # empty
                   5962: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5963: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5964: 
1.299     rillig   5965: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5966: 
1.299     rillig   5967: all:
                   5968:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5969:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5970: </pre>
                   5971: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5972: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5973: space.</p>
                   5974: </div>
                   5975: <div class="sect2">
                   5976: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     5977: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
1.299     rillig   5978: <p>When a possibly empty variable is used in a shell program, it may
                   5979: lead to a syntax error.</p>
                   5980: <pre class="programlisting">
                   5981: EGFILES=        # empty
1.87      wiz      5982: 
1.299     rillig   5983: install-examples:   # produces a syntax error in the shell
                   5984:         for egfile in ${EGFILES}; do            \
                   5985:                 echo "Installing $$egfile";     \
                   5986:         done
                   5987: </pre>
                   5988: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.378     leot     5989: <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   5990: To fix this syntax error, use one of the snippets below.</p>
                   5991: <pre class="programlisting">
1.344     gutterid 5992: EGFILES=        # empty
1.87      wiz      5993: 
1.299     rillig   5994: install-examples:
                   5995:         for egfile in ${EGFILES} ""; do         \
                   5996:                 [ -n "$$egfile" ] || continue;  \
                   5997:                 echo "Installing $$egfile";     \
                   5998:         done
                   5999: </pre>
                   6000: <p>In this case, an empty string is appended to the iteration list (to
                   6001: prevent the syntax error) and filtered out later.</p>
                   6002: <pre class="programlisting">
                   6003: EGFILES=        # empty
1.87      wiz      6004: 
1.299     rillig   6005: install-examples:
                   6006: .for egfile in ${EGFILES}
                   6007:         echo "Installing ${egfile}"
                   6008: .endfor
1.100     rillig   6009: </pre>
1.299     rillig   6010: <p>If one of the filenames contains special characters, it should be
                   6011: enclosed in single or double quotes.</p>
                   6012: <p>To have a shell command test whether a make variable is empty, use
                   6013: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   6014: </div>
1.344     gutterid 6015: <div class="sect2">
                   6016: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6017: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
1.344     gutterid 6018: <p>When a variable can have the values <code class="literal">yes</code> or
                   6019: <code class="literal">no</code>, use the following pattern to test the variable:</p>
                   6020: <pre class="programlisting">
                   6021: .if ${VAR:U:tl} == "yes"
                   6022: # do something
                   6023: .endif
                   6024: </pre>
                   6025: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
                   6026: can be undefined. If the variable is guaranteed to be defined, the
                   6027: <code class="literal">:U</code> can be omitted.</p>
                   6028: <p>The <code class="literal">:tl</code> modifier converts the variable value to
                   6029: lowercase, allowing for the values <code class="literal">yes</code>,
                   6030: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
                   6031: </div>
1.299     rillig   6032: </div>
                   6033: </div>
                   6034: <div class="chapter">
                   6035: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6036: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.299     rillig   6037: <div class="toc">
                   6038: <p><b>Table of Contents</b></p>
                   6039: <dl class="toc">
                   6040: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   6041: <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>
                   6042: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   6043: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   6044: </dl>
1.75      rillig   6045: </div>
1.299     rillig   6046: <p>Many packages have the ability to be built to support different
                   6047: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6048: in pkgsrc that provides generic handling of those options that
                   6049: determine different ways in which the packages can be built.  It's
                   6050: possible for the user to specify exactly which sets of options will be
                   6051: built into a package or to allow a set of global default options
                   6052: apply.</p>
                   6053: <p>There are two broad classes of behaviors that one might want to
                   6054: control via options.  One is whether some particular feature is
                   6055: enabled in a program that will be built anyway, often by including or
                   6056: not including a dependency on some other package.  The other is
                   6057: whether or not an additional program will be built as part of the
                   6058: package.  Generally, it is better to make a split package for such
                   6059: additional programs instead of using options, because it enables
                   6060: binary packages to be built which can then be added separately.  For
                   6061: example, the foo package might have minimal dependencies (those
                   6062: packages without which foo doesn't make sense), and then the foo-gfoo
                   6063: package might include the GTK frontend program gfoo.  This is better
                   6064: than including a gtk option to foo that adds gfoo, because either that
                   6065: option is default, in which case binary users can't get foo without
                   6066: gfoo, or not default, in which case they can't get gfoo.  With split
                   6067: packages, they can install foo without having GTK, and later decide to
                   6068: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6069: source users too, avoiding the need for rebuilds.</p>
                   6070: <p>Plugins with widely varying dependencies should usually be split
                   6071: instead of options.</p>
                   6072: <p>It is often more work to maintain split packages, especially if
                   6073: the upstream package does not support this.  The decision of split
                   6074: vs. option should be made based on the likelihood that users will want
                   6075: or object to the various pieces, the size of the dependencies that are
                   6076: included, and the amount of work.</p>
                   6077: <p>A further consideration is licensing.  Non-free parts, or parts
                   6078: that depend on non-free dependencies (especially plugins) should
                   6079: almost always be split if feasible.</p>
                   6080: <div class="sect1">
                   6081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6082: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.299     rillig   6083: <p>Global default options are listed in
                   6084: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6085: that should be built into every package if that option is supported.
                   6086: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6087: </div>
1.148     asau     6088: <div class="sect1">
1.75      rillig   6089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6090: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.299     rillig   6091: </h2></div></div></div>
                   6092: <p>The following example shows how
                   6093: <code class="filename">bsd.options.mk</code> should be used
                   6094: by the hypothetical ``wibble'' package, either in the package
                   6095: <code class="filename">Makefile</code>, or in a file,
                   6096: e.g. <code class="filename">options.mk</code>, that is included by the
                   6097: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6098: <pre class="programlisting">
1.299     rillig   6099: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6100: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6101: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6102: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6103: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6104: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6105: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6106: 
                   6107: .include "../../mk/bsd.prefs.mk"
                   6108: 
                   6109: # this package was previously named wibble2
                   6110: .if defined(PKG_OPTIONS.wibble2)
                   6111: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6112: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6113:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6114: .endif
                   6115: 
                   6116: .include "../../mk/bsd.options.mk"
                   6117: 
                   6118: # Package-specific option-handling
1.100     rillig   6119: 
1.299     rillig   6120: ###
                   6121: ### FOO support
                   6122: ###
                   6123: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6124: CONFIGURE_ARGS+=    --enable-foo
                   6125: .endif
1.100     rillig   6126: 
1.299     rillig   6127: ###
                   6128: ### LDAP support
                   6129: ###
                   6130: .if !empty(PKG_OPTIONS:Mldap)
                   6131: .  include "../../databases/openldap-client/buildlink3.mk"
                   6132: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6133: .endif
1.100     rillig   6134: 
1.299     rillig   6135: ###
                   6136: ### database support
                   6137: ###
                   6138: .if !empty(PKG_OPTIONS:Mmysql)
                   6139: .  include "../../mk/mysql.buildlink3.mk"
                   6140: .endif
                   6141: .if !empty(PKG_OPTIONS:Mpgsql)
                   6142: .  include "../../mk/pgsql.buildlink3.mk"
                   6143: .endif
                   6144: </pre>
                   6145: <p>The first section contains the information about which build
                   6146: options are supported by the package, and any default options settings
                   6147: if needed.</p>
                   6148: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6149: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.378     leot     6150: <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   6151: options.  It should be set to
                   6152: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6153: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6154: at the point where the options are processed.</p></li>
                   6155: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6156: build options supported by the package.</p></li>
                   6157: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6158: list of names of groups of mutually exclusive options.  The options in
                   6159: each group are listed in
                   6160: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6161: The most specific setting of any option from the group takes
                   6162: precedence over all other options in the group.  Options from the
                   6163: groups will be automatically added to
                   6164: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6165: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6166: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6167: packages will fail if no option from the group is
                   6168: selected.</p></li>
                   6169: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6170: of names of sets of options.  At least one option from each set must
                   6171: be selected.  The options in each set are listed in
                   6172: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6173: Options from the sets will be automatically added to
                   6174: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6175: fail if no option from the set is selected.</p></li>
                   6176: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6177: build options which are enabled by default.</p></li>
                   6178: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6179: of
1.385     leot     6180: <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   6181: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   6182: their option counterparts.  Pairs should be added with
1.385     leot     6183: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables.  A
1.299     rillig   6184: warning will be issued if the user uses a legacy
                   6185: variable.</p></li>
                   6186: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6187: of
1.385     leot     6188: <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   6189: pairs that map options that have been renamed to their new
1.385     leot     6190: counterparts.  Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.299     rillig   6191: the listing of global legacy options.  A warning will be issued if
                   6192: the user uses a legacy option.</p></li>
                   6193: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6194: options implied by deprecated variables used.  This can be used for
                   6195: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6196: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6197: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6198: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6199: a list of warnings about deprecated variables or options used, and
                   6200: what to use instead.</p></li>
                   6201: </ol></div>
                   6202: <p>A package should never modify
                   6203: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6204: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6205: To suggest a default set of options, use
                   6206: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6207: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6208: including <code class="filename">bsd.options.mk</code>.  If none of
                   6209: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6210: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6211: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6212: happen with platform-specific options if none of them is supported on
                   6213: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6214: empty list and the package is otherwise treated as not using the
                   6215: options framework.</p>
                   6216: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6217: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6218: build options, properly filtered to remove unsupported and duplicate
                   6219: options.</p>
                   6220: <p>The remaining sections contain the logic that is specific to
                   6221: each option.  The correct way to check for an option is to check
                   6222: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6223: <pre class="programlisting">
                   6224: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   6225: </pre>
1.75      rillig   6226: </div>
1.299     rillig   6227: <div class="sect1">
                   6228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6229: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.299     rillig   6230: <p>Options that enable similar features in different packages (like
                   6231: optional support for a library) should use a common name in all
                   6232: packages that support it (like the name of the library).  If another
                   6233: package already has an option with the same meaning, use the same
                   6234: name.</p>
                   6235: <p>Options that enable features specific to one package, where it's
                   6236: unlikely that another (unrelated) package has the same (or a similar)
                   6237: optional feature, should use a name prefixed with
                   6238: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6239: <p>If a group of related packages share an optional feature
                   6240: specific to that group, prefix it with the name of the
1.385     leot     6241: <span class="quote">“<span class="quote">main</span>”</span> package
1.299     rillig   6242: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6243: <p>For new options, add a line to
                   6244: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6245: fields, separated by tab.  The first field is the option name, the
                   6246: second its description.  The description should be a whole sentence
                   6247: (starting with an uppercase letter and ending with a period) that
1.385     leot     6248: describes what enabling the option does.  E. g. <span class="quote">“<span class="quote">Enable ispell
                   6249: support.</span>”</span> The file is sorted by option names.</p>
1.299     rillig   6250: </div>
                   6251: <div class="sect1">
                   6252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6253: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.299     rillig   6254: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   6255: different dependencies based on the options with which the package was
                   6256: built. For querying these options, the file
                   6257: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6258: typical example looks like this:</p>
1.87      wiz      6259: <pre class="programlisting">
1.299     rillig   6260: pkgbase := libpurple
                   6261: .include "../../mk/pkg-build-options.mk"
                   6262: 
                   6263: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6264: ...
                   6265: .endif
1.229     sevan    6266: </pre>
1.299     rillig   6267: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6268: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6269: options of the libpurple package, which can then be queried like
                   6270: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6271: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6272: details.</p>
1.75      rillig   6273: </div>
                   6274: </div>
1.148     asau     6275: <div class="chapter">
1.75      rillig   6276: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6277: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6278: <div class="toc">
                   6279: <p><b>Table of Contents</b></p>
1.210     leot     6280: <dl class="toc">
1.299     rillig   6281: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   6282: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   6283: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6284: </dl>
                   6285: </div>
1.299     rillig   6286: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6287: by pkgsrc and also for individual packages to define what commands
                   6288: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   6289: or for later run-time of an installed packaged (such as
                   6290: <code class="varname">DEPENDS</code>).
                   6291: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6292: package will not be used.</p>
                   6293: <p>When building a package, the replacement tools are
                   6294: made available in a directory (as symlinks or wrapper scripts)
                   6295: that is early in the executable search path. Just like the buildlink
                   6296: system, this helps with consistent builds.</p>
                   6297: <p>A tool may be needed to help build a specific package. For example,
                   6298: perl, GNU make (gmake) or yacc may be needed.</p>
                   6299: <p>Also a tool may be needed, for example, because the native system's supplied
                   6300: tool may be inefficient for building a package with pkgsrc.
                   6301: For example, a package may need GNU awk, bison (instead of
                   6302: yacc) or a better sed.</p>
                   6303: <p>The tools used by a package can be listed by running
                   6304: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6305: <div class="sect1">
1.75      rillig   6306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6307: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.299     rillig   6308: <p>The default set of tools used by pkgsrc is defined in
                   6309: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6310: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6311: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6312: These can be seen by running:
                   6313: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6314: <p>If a package needs a specific program to build
                   6315: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6316: to define the tools needed.</p>
1.75      rillig   6317: </div>
1.299     rillig   6318: <div class="sect1">
                   6319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6320: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.299     rillig   6321: <p>In the following examples, the :run means that it is needed at
                   6322: run-time (and becomes a DEPENDS).
                   6323: The default is a build dependency which can be set with
                   6324: :build. (So in this example, it is the same as gmake:build
                   6325: and pkg-config:build.)</p>
1.75      rillig   6326: <pre class="programlisting">
1.299     rillig   6327: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6328: </pre>
1.299     rillig   6329: <p>When using the tools framework, a
                   6330: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6331: which contains the full path to the appropriate tool. For example,
1.385     leot     6332: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.299     rillig   6333: on Linux systems.</p>
                   6334: <p>If you always need a pkgsrc version of the
                   6335: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6336: </p>
1.75      rillig   6337: </div>
1.299     rillig   6338: <div class="sect1">
                   6339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6340: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.299     rillig   6341: <p>When improving or porting pkgsrc to a new platform, have a look
                   6342: at (or create) the corresponding platform specific make file fragment under
                   6343: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6344: the name of the common tools. For example:</p>
1.75      rillig   6345: <pre class="programlisting">
1.299     rillig   6346: .if exists(/usr/bin/bzcat)
                   6347: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6348: .elif exists(/usr/bin/bzip2)
                   6349: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6350: .endif
                   6351: 
                   6352: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6353: </pre>
1.75      rillig   6354: </div>
                   6355: </div>
1.299     rillig   6356: <div class="chapter">
                   6357: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6358: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
1.299     rillig   6359: <div class="toc">
                   6360: <p><b>Table of Contents</b></p>
                   6361: <dl class="toc">
                   6362: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6363: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6364: <dd><dl>
                   6365: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6366: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6367:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6368:       and
                   6369:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6370:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6371: </dl></dd>
                   6372: <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   6373: <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   6374: </dl>
1.75      rillig   6375: </div>
1.299     rillig   6376: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6377:   are seen by a package's configure and build processes.  This is implemented
                   6378:   in a two step process:</p>
                   6379: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6380: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6381:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6382:       of <code class="varname">WRKDIR</code>.</p></li>
                   6383: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6384:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6385:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6386:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6387:       native compiler on some operating systems look like GCC, so that
                   6388:       packages that expect GCC won't require modifications to build with
                   6389:       those native compilers.</p></li>
                   6390: </ol></div>
                   6391: <p>This normalizes the environment in which a package is built so that the
                   6392:   package may be built consistently despite what other software may be
                   6393:   installed. Please note that the normal system header and library paths,
                   6394:   e.g. <code class="filename">/usr/include</code>,
                   6395:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6396:   designed to insulate the package build from non-system-supplied
                   6397:   software.</p>
1.148     asau     6398: <div class="sect1">
1.75      rillig   6399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6400: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
1.299     rillig   6401: <p>The process of converting packages to use the buildlink3
1.385     leot     6402:     framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.299     rillig   6403:     The things to keep in mind are:</p>
1.128     wiz      6404: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6405: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6406:        instead of the actual toolchain.  Some packages are tricky,
                   6407:        and the only way to know for sure is the check
                   6408:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6409:        wrappers are being invoked.</p></li>
                   6410: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6411:        the package Makefile, e.g. Java VMs, standalone shells,
                   6412:        etc., because the code to symlink files into
                   6413:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.385     leot     6414:        relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.299     rillig   6415:        </p></li>
                   6416: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6417:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6418:        package's Makefile are added as dependencies for that package.
                   6419:        </p></li>
                   6420: </ol></div>
                   6421: <p>If a dependency on a particular package is required for its libraries and
                   6422:     headers, then we replace:</p>
                   6423: <pre class="programlisting">
                   6424: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6425: </pre>
                   6426: <p>with</p>
                   6427: <pre class="programlisting">
                   6428: .include "../../category/foo/buildlink3.mk"
                   6429: </pre>
                   6430: <p>The buildlink3.mk files usually define the required dependencies.
                   6431:     If you need a newer version of the dependency when using buildlink3.mk
                   6432:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6433: <pre class="programlisting">
1.299     rillig   6434: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6435: .include "../../category/foo/buildlink3.mk"
1.1       grant    6436: </pre>
1.299     rillig   6437: <p>There are several <code class="filename">buildlink3.mk</code>
                   6438:     files in <code class="filename">pkgsrc/mk</code>
                   6439:     that handle special package issues:</p>
                   6440: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6441: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6442:        the native or a pkgsrc Berkeley DB implementation based on
                   6443:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6444:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6445: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6446:        comes with neither Curses nor NCurses, this will take care
1.322     leot     6447:        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   6448: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6449:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6450:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6451:        require a Kerberos 5 implementation.</p></li>
                   6452: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6453:        system-provided Motif installation or adds a dependency on
1.388     wiz      6454:        <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
                   6455:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span> or
                   6456:        <span class="quote">“<span class="quote">motif</span>”</span> to choose which Motif version will be
                   6457:        used.</p></li>
1.299     rillig   6458: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6459:        system-provided GNU readline or editline (libedit) installation,
1.322     leot     6460:        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>,
                   6461:        <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   6462:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6463:        If your package really needs GNU readline library, its Makefile
                   6464:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6465:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6466: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6467:        variables that may be used by packages that use the
                   6468:        Open Sound System (OSS) API.</p></li>
                   6469: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6470:        any of the Postgres versions in the variable
                   6471:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6472:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6473:        the file for more information.</p></li>
                   6474: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6475:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322     leot     6476:        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   6477: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6478:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6479:        library.</p></li>
                   6480: </ul></div>
                   6481: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6482:     files provide a more complete
                   6483:     description of how to use them properly.</p>
1.75      rillig   6484: </div>
1.148     asau     6485: <div class="sect1">
1.75      rillig   6486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6487: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.299     rillig   6488: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6489:     included by Makefiles to indicate the need to compile and link
                   6490:     against header files and libraries provided by the package.  A
                   6491:     <code class="filename">buildlink3.mk</code> file should always provide
                   6492:     enough information to add the correct type of dependency
                   6493:     relationship and include any other
                   6494:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6495:     headers and libraries that it needs in turn.</p>
                   6496: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322     leot     6497:     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   6498:     package is highly recommended.  For most packages, the following
                   6499:     command will generate a good starting point for
                   6500:     <code class="filename">buildlink3.mk</code> files:</p>
                   6501: <pre class="screen">
                   6502: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6503: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6504:     </pre>
1.148     asau     6505: <div class="sect2">
1.75      rillig   6506: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6507: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.299     rillig   6508: <p>The following real-life example
                   6509:       <code class="filename">buildlink3.mk</code> is taken
                   6510:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6511: <pre class="programlisting">
1.299     rillig   6512: BUILDLINK_TREE+=        tiff
                   6513: 
                   6514: .if !defined(TIFF_BUILDLINK3_MK)
                   6515: TIFF_BUILDLINK3_MK:=
                   6516: 
                   6517: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6518: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6519: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6520: 
                   6521: .include "../../devel/zlib/buildlink3.mk"
                   6522: .include "../../graphics/jpeg/buildlink3.mk"
                   6523: .endif # TIFF_BUILDLINK3_MK
                   6524: 
                   6525: BUILDLINK_TREE+=        -tiff
1.1       grant    6526: </pre>
1.299     rillig   6527: <p>The header and footer manipulate
                   6528:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6529:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6530:       the dependency tree.</p>
                   6531: <p>The main section is protected from multiple inclusion
                   6532:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6533:       added.  Several important variables are set in the section:</p>
                   6534: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6535: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6536:          is the dependency version recorded in the installed
1.299     rillig   6537:          package; this should always be set using
                   6538:          <span class="command"><strong>+=</strong></span> to ensure that
                   6539:          we're appending to any pre-existing list of values.  This
1.300     wiz      6540:          variable should be set to the last version of the
1.299     rillig   6541:          package that had an backwards-incompatible API change.
                   6542:          </p></li>
                   6543: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6544:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6545:          pkgsrc directory.</p></li>
                   6546: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6547:          (not shown above) controls whether we use
1.350     gutterid 6548:          <code class="varname">BUILD_DEPENDS</code> or
1.299     rillig   6549:          <code class="varname">DEPENDS</code> to add the dependency on
                   6550:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6551:          selected by setting
                   6552:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6553:          to <span class="quote">“<span class="quote">build</span>”</span>.  By default, the full dependency is
1.299     rillig   6554:          used.</p></li>
                   6555: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6556:            and
                   6557:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6558:            (not shown above) are lists of subdirectories of
                   6559:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6560:            to add to the header and library search paths.  These
1.385     leot     6561:            default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.299     rillig   6562:          respectively.</p></li>
                   6563: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6564:            (not shown above) is the list of preprocessor flags to add
                   6565:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.385     leot     6566:            configure and build phases.  The <span class="quote">“<span class="quote">-I</span>”</span> option
1.299     rillig   6567:            should be avoided and instead be handled using
                   6568:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6569:          above.</p></li>
                   6570: </ul></div>
                   6571: <p>The following variables are all optionally defined within
                   6572:       this second section (protected against multiple inclusion) and
                   6573:       control which package files are symlinked into
                   6574:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6575:       transformed during the symlinking:</p>
                   6576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6577: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6578:            (not shown above) is a shell glob pattern relative to
                   6579:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6580:            to be symlinked into
                   6581:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6582:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6583: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6584:            (not shown above) is a shell pipeline that
                   6585:            outputs to stdout a list of files relative to
                   6586:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6587:            The resulting files are to be symlinked
                   6588:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6589:            this takes the <code class="filename">+CONTENTS</code> of a
                   6590:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6591:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6592: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6593:            (not shown above) is a filter command that filters
                   6594:            <code class="filename">+CONTENTS</code> input into a list of files
                   6595:            relative to
                   6596:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6597:            on stdout.  By default,
                   6598:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6599:            outputs the contents of the <code class="filename">include</code>
                   6600:            and <code class="filename">lib</code> directories in the package
                   6601:            <code class="filename">+CONTENTS</code>.</p></li>
                   6602: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6603:            (not shown above) is a list of sed arguments used to
                   6604:            transform the name of the source filename into a
                   6605:            destination filename, e.g. <span class="command"><strong>-e
                   6606:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6607: </ul></div>
                   6608: <p>This section can additionally include any
                   6609:       <code class="filename">buildlink3.mk</code> needed for
                   6610:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6611:       Including these <code class="filename">buildlink3.mk</code> files
                   6612:       means that the headers and libraries for these
                   6613:       dependencies are also symlinked into
                   6614:       <code class="filename">${BUILDLINK_DIR}</code>
                   6615:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6616:       <code class="filename">buildlink3.mk</code>
                   6617:       file is included. Dependencies are only added for directly
                   6618:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6619: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6620:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6621:       please only add necessary ones, i.e., those whose libraries or
                   6622:       header files are automatically exposed when the package is
                   6623:       use.</p>
                   6624: <p>In particular, if only an executable
                   6625:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6626:       library does not need to be propagated in the
                   6627:       <code class="filename">buildlink3.mk</code> file.</p>
                   6628: <p>The following steps should help you decide if a
                   6629:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6630:       </p>
                   6631: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6632: <li class="listitem"><p>Look at the installed header files: What
                   6633:        headers do they include? The packages providing these files
                   6634:        must be buildlinked.</p></li>
                   6635: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6636:        libraries and look against what other libraries they link.
                   6637:        Some of the packages providing these probably need to be
                   6638:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6639:        some systems pulls in the X libraries, so they will show up in
                   6640:        the <code class="filename">ldd</code> output, while on others (like OS
                   6641:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6642:        used as a hint.</p></li>
                   6643: </ul></div>
                   6644: <p>
                   6645:       </p>
                   6646: </div>
1.148     asau     6647: <div class="sect2">
1.75      rillig   6648: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6649: <a name="updating-buildlink-depends"></a>18.2.2. Updating
1.299     rillig   6650:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6651:       and
                   6652:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6653:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6654: <p>Both variables set lower bounds for a version of this package.
                   6655:       The two variables differ in that one describes source
1.299     rillig   6656:       compatibility (API) and the other binary compatibility (ABI).
                   6657:       The difference is that a change in the API breaks compilation of
                   6658:       programs while changes in the ABI stop compiled programs from
                   6659:       running.</p>
1.300     wiz      6660: <p>The
                   6661:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6662:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6663:       changed very rarely.  (One possible scenario: If all packages
                   6664:       using this package need a higher version than defined in the
                   6665:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6666:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6667:       could be updated to that higher version.)</p>
                   6668: <p>On the other hand, changes to
1.299     rillig   6669:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6670:       are more common.  The variable will need to be updated every
                   6671:       time the major version of one of its shared libraries is changed,
                   6672:       or any other change where a binary built against the previous
                   6673:       version of the package will not run against the new version any
                   6674:       longer.</p>
                   6675: <p>In such a case, the package's
1.299     rillig   6676:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6677:       must be increased to require the new package version.  Then the
                   6678:       <code class="varname">PKGREVISION</code> of all packages
                   6679:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6680:       to be increased, and if they have
                   6681:       <code class="filename">buildlink3.mk</code> files,
                   6682:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6683:       in their <code class="filename">buildlink3.mk</code> files must be
                   6684:       increased to the new version as well. This is required so that a
                   6685:       package will pull in the versions of the packages that use the
                   6686:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6687:       uniquely identify the packages built against the new ABI. The
1.322     leot     6688:       <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      6689:       help with these updates.</p>
1.385     leot     6690: <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      6691:       about dependencies on other packages, including the
                   6692:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6693: <p>Please take careful consideration before adjusting
                   6694:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6695:       or
                   6696:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6697:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6698:       cause unneeded package deletions and rebuilds.  In many cases,
                   6699:       new versions of packages work just fine with older
                   6700:       dependencies.</p>
1.326     gutterid 6701: <p>Also, it is not needed to set
1.299     rillig   6702:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6703:       when it is identical to
1.326     gutterid 6704:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
                   6705: <p>Note there is also the distinction that users are able to disable
                   6706:       enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
                   6707:       variable, but there is no equivalent option for API dependencies.</p>
1.75      rillig   6708: </div>
                   6709: </div>
1.148     asau     6710: <div class="sect1">
1.75      rillig   6711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6712: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.299     rillig   6713: <p>Some packages in pkgsrc install headers and libraries that
                   6714:       coincide with headers and libraries present in the base system.
                   6715:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6716:       packages should also include a <code class="filename">builtin.mk</code>
                   6717:       file that includes the necessary checks to decide whether using
                   6718:       the built-in software or the pkgsrc software is
                   6719:     appropriate.</p>
                   6720: <p>The only requirements of a builtin.mk file for
                   6721:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6722: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6723: <li class="listitem"><p>It should set
                   6724:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6725:        to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.299     rillig   6726:        after it is included.</p></li>
                   6727: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6728:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6729:        which is already set before the
                   6730:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6731: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6732:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6733:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6734: </ol></div>
                   6735: <div class="sect2">
                   6736: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     6737: <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   6738: <p>The following is the recommended template for builtin.mk
                   6739:       files:</p>
1.75      rillig   6740: <pre class="programlisting">
1.299     rillig   6741: .if !defined(IS_BUILTIN.foo)
                   6742: #
                   6743: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6744: # genuinely exists in the system or not.
                   6745: #
                   6746: IS_BUILTIN.foo?=        no
1.100     rillig   6747: 
1.299     rillig   6748: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6749: # version can be determined.
                   6750: #
                   6751: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6752: BUILTIN_PKG.foo?=       foo-1.0
                   6753: .  endif
                   6754: .endif  # IS_BUILTIN.foo
1.100     rillig   6755: 
1.299     rillig   6756: .if !defined(USE_BUILTIN.foo)
                   6757: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6758: .  if defined(BUILTIN_PKG.foo)
                   6759: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6760: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6761: USE_BUILTIN.foo!=                                                       \
                   6762:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6763:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6764: .      endif
                   6765: .    endfor
                   6766: .  endif
                   6767: .endif  # USE_BUILTIN.foo
1.100     rillig   6768: 
1.299     rillig   6769: CHECK_BUILTIN.foo?=     no
                   6770: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6771: #
                   6772: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6773: # "yes" or "no".
                   6774: #
                   6775: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6776: </pre>
1.299     rillig   6777: <p>The first section sets
                   6778:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6779:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6780:       in the base system.  This should not be a base system software
                   6781:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.385     leot     6782:       it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.299     rillig   6783:       included as part of the base system.  This variable is only
                   6784:       used internally within the <code class="filename">builtin.mk</code>
                   6785:       file.</p>
                   6786: <p>The second section sets
                   6787:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6788:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6789:       system if it exists (if
                   6790:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6791:       is <span class="quote">“<span class="quote">yes</span>”</span>).  This variable is only used internally
1.299     rillig   6792:       within the <code class="filename">builtin.mk</code> file.</p>
                   6793: <p>The third section sets
                   6794:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6795:       and is <span class="emphasis"><em>required</em></span> in all
                   6796:       <code class="filename">builtin.mk</code> files.  The code in this
                   6797:       section must make the determination whether the built-in
                   6798:       software is adequate to satisfy the dependencies listed in
                   6799:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6800:       This is typically done by comparing
                   6801:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6802:       against each of the dependencies in
                   6803:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6804:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6805:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6806:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6807:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6808:       may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.299     rillig   6809:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.385     leot     6810:       is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.299     rillig   6811:       that the built-in version of the software is similar enough to
                   6812:       be used as a replacement.</p>
                   6813: <p>The last section is guarded by
                   6814:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6815:       and includes code that uses the value of
                   6816:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6817:       set in the previous section.  This typically includes, e.g.,
                   6818:       adding additional dependency restrictions and listing additional
                   6819:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6820:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6821: </div>
1.107     rillig   6822: </div>
1.75      rillig   6823: </div>
1.148     asau     6824: <div class="chapter">
1.75      rillig   6825: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     6826: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6827: <div class="toc">
                   6828: <p><b>Table of Contents</b></p>
1.210     leot     6829: <dl class="toc">
1.299     rillig   6830: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6831: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6832: <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>
                   6833: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6834: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6835: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6836: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6837: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6838: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6839: </dl>
                   6840: </div>
1.299     rillig   6841: <p>The <code class="filename">PLIST</code> file contains a package's
1.385     leot     6842:   <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.299     rillig   6843:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6844:   directory it's been installed in) plus some additional statements
1.378     leot     6845:   - 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   6846:   This chapter addresses some issues that need attention when
                   6847:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6848:   below!).</p>
1.148     asau     6849: <div class="sect1">
1.75      rillig   6850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6851: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
1.299     rillig   6852: <p>Be sure to add a RCS ID line as the first thing in any
                   6853:     <code class="filename">PLIST</code> file you write:</p>
                   6854: <pre class="programlisting">
                   6855: @comment $NetBSD $
                   6856: </pre>
                   6857: <p>An artificial space has been added between NetBSD and $, this is a
                   6858: workaround here to prevent CVS expanding to the filename of the guide. When
                   6859: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6860: </div>
1.148     asau     6861: <div class="sect1">
1.75      rillig   6862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6863: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.299     rillig   6864: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6865:     to output a PLIST that matches any new files since the package
1.385     leot     6866:     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   6867:     more information on this target.</p>
1.75      rillig   6868: </div>
1.148     asau     6869: <div class="sect1">
1.75      rillig   6870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6871: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.299     rillig   6872: </h2></div></div></div>
                   6873: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6874:     of AWK patterns and actions that are used to filter the output of
                   6875:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6876:     scripting you like to it, but be careful with quoting.</p>
                   6877: <p>For example, to get all files inside the
                   6878:     <code class="filename">libdata/foo</code> directory removed from the
                   6879:     resulting PLIST:</p>
1.88      wiz      6880: <pre class="programlisting">
1.299     rillig   6881: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6882: </pre>
1.300     wiz      6883: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6884:     evaluated after the file list and directory list are sorted.
                   6885:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6886:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6887:     list and directory list are sorted.</p>
1.299     rillig   6888: </div>
                   6889: <div class="sect1">
                   6890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6891: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
1.299     rillig   6892: <p>A number of variables are substituted automatically in
                   6893:     PLISTs when a package is installed on a system. This includes the
                   6894:     following variables:</p>
                   6895: <div class="variablelist"><dl class="variablelist">
                   6896: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6897: <dd>
                   6898: <p>Some packages like emacs and perl embed information
                   6899:          about which architecture they were built on into the
                   6900:          pathnames where they install their files. To handle this
                   6901:          case, PLIST will be preprocessed before actually used, and
                   6902:          the symbol
1.385     leot     6903:          <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.299     rillig   6904:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6905:          same is done if the string
                   6906:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6907:          PLIST somewhere - use this on packages that have GNU
                   6908:          autoconf-created configure scripts.</p>
                   6909: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6910: <h3 class="title">Legacy note</h3>
                   6911: <p>There used to be a symbol
1.385     leot     6912:            <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.299     rillig   6913:            was replaced by the output of <span class="command"><strong>uname
                   6914:            -m</strong></span>, but that's no longer supported and has
                   6915:            been removed.</p>
                   6916: </div>
                   6917: </dd>
                   6918: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6919: <dd>
                   6920: <p>Some packages want to embed the OS name and version
                   6921:          into some paths.  To do this, use these variables in the
                   6922:          <code class="filename">PLIST</code>:
                   6923:          </p>
                   6924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.385     leot     6925: <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>
                   6926: <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>
                   6927: <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   6928: </ul></div>
                   6929: </dd>
                   6930: </dl></div>
                   6931: <p>For a list of values which are replaced by
                   6932:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6933: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6934: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6935: <p>If you want to change other variables not listed above, you
                   6936:     can add variables and their expansions to this variable in the
1.385     leot     6937:     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   6938: <pre class="programlisting">
1.299     rillig   6939: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6940: </pre>
1.385     leot     6941: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.299     rillig   6942:     in the <code class="filename">PLIST</code> with
1.385     leot     6943:     <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.299     rillig   6944: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6945:     the common case of conditionally including some
                   6946:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6947:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6948:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6949:     to <code class="literal">yes</code> if the entry should be included.
1.385     leot     6950:     This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.299     rillig   6951:     in the <code class="filename">PLIST</code> with either
1.385     leot     6952:     <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
                   6953:     <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.299     rillig   6954:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6955: <pre class="programlisting">
1.299     rillig   6956: PLIST_VARS+=    foo
                   6957: .if <em class="replaceable"><code>condition</code></em>
                   6958: PLIST.foo=      yes
                   6959: .else
1.174     asau     6960: </pre>
1.299     rillig   6961: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6962: <pre class="programlisting">
1.299     rillig   6963: @comment $NetBSD $
                   6964: bin/bar
                   6965: man/man1/bar.1
                   6966: ${PLIST.foo}bin/foo
                   6967: ${PLIST.foo}man/man1/foo.1
                   6968: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6969: </pre>
1.299     rillig   6970: <p>An artificial space has been added between NetBSD and $, this is a
                   6971: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6972: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6973: </div>
1.299     rillig   6974: <div class="sect1">
                   6975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6976: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
1.299     rillig   6977: <p>Man pages should be installed in compressed form if
                   6978:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6979:     and uncompressed otherwise. To handle this in the
1.385     leot     6980:     <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.299     rillig   6981:     appended/removed automatically for man pages according to
                   6982:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6983:     or not, see above for details. This modification of the
                   6984:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6985:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6986: </div>
1.148     asau     6987: <div class="sect1">
1.75      rillig   6988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     6989: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.299     rillig   6990: </h2></div></div></div>
                   6991: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6992:     in generating the binary package, set the variable
                   6993:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.378     leot     6994:     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   6995:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6996:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6997: </div>
1.148     asau     6998: <div class="sect1">
1.75      rillig   6999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7000: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.299     rillig   7001: <p>Some packages decide to install a different set of files based on
                   7002:     the operating system being used. These differences can be
                   7003:     automatically handled by using the following files:</p>
                   7004: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7005: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   7006: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   7007: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   7008: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   7009: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   7010: </ul></div>
1.75      rillig   7011: </div>
1.148     asau     7012: <div class="sect1">
1.75      rillig   7013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7014: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
1.299     rillig   7015: <p>Some packages decide to generate hard-to-guess file names
                   7016:     during installation that are hard to wire down.</p>
                   7017: <p>In such cases, you can set the
                   7018:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   7019:     terminated (with a semicolon) that will output PLIST entries which
                   7020:     will be appended to the PLIST</p>
                   7021: <p>You can find one example in editors/xemacs:</p>
                   7022: <pre class="programlisting">
                   7023: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   7024: </pre>
                   7025: <p>which will append something like
                   7026:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   7027:     <code class="filename">PLIST</code>.
                   7028:     </p>
1.75      rillig   7029: </div>
1.148     asau     7030: <div class="sect1">
1.75      rillig   7031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7032: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   7033: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.299     rillig   7034:     multiple (and unrelated) packages install files.  These
                   7035:     directories were problematic because you had to add special
                   7036:     tricks in the PLIST to conditionally remove them, or have some
                   7037:     centralized package handle them.</p>
                   7038: <p>In pkgsrc, it is now easy: Each package should create
                   7039:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   7040:     will remove any directories left empty after uninstalling a
                   7041:     package.</p>
                   7042: <p>If a package needs an empty directory to work, create
                   7043:     the directory during installation as usual, and also add an
                   7044:     entry to the PLIST:
                   7045: 
                   7046: </p>
                   7047: <pre class="programlisting">
                   7048: @pkgdir path/to/empty/directory
                   7049: </pre>
                   7050: <p>
                   7051: 
                   7052:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   7053:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      7054:     </p>
1.75      rillig   7055: </div>
1.299     rillig   7056: </div>
                   7057: <div class="chapter">
                   7058: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     7059: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
1.299     rillig   7060: <div class="toc">
                   7061: <p><b>Table of Contents</b></p>
                   7062: <dl class="toc">
                   7063: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   7064: <dd><dl>
                   7065: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   7066: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   7067: </dl></dd>
                   7068: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   7069: <dd><dl>
                   7070: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   7071: <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 7072: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
                   7073: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
                   7074: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299     rillig   7075: </dl></dd>
                   7076: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   7077: <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>
                   7078: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   7079: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   7080: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   7081: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   7082: <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>
                   7083: </dl>
                   7084: </div>
                   7085: <p>This chapter describes the framework known as
                   7086: <code class="literal">pkginstall</code>, whose key features are:</p>
                   7087: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7088: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   7089:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   7090: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   7091:     provided that packages are correctly designed.</p></li>
                   7092: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   7093: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   7094: <li class="listitem"><p>Registration of system shells.</p></li>
                   7095: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   7096: </ul></div>
                   7097: <p>The following sections inspect each of the above points in detail.</p>
                   7098: <p>You may be thinking that many of the things described here could be
                   7099: easily done with simple code in the package's post-installation target
                   7100: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   7101: as the code in them is only executed when building from source.  Machines
                   7102: using binary packages could not benefit from it at all (as the code itself
                   7103: could be unavailable).  Therefore, the only way to achieve any of the items
                   7104: described above is by means of the installation scripts, which are
                   7105: automatically generated by pkginstall.</p>
1.148     asau     7106: <div class="sect1">
1.75      rillig   7107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7108: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
1.299     rillig   7109: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   7110: of files and directories that belong to a package.  The names used in it
                   7111: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   7112: which means that it cannot register files outside this directory (absolute
                   7113: path names are not allowed).  Despite this restriction, some packages need
                   7114: to install files outside this location; e.g., under
                   7115: <code class="filename">${VARBASE}</code> or
                   7116: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   7117: is to create such files during installation time by using
                   7118: installation scripts.</p>
                   7119: <p>The generic installation scripts are shell scripts that can
                   7120: contain arbitrary code.  The list of scripts to execute is taken from
                   7121: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   7122: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   7123: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   7124: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   7125: commands, so they have the potential to create and manage files
                   7126: anywhere in the file system.</p>
                   7127: <p>Using these general installation files is not recommended, but
                   7128: may be needed in some special cases.  One reason for avoiding them is
                   7129: that the user has to trust the packager that there is no unwanted or
                   7130: simply erroneous code included in the installation script. Also,
                   7131: previously there were many similar scripts for the same functionality,
                   7132: and fixing a common error involved finding and changing all of
                   7133: them.</p>
                   7134: <p>The pkginstall framework offers another, standardized way.  It
                   7135: provides generic scripts to abstract the manipulation of such files
                   7136: and directories based on variables set in the package's
                   7137: <code class="filename">Makefile</code>.  The rest of this section describes
                   7138: these variables.</p>
                   7139: <div class="sect2">
                   7140: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7141: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
1.299     rillig   7142: <p>The following variables can be set to request the creation of
                   7143: directories anywhere in the file system:</p>
                   7144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7145: <li class="listitem">
                   7146: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   7147:     contain a list of directories that should be created and should attempt
                   7148:     to be destroyed by the installation scripts.  The difference between
                   7149:     the two is that the latter prompts the administrator to remove any
                   7150:     directories that may be left after deinstallation (because they were
                   7151:     not empty), while the former does not.  Example:</p>
                   7152: <pre class="programlisting">
                   7153: MAKE_DIRS+=             ${VARBASE}/foo/private
                   7154: </pre>
                   7155: </li>
                   7156: <li class="listitem">
                   7157: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   7158:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   7159:     which directories should be created and should attempt to be destroyed
                   7160:     by the installation scripts.  Each tuple holds the following values,
                   7161:     separated by spaces: the directory name, its owner, its group and its
                   7162:     numerical mode.  For example:</p>
                   7163: <pre class="programlisting">
                   7164: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   7165:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   7166: </pre>
                   7167: <p>The difference between the two is exactly the same as their
                   7168:     non-<code class="varname">PERMS</code> counterparts.</p>
                   7169: </li>
                   7170: </ul></div>
1.75      rillig   7171: </div>
1.299     rillig   7172: <div class="sect2">
                   7173: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7174: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
1.299     rillig   7175: <p>Creating non-empty files outside the installation prefix is tricky
                   7176: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.353     dholland 7177: To overcome this problem, the only solution is to extract the file in a
1.299     rillig   7178: known place (i.e., inside the installation prefix) and copy it to the
                   7179: appropriate location during installation (done by the installation scripts
1.353     dholland 7180: generated by pkginstall).  We will call the former the <span class="emphasis"><em>reference
1.299     rillig   7181: file</em></span> in the following paragraphs, which describe the variables
                   7182: that can be used to automatically and consistently handle files outside the
                   7183: installation prefix:</p>
                   7184: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.353     dholland 7185: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
                   7186:     and target files.  At installation time, the reference file is copied
                   7187:     to the target if and only if the latter does not exist.  Upon
                   7188:     deinstallation, the reference file is removed provided that it was
                   7189:     not modified by the installation.</p></li>
1.299     rillig   7190: <li class="listitem">
1.353     dholland 7191: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
                   7192:     reference files and targets, including owner, group, and numeric
                   7193:     permissions that should be set. For example:</p>
1.88      wiz      7194: <pre class="programlisting">
1.299     rillig   7195: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   7196:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   7197: </pre>
1.299     rillig   7198: </li>
1.353     dholland 7199: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
                   7200:     <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
                   7201:     <code class="varname">REQD_FILES</code> and
                   7202:     <code class="varname">REQD_FILES_PERMS</code> respectively.  The difference
                   7203:     is that these variables are specifically intended for handling
                   7204:     configuration files, for which additional conventions and
1.385     leot     7205:     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 7206:     discussion.  Note in particular that while handling of
1.385     leot     7207:     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 7208:     <code class="varname">REQD_FILES</code> and
                   7209:     <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.299     rillig   7210: </ul></div>
1.353     dholland 7211: <p>To install an empty file, one can use these macros and
                   7212:   <code class="filename">/dev/null</code> as the reference file.</p>
1.299     rillig   7213: </div>
1.75      rillig   7214: </div>
1.148     asau     7215: <div class="sect1">
1.75      rillig   7216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7217: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.353     dholland 7218: <p>There are two principles that govern the handling of
                   7219: configuration files in pkgsrc: first, the user's configuration must
                   7220: not be lost or overwritten by upgrades or reinstallations; and second,
                   7221: the default configuration should always be available for reference.
                   7222: To that end, pkgsrc has a framework specifically for handling
                   7223: configuration files.  In general, configuration files are installed
                   7224: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
                   7225: there to the pertinent <code class="filename">etc</code> directory as a
                   7226: separate step and only as needed.</p>
                   7227: <p>To make this work, there are three things that need to happen,
                   7228: any of which may require patching.  First, the package must be told to
                   7229: read its configuration from the correct place at runtime; this place
                   7230: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
                   7231: of it) which is often but not always
                   7232: <code class="filename">${PREFIX}/etc</code>.  Second, the package must be
                   7233: taught to install its default configuration files in
                   7234: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
                   7235: point at which patching often becomes required because it is not the
                   7236: same place as the runtime location.  Third, the configuration files
                   7237: need to be declared in the package makefile; this is the easy part.
                   7238: </p>
                   7239: <p>With those elements in place, the right things will happen: the
                   7240: package install phase and resulting binary package will not touch
                   7241: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
                   7242: will be copied into place by the pkgsrc framework only if not already
                   7243: present.  Similarly, upon deinstall the configuration will not be
                   7244: removed if it has been modified.  (This means that in the case of
                   7245: reinstallation and upgrades, unmodified configuration files are
                   7246: updated but modifications are never discarded.)</p>
                   7247: <p>The following sections describe how to make these things happen
                   7248: and document other relevant knobs available in the pkgsrc
                   7249: infrastructure.</p>
1.299     rillig   7250: <div class="sect2">
                   7251: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7252: <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   7253: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7254: specifies where configuration files shall be installed.  Its contents are
                   7255: set based upon the following variables:</p>
                   7256: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7257: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7258:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.353     dholland 7259:     be overridden by the user to point to their preferred location (e.g.,
1.299     rillig   7260:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7261:     Packages must not use it directly.</p></li>
                   7262: <li class="listitem">
                   7263: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7264:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7265:     for the package being built shall be installed.  The definition of this
                   7266:     variable only makes sense in the package's
                   7267:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7268: <p>As an example, consider the Apache package,
1.322     leot     7269:     <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   7270:     configuration files under the
                   7271:     <code class="filename">httpd/</code> subdirectory of
                   7272:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7273:     Makefile.</p>
                   7274: </li>
                   7275: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7276:     variable that holds this package's configuration directory (if
                   7277:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7278:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7279:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7280: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7281:     directory where the configuration files for the package identified by
                   7282:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7283: </ul></div>
                   7284: <p>Based on the above variables, pkginstall determines the value of
                   7285: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.353     dholland 7286: variable that may be used within a package to refer to its configuration
1.299     rillig   7287: directory.  The algorithm used to set its value is basically the
                   7288: following:</p>
                   7289: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7290: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7291:     its value is used.</p></li>
                   7292: <li class="listitem"><p>If the previous variable is not defined but
                   7293:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7294:     <code class="filename">Makefile</code>, the resulting value is
                   7295:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7296: <li class="listitem"><p>Otherwise, it is set to
                   7297:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7298: </ol></div>
                   7299: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.353     dholland 7300: automatically added to <code class="filename">OWN_DIRS</code>.  This causes it
1.385     leot     7301: 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 7302: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
                   7303: created with <code class="varname">OWN_DIRS</code> or
                   7304: <code class="varname">MAKE_DIRS</code>.</p>
1.299     rillig   7305: </div>
                   7306: <div class="sect2">
                   7307: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7308: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
1.299     rillig   7309: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.353     dholland 7310: known place, you need to teach each package where to install its files.  In
                   7311: some cases you will have to patch the package Makefiles to achieve it.  If
                   7312: you are lucky, though, it may be as easy as passing an extra flag to the
                   7313: configuration script.  This is the case for packages using GNU
                   7314: autoconf:</p>
1.75      rillig   7315: <pre class="programlisting">
1.299     rillig   7316: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7317: </pre>
1.299     rillig   7318: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.353     dholland 7319: for</em></span> its configuration files, not where they will be installed.
                   7320: Fortunately, there is a different way to specify the latter, as seen
1.354     gutterid 7321: in the next section, although the combination is rather confusing at
1.353     dholland 7322: first glance.</p>
1.75      rillig   7323: </div>
1.299     rillig   7324: <div class="sect2">
                   7325: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7326: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
1.353     dholland 7327: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.299     rillig   7328: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7329: directly</strong></span>.  Bad news is that many software installation scripts
                   7330: will, out of the box, mess with the contents of that directory.  So what is
                   7331: the correct procedure to fix this issue?</p>
                   7332: <p>You must teach the package (usually by manually patching it) to
                   7333: install any configuration files under the examples hierarchy,
                   7334: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7335: <code class="filename">PLIST</code> registers them and the administrator always
                   7336: has the original copies available.</p>
1.353     dholland 7337: <p>It turns out that for packages using GNU autoconf it is possible
                   7338: to create the desired effect by setting <code class="varname">sysconfdir</code>
                   7339: on the make command line at install time.  Consider this example taken
                   7340: 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>
                   7341: <pre class="programlisting">
                   7342: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7343: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
                   7344: </pre>
                   7345: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
                   7346: used for this purpose, is local to that package and has no meaning
                   7347: outside it.</p>
                   7348: </div>
                   7349: <div class="sect2">
                   7350: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7351: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.299     rillig   7352: <p>Once the required configuration files are in place (i.e., under the
1.353     dholland 7353: examples hierarchy), the pkginstall framework can use them as reference copies
1.299     rillig   7354: during the package installation to update what is in
                   7355: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7356: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.385     leot     7357: 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 7358: information about their syntax and their purpose.  Here is an example,
                   7359: 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>
                   7360: <pre class="programlisting">
                   7361: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7362: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7363: </pre>
                   7364: <p>Note that (as in the previous section's example) the
                   7365: <code class="varname">EGDIR</code> variable is specific to the package and has
                   7366: no meaning outside it.</p>
                   7367: <p>For reference, the complete example from Mutt is as follows:</p>
1.88      wiz      7368: <pre class="programlisting">
1.353     dholland 7369: CONFIGURE_ARGS+=        --sysconfdir=${PKG_SYSCONFDIR}
                   7370: EGDIR=                  ${PREFIX}/share/examples/mutt
                   7371: CONF_FILES=             ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   7372: INSTALLATION_DIRS+=     ${EGDIR}
                   7373: INSTALL_MAKE_FLAGS=     ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.100     rillig   7374: </pre>
1.75      rillig   7375: </div>
1.299     rillig   7376: <div class="sect2">
                   7377: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7378: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.299     rillig   7379: <p>The automatic copying of config files can be toggled by setting the
                   7380: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7381: installation.</p>
1.88      wiz      7382: </div>
1.75      rillig   7383: </div>
1.148     asau     7384: <div class="sect1">
1.75      rillig   7385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7386: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
1.299     rillig   7387: <p>System startup scripts are special files because they must be
                   7388: installed in a place known by the underlying OS, usually outside the
1.385     leot     7389: 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   7390: can be used.  However, pkginstall provides a special mechanism to handle
                   7391: these files.</p>
                   7392: <p>In order to provide system startup scripts, the package has
                   7393: to:</p>
                   7394: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7395: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7396:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.338     nia      7397:     <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
                   7398:     has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299     rillig   7399: <li class="listitem">
                   7400: <p>Tell pkginstall to handle it, appending the name of the script,
                   7401:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7402:     Continuing the previous example:</p>
                   7403: <pre class="programlisting">
                   7404: RCD_SCRIPTS+=   cupsd
                   7405: </pre>
                   7406: </li>
                   7407: </ol></div>
                   7408: <p>Once this is done, pkginstall will do the following steps for each
                   7409: script in an automated fashion:</p>
                   7410: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7411: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7412:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7413:     variable.</p></li>
                   7414: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7415:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.353     dholland 7416:     that this reference file must be explicitly registered in the
1.299     rillig   7417:     <code class="filename">PLIST</code>.</p></li>
                   7418: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7419:     from the examples hierarchy into the system-wide startup scripts
                   7420:     directory.</p></li>
                   7421: </ol></div>
                   7422: <div class="sect2">
                   7423: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7424: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.299     rillig   7425: <p>The automatic copying of config files can be toggled by setting the
                   7426: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7427: installation.  Note that the scripts will be always copied inside the
                   7428: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7429: matter what the value of this variable is.</p>
1.75      rillig   7430: </div>
                   7431: </div>
1.299     rillig   7432: <div class="sect1">
                   7433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7434: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
1.299     rillig   7435: <p>If a package needs to create special users and/or groups during
                   7436: installation, it can do so by using the pkginstall framework.</p>
                   7437: <p>Users can be created by adding entries to the
                   7438: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7439: syntax:</p>
                   7440: <pre class="programlisting">
                   7441: user:group
                   7442: </pre>
                   7443: <p>Further specification of user details may be done by setting
                   7444: per-user variables.
                   7445: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7446: numeric UID for the user.
                   7447: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7448: user's description or comment.
                   7449: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7450: user's home directory, and defaults to
                   7451: <code class="filename">/nonexistent</code> if not specified.
                   7452: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7453: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7454: not specified.</p>
                   7455: <p>Similarly, groups can be created by adding entries to the
                   7456: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7457: <pre class="programlisting">
                   7458: group
                   7459: </pre>
                   7460: <p>The numeric GID of the group may be set by defining
                   7461: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7462: <p>If a package needs to create the users and groups at an earlier
                   7463: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7464: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7465: <code class="literal">pre-install</code> to indicate the phase before which the
                   7466: users and groups are created. In this case, the numeric UIDs and GIDs
                   7467: of the created users and groups are automatically hardcoded into the
                   7468: final installation scripts.</p>
1.75      rillig   7469: </div>
1.148     asau     7470: <div class="sect1">
1.75      rillig   7471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7472: <a name="shells"></a>20.5. System shells</h2></div></div></div>
1.299     rillig   7473: <p>Packages that install system shells should register them in the shell
                   7474: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7475: administrator.  This must be done from the installation scripts to keep
                   7476: binary packages working on any system.  pkginstall provides an easy way to
                   7477: accomplish this task.</p>
                   7478: <p>When a package provides a shell interpreter, it has to set the
                   7479: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7480: add some hooks to the installation scripts to handle it.  Consider the
1.322     leot     7481: 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   7482: <pre class="programlisting">
                   7483: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7484: </pre>
                   7485: <div class="sect2">
                   7486: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7487: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
1.299     rillig   7488: <p>The automatic registration of shell interpreters can be disabled by
                   7489: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7490: environment variable to <code class="literal">NO</code>.</p>
                   7491: </div>
1.75      rillig   7492: </div>
1.148     asau     7493: <div class="sect1">
1.75      rillig   7494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7495: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
1.299     rillig   7496: <p>Packages that install X11 fonts should update the database files
                   7497: that index the fonts within each fonts directory.  This can easily be
                   7498: accomplished within the pkginstall framework.</p>
                   7499: <p>When a package installs X11 fonts, it must list the directories in
                   7500: which fonts are installed in the
                   7501: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.385     leot     7502: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
                   7503: <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   7504: installation scripts to run the appropriate commands to update the fonts
                   7505: database files within each of those directories.  For convenience, if the
                   7506: directory path is relative, it is taken to be relative to the package's
1.322     leot     7507: 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   7508: <pre class="programlisting">
1.299     rillig   7509: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7510: </pre>
1.299     rillig   7511: <div class="sect2">
                   7512: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7513: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.299     rillig   7514: <p>The automatic update of fonts databases can be disabled by
                   7515: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7516: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7517: </div>
                   7518: </div>
                   7519: </div>
1.148     asau     7520: <div class="chapter">
1.75      rillig   7521: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     7522: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7523: <div class="toc">
                   7524: <p><b>Table of Contents</b></p>
1.210     leot     7525: <dl class="toc">
1.267     rillig   7526: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7527: <dd><dl>
1.267     rillig   7528: <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>
                   7529: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7530: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7531: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7532: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7533: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7534: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7535: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7536: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7537: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7538: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7539: </dl></dd>
                   7540: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7541: <dd><dl>
                   7542: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7543: <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>
                   7544: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7545: </dl></dd>
                   7546: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7547: <dd><dl>
                   7548: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7549: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7550: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338     nia      7551: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.379     wiz      7552: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.267     rillig   7553: </dl></dd>
                   7554: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7555: <dd><dl>
                   7556: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7557: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320     wiz      7558: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338     nia      7559: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
                   7560: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
                   7561: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
                   7562: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267     rillig   7563: </dl></dd>
                   7564: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7565: <dd><dl>
                   7566: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7567: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7568: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.385     leot     7569: <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   7570: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7571: </dl></dd>
                   7572: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7573: <dd><dl>
                   7574: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7575: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7576: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7577: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7578: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318     nia      7579: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369     wiz      7580: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
                   7581: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
                   7582: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
                   7583: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
                   7584: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
                   7585: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
                   7586: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
                   7587: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
                   7588: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
                   7589: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87      wiz      7590:     emulation</a></span></dt>
1.369     wiz      7591: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
                   7592: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.75      rillig   7593: </dl></dd>
1.267     rillig   7594: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7595: </dl>
                   7596: </div>
1.148     asau     7597: <div class="sect1">
1.75      rillig   7598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     7599: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7600: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7601:   different platforms. As a result, it is important to ensure,
                   7602:   where possible, that packages in pkgsrc are portable. This
                   7603:   chapter mentions some particular details you should pay
                   7604:   attention to while working on pkgsrc.</p>
1.148     asau     7605: <div class="sect2">
1.78      rillig   7606: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7607: <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   7608: </h3></div></div></div>
1.78      rillig   7609: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7610:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7611:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7612:     want to use those variables in the preprocessor directives of
1.378     leot     7613:     <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      7614:     <code class="literal">.for</code>), you need to include the file
                   7615:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7616:     loads the user preferences.</p>
1.78      rillig   7617: <p>But note that some variables may not be completely defined
1.219     rillig   7618:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7619:     included, as they may contain references to variables that are
                   7620:     not yet defined. In shell commands (the lines in
                   7621:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7622:     is no problem, since variables are only expanded when they are
                   7623:     used. But in the preprocessor directives mentioned above and in
                   7624:     dependency lines (of the form <code class="literal">target:
                   7625:     dependencies</code>) the variables are expanded at load
                   7626:     time.</p>
1.148     asau     7627: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7628: <h3 class="title">Note</h3>
1.218     rillig   7629: <p>To check whether a variable can be used at load time,
                   7630:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7631: </div>
                   7632: </div>
1.148     asau     7633: <div class="sect2">
1.78      rillig   7634: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7635: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7636: <p>Occasionally, packages require interaction from the user,
                   7637:     and this can be in a number of ways:</p>
1.148     asau     7638: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7639: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7640:        interaction such as entering username/password or accepting a
                   7641:        license on a web page.</p></li>
1.128     wiz      7642: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7643:        passwords.</p></li>
1.128     wiz      7644: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7645: <li class="listitem"><p>help during the build process</p></li>
                   7646: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7647: </ul></div>
1.218     rillig   7648: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7649:     variable to define which stages need interaction. This should be
                   7650:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7651: <pre class="programlisting">
1.100     rillig   7652: INTERACTIVE_STAGE=      configure install
1.222     sevan    7653: </pre>
1.88      wiz      7654: <p>The user can then decide to skip this package by setting the
1.218     rillig   7655:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7656:     are also excluded from bulk builds.</p>
1.75      rillig   7657: </div>
1.148     asau     7658: <div class="sect2">
1.75      rillig   7659: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7660: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7661: <p>Authors of software can choose the licence under which software
                   7662:     can be copied.  The Free Software Foundation has declared some
                   7663:     licenses "Free", and the Open Source Initiative has a definition of
                   7664:     "Open Source".</p>
                   7665: <p>By default, pkgsrc allows packages with Free or Open Source
                   7666:     licenses to be built.  To allow packages with other licenses to be
                   7667:     built as well, the pkgsrc user needs to add these licenses to the
                   7668:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7669:     that this variable only affects which packages may be
                   7670:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7671:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7672: <p>One might want to only install packages with a BSD license,
1.218     rillig   7673:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7674:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7675:     user can override the default by setting the
                   7676:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7677:     of "+=".  The licenses accepted by default are defined in the
                   7678:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7679:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7680: <p>The license tag mechanism is intended to address
1.87      wiz      7681:     copyright-related issues surrounding building, installing and
                   7682:     using a package, and not to address redistribution issues (see
                   7683:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7684:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7685:     Packages with redistribution restrictions should set these
                   7686:     tags.</p>
1.98      wiz      7687: <p>Denoting that a package may be copied according to a
                   7688:     particular license is done by placing the license in
1.87      wiz      7689:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7690:     <code class="varname">LICENSE</code> variable to a string identifying the
1.322     leot     7691:     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      7692: <pre class="programlisting">
1.100     rillig   7693: LICENSE=        xv-license
1.222     sevan    7694: </pre>
1.87      wiz      7695: <p>When trying to build, the user will get a notice that the
1.98      wiz      7696:     package is covered by a license which has not been placed in the
                   7697:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7698: <pre class="programlisting">
1.100     rillig   7699: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7700: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7701: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7702: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7703: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7704: *** Error code 1
1.222     sevan    7705: </pre>
1.379     wiz      7706: <p>In case a package requires multiple licenses, you can add all of
                   7707:     them to the LICENSE variable, connected with the upper-case keyword
                   7708:     <code class="varname">AND</code>. If the user has a choice between multiple
                   7709:     licenses, you can add them connected with the upper-case keyword
                   7710:     <code class="varname">OR</code>, for example:</p>
                   7711: <pre class="programlisting">
                   7712: LICENSE=        isc AND apache-2.0
                   7713: LICENSE=        2-clause-bsd OR ruby-license
                   7714: </pre>
1.110     hubertf  7715: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7716:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7717:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7718:     convey to pkgsrc that it should not in the future fail because of
                   7719:     that license:</p>
1.78      rillig   7720: <pre class="programlisting">
1.100     rillig   7721: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7722: </pre>
                   7723: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7724:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7725:     is deprecated because it does not crisply refer to a particular
                   7726:     license text.  Another problem with such usage is that it does not
                   7727:     enable a user to tell pkgsrc to proceed for a single package
                   7728:     without also telling pkgsrc to proceed for all packages with that
                   7729:     tag.</p>
                   7730: <div class="sect3">
                   7731: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     7732: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7733: <p>When adding a package with a new license, the following steps
                   7734:     are required:</p>
                   7735: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7736: <li class="listitem">
1.284     rillig   7737: <p>Check whether the license qualifies as Free or Open Source by
                   7738:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7739:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7740:     Open Source Initiative</a>.  If this is the case, the filename in
                   7741:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7742:     <code class="filename">-license</code> suffix, and the license name should be
                   7743:     added to:</p>
1.154     rodent   7744: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7745: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7746:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7747: <li class="listitem"><p>default_acceptable_licenses in
                   7748:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7749: </ul></div>
                   7750: </li>
1.284     rillig   7751: <li class="listitem"><p>The license text should be added to
                   7752:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7753:     licenses can be seen in this directory.</p></li>
1.154     rodent   7754: </ol></div>
1.222     sevan    7755: </div>
                   7756: <div class="sect3">
                   7757: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     7758: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7759: <p>When the license changes (in a way other than formatting),
1.222     sevan    7760:     make sure that the new license has a different name (e.g.,
1.98      wiz      7761:     append the version number if it exists, or the date).  Just
                   7762:     because a user told pkgsrc to build programs under a previous
                   7763:     version of a license does not mean that pkgsrc should build
1.99      rillig   7764:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7765:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7766:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7767:     approved by either of two bodies (FSF or OSI).</p>
                   7768: </div>
1.75      rillig   7769: </div>
1.148     asau     7770: <div class="sect2">
1.75      rillig   7771: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7772: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7773: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7774:     By declaring the restrictions, package tools can
1.98      wiz      7775:     automatically refrain from e.g. placing binary packages on FTP
                   7776:     sites.</p>
1.222     sevan    7777: <p>There are four possible restrictions, which are
1.98      wiz      7778:     the cross product of sources (distfiles) and binaries not being
                   7779:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7780:     language in any license, and because non-Free licenses tend to be
                   7781:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7782:     CD-ROM.
                   7783: 
                   7784:     "FTP" means making the source or binary file available over the
                   7785:     Internet at no charge.
                   7786: 
                   7787:     "CD-ROM" means making the source or binary available on some kind of
                   7788:     media, together with other source and binary packages, which is sold
                   7789:     for a distribution charge.
1.98      wiz      7790:     </p>
                   7791: <p>In order to encode these restrictions, the package system
1.87      wiz      7792:     defines five make variables that can be set to note these
                   7793:     restrictions:</p>
1.148     asau     7794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7795: <li class="listitem">
1.75      rillig   7796: <p><code class="varname">RESTRICTED</code></p>
                   7797: <p>This variable should be set whenever a restriction
1.87      wiz      7798:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7799:        string containing the reason for the restriction.  It should
                   7800:        be understood that those wanting to understand the restriction
                   7801:        will have to read the license, and perhaps seek advice of
                   7802:        counsel.</p>
1.75      rillig   7803: </li>
1.128     wiz      7804: <li class="listitem">
1.75      rillig   7805: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7806: <p>Binaries may not be placed on CD-ROM containing other
                   7807:        binary packages, for which a distribution charge may be made.
                   7808:        In this case, set this variable to
                   7809:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7810: </li>
1.128     wiz      7811: <li class="listitem">
1.75      rillig   7812: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7813: <p>Binaries may not made available on the Internet without
                   7814:        charge.  In this case, set this variable to
                   7815:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7816:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7817: </li>
1.128     wiz      7818: <li class="listitem">
1.75      rillig   7819: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7820: <p>Distfiles may not be placed on CD-ROM, together with
                   7821:        other distfiles, for which a fee may be charged.  In this
                   7822:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7823:        </p>
1.75      rillig   7824: </li>
1.128     wiz      7825: <li class="listitem">
1.75      rillig   7826: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7827: <p>Distfiles may not made available via FTP at no charge.
                   7828:        In this case, set this variable to
                   7829:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7830:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7831: </li>
                   7832: </ul></div>
1.222     sevan    7833: <p>Please note that packages will be removed from pkgsrc when the
                   7834:     distfiles are not distributable and cannot be obtained for a period
                   7835:     of one full quarter branch. Packages with manual/interactive fetch
                   7836:     must have a maintainer and it is his/her responsibility to ensure
                   7837:     this.</p>
1.75      rillig   7838: </div>
1.148     asau     7839: <div class="sect2">
1.75      rillig   7840: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7841: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7842: <p>Your package may depend on some other package being present,
                   7843:     and there are various ways of expressing this dependency.
                   7844:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7845:     <code class="varname">BUILD_DEPENDS</code>,
                   7846:     <code class="varname">TOOL_DEPENDS</code>, and
                   7847:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7848:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7849:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7850:     to handle dependencies, and which uses the variables named above.
1.385     leot     7851:     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 7852: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7853:     definition registers that pre-requisite in the binary package so it
                   7854:     will be pulled in when the binary package is later installed, whilst
                   7855:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7856:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7857:     dependency that is only needed for building or testing the resulting
1.385     leot     7858:     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   7859: <p>This means that if you only need a package present whilst
1.290     gutterid 7860:     you are building or testing, it should be noted as a
                   7861:     <code class="varname">TOOL_DEPENDS</code>,
                   7862:     <code class="varname">BUILD_DEPENDS</code>, or
                   7863:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7864:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7865:     packages, i.e. packages for the architecture where the package
                   7866:     is built;
                   7867:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7868:     packages, i.e., packages for the architecture for which the package
1.269     leot     7869:     is built.</p>
1.290     gutterid 7870: <p>The format for a <code class="varname">DEPENDS</code>,
                   7871:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7872:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7873: <pre class="programlisting">
1.100     rillig   7874: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7875: </pre>
1.385     leot     7876: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87      wiz      7877:     may include any of the wildcard version numbers recognized by
1.378     leot     7878:     <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      7879: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7880: <li class="listitem">
1.75      rillig   7881: <p>If your package needs another package's binaries or
1.160     wiz      7882:        libraries to build and run, and if that package has a
1.87      wiz      7883:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7884: <pre class="programlisting">
1.100     rillig   7885: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7886: </pre>
1.75      rillig   7887: </li>
1.128     wiz      7888: <li class="listitem">
1.160     wiz      7889: <p>If your package needs another package's binaries or
                   7890:        libraries only for building, and if that package has a
                   7891:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7892: <pre class="programlisting">
                   7893: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7894: </pre>
1.160     wiz      7895: <p>but set
                   7896:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7897:        to make it a build dependency only. This case is rather
                   7898:        rare.</p>
                   7899: </li>
                   7900: <li class="listitem">
1.132     spz      7901: <p>If your package needs binaries from another package to build,
1.269     leot     7902:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7903: <pre class="programlisting">
1.269     leot     7904: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7905: </pre>
1.75      rillig   7906: </li>
1.269     leot     7907: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7908:        files to include, etc. from another package to build,
                   7909:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7910: <li class="listitem"><p>If your package needs a library with which to link and
                   7911:        there is no <code class="filename">buildlink3.mk</code> file
                   7912:        available, create one. Using
                   7913:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7914:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7915: <li class="listitem">
1.132     spz      7916: <p>If your package needs some executable to be able to run
                   7917:        correctly and if there's no
                   7918:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7919:        using the <code class="varname">DEPENDS</code> variable. The
1.322     leot     7920:        <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      7921:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7922:        when it runs, and that is specified:</p>
1.75      rillig   7923: <pre class="programlisting">
1.242     wiz      7924: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7925: </pre>
1.132     spz      7926: </li>
1.290     gutterid 7927: <li class="listitem"><p>If your package includes a test suite that has extra
                   7928:         dependencies only required for this purpose (frequently this
1.385     leot     7929:         can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
1.290     gutterid 7930:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7931: <li class="listitem">
                   7932: <p>You can use wildcards in package dependencies. Note that
                   7933:        such wildcard dependencies are retained when creating binary
                   7934:        packages. The dependency is checked when installing the binary
                   7935:        package and any package which matches the pattern will be
                   7936:        used. Wildcard dependencies should be used with care.</p>
1.385     leot     7937: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
                   7938:        <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
                   7939:        such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
                   7940:        <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7941: <p>Wildcards can also be used to specify that a package
1.87      wiz      7942:        will only build against a certain minimum version of a
                   7943:        pre-requisite:</p>
1.75      rillig   7944: <pre class="programlisting">
1.132     spz      7945: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7946: </pre>
1.132     spz      7947: <p>This means that the package will build using version 6.0
                   7948:        of ImageMagick or newer. Such a dependency may be warranted
                   7949:        if, for example, the command line options of an executable
                   7950:        have changed.</p>
                   7951: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7952:        set
                   7953:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7954:        to the appropriate pattern before including its
                   7955:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7956: <pre class="programlisting">
                   7957: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7958: .include "../../graphics/jpeg/buildlink3.mk"
                   7959: </pre>
1.75      rillig   7960: <p>For security fixes, please update the package
1.385     leot     7961:        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      7962:        information.</p>
1.75      rillig   7963: </li>
                   7964: </ol></div>
                   7965: <p>If your package needs files from another package to build,
1.87      wiz      7966:     add the relevant distribution files to
                   7967:     <code class="varname">DISTFILES</code>, so they will be extracted
1.322     leot     7968:     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      7969:     (It relies on the jpeg sources being present in source form
                   7970:     during the build.)</p>
1.75      rillig   7971: </div>
1.148     asau     7972: <div class="sect2">
1.75      rillig   7973: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     7974: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341     gutterid 7975: <p>Your package may conflict with other packages users might
                   7976:     already have installed on their system, e.g., if your package
1.88      wiz      7977:     installs the same set of files as another package in the pkgsrc
1.342     wiz      7978:     tree.</p>
1.322     leot     7979: <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>
                   7980:     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     7981:     install the same shared library, thus you set in
                   7982:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7983: <pre class="programlisting">
                   7984: CONFLICTS=      Xaw-Xpm-[0-9]*
1.352     wiz      7985: </pre>
1.255     leot     7986: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7987: <pre class="programlisting">
                   7988: CONFLICTS=      libXaw3d-[0-9]*
1.352     wiz      7989: </pre>
1.378     leot     7990: <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     7991:     that conflict with existing packages and abort. However, in many
                   7992:     situations this is too late in the process. Binary package managers
                   7993:     will not know about the conflict until they attempt to install the
                   7994:     package after already downloading it and all its dependencies.
                   7995:     Users may also waste time building a package and its dependencies
                   7996:     only to find out at the end that it conflicts with another package
                   7997:     they have installed.</p>
                   7998: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7999:     should be added in all cases where it is known that packages conflict
                   8000:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.378     leot     8001:     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     8002:     managers to inform users that packages cannot be installed onto
                   8003:     the target system.</p>
1.75      rillig   8004: </div>
1.148     asau     8005: <div class="sect2">
1.75      rillig   8006: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8007: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8008: <p>There are several reasons why a package might be
1.88      wiz      8009:     instructed to not build under certain circumstances.  If the
1.87      wiz      8010:     package builds and runs on most platforms, the exceptions
1.193     dholland 8011:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   8012:     the package builds and runs on a small handful of platforms,
                   8013:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   8014:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   8015:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   8016:     (OS-version-platform) that can use glob-style
                   8017:     wildcards.</p>
                   8018: <p>If a package is not appropriate for some platforms (as
1.225     maya     8019:     opposed to merely broken), a different set of variables should be
1.193     dholland 8020:     used as this affects failure reporting and statistics.
                   8021:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      8022:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 8023:     the package is appropriate for only a small handful of platforms
                   8024:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      8025:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8026:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8027:     (OS-version-platform) that can use glob-style
                   8028:     wildcards.</p>
1.88      wiz      8029: <p>Some packages are tightly bound to a specific version of an
1.322     leot     8030:     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      8031:     backwards compatible with other versions of the OS, and should be
                   8032:     uploaded to a version specific directory on the FTP server.  Mark
                   8033:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.385     leot     8034:     <span class="quote">“<span class="quote">yes</span>”</span>.  This variable is not currently used by any of
1.88      wiz      8035:     the package system internals, but may be used in the
                   8036:     future.</p>
1.75      rillig   8037: <p>If the package should be skipped (for example, because it
1.87      wiz      8038:     provides functionality already provided by the system), set
1.88      wiz      8039:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8040:     the package should fail because some preconditions are not met,
                   8041:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8042:     message.</p>
1.75      rillig   8043: </div>
1.148     asau     8044: <div class="sect2">
1.75      rillig   8045: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8046: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8047: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8048:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8049:     be set in the package Makefile. This will be carried into any
                   8050:     binary package that is made from this pkgsrc entry. A
1.385     leot     8051:     <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.378     leot     8052:     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     8053:     <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75      rillig   8054: </div>
1.148     asau     8055: <div class="sect2">
1.75      rillig   8056: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8057: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8058: <p>When a vulnerability is found, this should be noted in
1.361     wiz      8059:     <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.320     wiz      8060:     Entries in that file consist of three parts:</p>
                   8061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8062: <li class="listitem"><p>package version pattern</p></li>
                   8063: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
                   8064: <li class="listitem"><p>URL providing additional information about the issue</p></li>
                   8065: </ul></div>
                   8066: <p>For the package version pattern please always use `&lt;' to
                   8067:     mark an upper bound (not `&lt;='!). This will avoid possible
                   8068:     problems due unrelated <code class="varname">PKGREVISION</code> bumps not
                   8069:     related to security fixes. Lower bounds can be added too, using
                   8070:     '&gt;' or '&gt;='. For example,
1.385     leot     8071:     <span class="quote">“<span class="quote"><code class="literal">foo&gt;=1&lt;1.2</code></span>”</span> would mark
1.320     wiz      8072:     versions 1.0 (included) to 1.2 (excluded) of
1.385     leot     8073:     <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
1.320     wiz      8074:     issue.</p>
                   8075: <p>Entries should always be added at the bottom of the file.</p>
                   8076: <p>When fixing packages, please modify the upper bound of the
                   8077:     corresponding entry. To continue the previous example, if a fix
                   8078:     was backported to version 1.1nb2, change the previous pattern to
1.385     leot     8079:     <span class="quote">“<span class="quote"><code class="literal">foo&gt;=1&lt;1.1nb2</code></span>”</span>.</p>
1.320     wiz      8080: <p>To locally test a package version pattern against a
                   8081:     <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
                   8082:     pmatch</strong></span> command.</p>
                   8083: <p>The URL should be as permanent as possible and provide as
                   8084:     much information about the issue as possible.  CVE entries are
                   8085:     preferred.</p>
                   8086: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138     wiz      8087:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   8088: <p>After fixing the vulnerability by a patch, its
1.138     wiz      8089:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8090:     course not necessary if the problem is fixed by using a newer
                   8091:     release of the software), and the pattern in the
                   8092:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   8093: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8094:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8095: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8096:     semi-automatically by a weekly cron job.</p>
1.320     wiz      8097: <p>In case a security issue is disputed, please contact
                   8098:     pkgsrc-security@NetBSD.org.</p>
1.75      rillig   8099: </div>
1.148     asau     8100: <div class="sect2">
1.75      rillig   8101: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8102: <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   8103: <p>When making fixes to an existing package it can be useful
1.87      wiz      8104:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8105:     avoid conflicting with future versions by the original author, a
1.385     leot     8106:     <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      8107:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.385     leot     8108:     (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
                   8109:     <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87      wiz      8110: <pre class="programlisting">
1.100     rillig   8111: DISTNAME=       foo-17.42
                   8112: PKGREVISION=    9
1.222     sevan    8113: </pre>
1.75      rillig   8114: <p>will result in a <code class="varname">PKGNAME</code> of
1.385     leot     8115:     <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
                   8116:     value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87      wiz      8117:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8118:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8119: <p>When a new release of the package is released, the
1.87      wiz      8120:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8121:     minor release of the above package, things should be like:</p>
1.75      rillig   8122: <pre class="programlisting">
1.100     rillig   8123: DISTNAME=       foo-17.43
1.222     sevan    8124: </pre>
1.87      wiz      8125: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8126:     non-trivial change in the resulting binary package.  Without a
                   8127:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8128:     version installed has no way of knowing that their package is out
                   8129:     of date.  Thus, changes without increasing
                   8130:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8131:     trivial that no reasonable person would want to upgrade", and this
                   8132:     is the rough test for when increasing
                   8133:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8134:     changes that do not merit increasing
                   8135:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     8136: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8137: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.392     wiz      8138:       <code class="varname">MAINTAINER</code>, or
1.284     rillig   8139:       comments in Makefile.</p></li>
                   8140: <li class="listitem"><p>Changing build variables if the resulting binary
                   8141:       package is the same.</p></li>
                   8142: <li class="listitem"><p>Changing
                   8143:       <code class="filename">DESCR</code>.</p></li>
                   8144: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   8145:       default options don't change.</p></li>
1.100     rillig   8146: </ul></div>
1.87      wiz      8147: <p>Examples of changes that do merit an increase to
                   8148:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     8149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   8150: <li class="listitem"><p>Security fixes</p></li>
                   8151: <li class="listitem"><p>Changes or additions to a patch
                   8152:       file</p></li>
                   8153: <li class="listitem"><p>Changes to the
                   8154:       <code class="filename">PLIST</code></p></li>
                   8155: <li class="listitem"><p>A dependency is changed or
                   8156:       renamed.</p></li>
1.100     rillig   8157: </ul></div>
1.78      rillig   8158: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8159:     changes.</p>
1.75      rillig   8160: </div>
1.148     asau     8161: <div class="sect2">
1.79      rillig   8162: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8163: <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   8164: <p>When you want to replace the same text in multiple files, or
                   8165: multiple times in the same file, it is cumbersome to maintain a patch
                   8166: file for this. This is where the SUBST framework steps in. It provides an
                   8167: easy-to-use interface for replacing text in files. It just needs the
                   8168: following information:</p>
                   8169: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8170: <li class="listitem"><p>In which phase of the package build cycle should the
                   8171: replacement happen?</p></li>
                   8172: <li class="listitem"><p>In which files should the replacement
1.287     rillig   8173: happen?</p></li>
1.295     rillig   8174: <li class="listitem"><p>Which text should be replaced with
                   8175: what?</p></li>
1.287     rillig   8176: </ul></div>
                   8177: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   8178: variables. A minimal example is:</p>
                   8179: <pre class="programlisting">
                   8180: SUBST_CLASSES+=         paths
                   8181: SUBST_STAGE.paths=      pre-configure
                   8182: SUBST_FILES.paths=      src/*.c
                   8183: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   8184: </pre>
                   8185: <p>Translated into English, it means: In the pre-configure stage (that
                   8186: is, after applying the patches from the patches/ directory and before
                   8187: running the configure script and the portability check), replace the text
                   8188: <code class="literal">/usr/local</code> with the content of the variable
                   8189: <code class="varname">PREFIX</code>.</p>
                   8190: <p>Each SUBST block starts by appending an identifier to
                   8191: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   8192: identifier can be chosen freely by the package. If there should ever be
                   8193: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   8194: early, so don't worry about name collisions.</p>
                   8195: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   8196: SUBST block are parameterized using this identifier. In the remainder of
                   8197: this section, these parameterized variables are written as
                   8198: <code class="varname">SUBST_STAGE.*</code>.</p>
                   8199: <pre class="programlisting">
                   8200: SUBST_CLASSES+=         paths
                   8201: SUBST_STAGE.paths=      pre-configure
                   8202: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   8203: SUBST_FILES.paths=      src/*.c
                   8204: SUBST_FILES.paths+=     scripts/*.sh
                   8205: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   8206: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   8207: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   8208: </pre>
                   8209: <p>To get a complete picture about the SUBST substitutions, run
                   8210: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   8211: expected, run pkglint on the package, which detects several typical
                   8212: mistakes surrounding the SUBST blocks. For any questions that might
                   8213: remain after this, have a look at
                   8214: <code class="filename">mk/subst.mk</code>.</p>
                   8215: <div class="sect3">
                   8216: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8217: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
1.295     rillig   8218: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   8219: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   8220: <code class="literal">pre-configure</code> is used most often, by far. The most
                   8221: popular stages are, in chronological order:</p>
                   8222: <div class="variablelist"><dl class="variablelist">
                   8223: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   8224: <dd>
                   8225: <p>The substitutions are applied immediately after the
                   8226: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   8227: package will leave no traces of the original files.</p>
                   8228: <p>When the substitution applies to files for which there is also a
                   8229: patch in the <code class="filename">patches/</code> directory, this means that the
                   8230: patches will be computed based on the result of the substitution. When
                   8231: these patches are sent to the upstream maintainer later, to be fixed in
                   8232: the upstream package, these patches may no longer match what the upstream
                   8233: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   8234: often a better choice.</p>
                   8235: </dd>
                   8236: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   8237: <dd>
                   8238: <p>The substitutions are applied after the patches from the
                   8239: <code class="filename">patches/</code> directory. This makes it possible to run
                   8240: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322     leot     8241: 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   8242: <p>When updating the patches, it is helpful to explicitly separate the
                   8243: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   8244: configure</strong></span>, and to only edit the patches between these commands.
                   8245: Otherwise the substitutions from the SUBST block will end up in the patch
                   8246: file. When this happens in really obvious ways, pkglint will complain
                   8247: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   8248: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   8249: can only detect these really obvious
                   8250: cases.</p>
                   8251: </dd>
                   8252: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   8253: <dd><p>This stage should only be used if the package defines a
                   8254: <code class="literal">pre-configure</code> action itself, and the substitution must
                   8255: happen after that. Typical examples are packages that use the
                   8256: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   8257: script from
                   8258: <code class="filename">configure.ac</code>.</p></dd>
                   8259: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   8260: <dd><p>This stage is used to fix up any mistakes by the
                   8261: configure stage.</p></dd>
                   8262: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   8263: <dd><p>This stage should only be used for substitutions that are
                   8264: clearly related to building the package, not for fixing the
                   8265: configuration. Substitutions for pathnames (such as replacing
                   8266: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   8267: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   8268: actual username) belong in pre-configure or post-configure
                   8269: instead.</p></dd>
                   8270: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   8271: <dd>
                   8272: <p>Just as with pre-build, this stage should only be used
                   8273: for substitutions that are clearly related to building the package, not
                   8274: for fixing the configuration. Substitutions for pathnames (such as
                   8275: replacing <code class="filename">/usr/local</code> with
                   8276: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   8277: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   8278: pre-configure or post-configure instead.</p>
                   8279: <p>A typical use is to update pkg-config files to include the rpath
                   8280: compiler options.</p>
                   8281: </dd>
                   8282: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   8283: <dd><p>In general, the install phase should be as simple as
                   8284: possible. As with the pre-build and post-build stages, it should not be
                   8285: used to fix pathnames or user names, these belong in pre-configure
                   8286: instead. There are only few legitimate use cases for applying
                   8287: substitutions in this stage.</p></dd>
                   8288: </dl></div>
                   8289: </div>
                   8290: <div class="sect3">
                   8291: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8292: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   8293: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   8294: filename patterns. These patterns are relative to
                   8295: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   8296: A typical example is:</p>
                   8297: <pre class="programlisting">
                   8298: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   8299: </pre>
                   8300: <p>The above patterns, especially the last, are quite broad. The SUBST
                   8301: implementation checks that each filename pattern that is mentioned here
                   8302: has an effect. For example, if none of the
                   8303: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   8304: and substituted, that filename pattern is redundant and should be left
1.296     rillig   8305: out. By default, the SUBST framework will complain with an error message.
                   8306: If the text to be substituted occurs in some of the files from a single
                   8307: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   8308: framework will only print an INFO message for those files.</p>
                   8309: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   8310: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   8311: <p>Another popular way of choosing the files for the substitutions is
                   8312: via a shell command, like this:</p>
                   8313: <pre class="programlisting">
1.296     rillig   8314: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8315: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8316: </pre>
                   8317: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8318: freely chosen and independent of the SUBST framework.</p>
                   8319: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8320: lists each file individually. Thereby chances are higher that there are
                   8321: filename patterns in which no substitution happens. Since the SUBST
                   8322: framework cannot know whether the filename patterns in
                   8323: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8324: Makefile (where any redundant filename pattern would be suspicious) or
                   8325: been generated by a shell command (in which redundant filename patterns
                   8326: are more likely and to be expected), it will complain about these
                   8327: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8328: command to generate the list of filename patterns often need to set
                   8329: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8330: </div>
                   8331: <div class="sect3">
                   8332: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8333: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
1.295     rillig   8334: <p>In most cases, the substitutions are given using one or more
1.378     leot     8335: <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   8336: <pre class="programlisting">
                   8337: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8338: </pre>
                   8339: <p>Each of the sed commands needs to be preceded by the
                   8340: <code class="literal">-e</code> option and should be specified on a line of its
                   8341: own, to avoid hiding short sed commands at the end of a line.</p>
                   8342: <p>Since the sed commands often contain shell metacharacters as the
                   8343: separator (the <code class="literal">|</code> in the above example), it is common
                   8344: to enclose them in single quotes.</p>
                   8345: <p>A common substitution is to replace placeholders of the form
                   8346: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8347: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8348: <pre class="programlisting">
                   8349: SUBST_VARS.path=        PREFIX
                   8350: </pre>
                   8351: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8352: scripts during the do-configure stage, but in some cases these need to be
                   8353: overridden. The same pattern is also used when a package defines patches
                   8354: that replace previously hard-coded paths like
                   8355: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8356: placeholder first, which then gets substituted by the actual
                   8357: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8358: cases, it works equally well to just use the SUBST framework to directly
                   8359: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8360: thereby omitting the intermediate patch file.</p>
1.295     rillig   8361: <p>If the above is not flexible enough, it is possible to not use sed
                   8362: at all for the substitution but to specify an entirely different command,
                   8363: like this:</p>
1.87      wiz      8364: <pre class="programlisting">
1.295     rillig   8365: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8366: </pre>
                   8367: <p>This is used for the few remaining packages in which the
                   8368: distributed files use Windows-style line endings that need to be
                   8369: converted to UNIX-style line endings.</p>
                   8370: </div>
                   8371: <div class="sect3">
                   8372: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8373: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
1.295     rillig   8374: <p>When a SUBST block is applied during a package build, a message is
                   8375: logged. The default message is fine for most purposes but can be
                   8376: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8377: message.</p>
                   8378: </div>
1.79      rillig   8379: </div>
1.75      rillig   8380: </div>
1.148     asau     8381: <div class="sect1">
1.75      rillig   8382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8383: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8384: <div class="sect2">
1.75      rillig   8385: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8386: <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   8387: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8388:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8389:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8390:     with the name of each file to download as an argument, expecting
                   8391:     it to output the URL of the directory from which to download
1.322     leot     8392:     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      8393:     example of this usage.</p>
1.75      rillig   8394: <p>If the download can't be automated, because the user must
1.87      wiz      8395:     submit personal information to apply for a password, or must pay
                   8396:     for the source, or whatever, you can set
                   8397:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8398:     displayed to the user before aborting the build. Example:</p>
                   8399: <pre class="programlisting">
1.100     rillig   8400: FETCH_MESSAGE=  "Please download the files"
                   8401: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8402: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8403: </pre>
1.75      rillig   8404: </div>
1.148     asau     8405: <div class="sect2">
1.75      rillig   8406: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8407: <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   8408: <p>Sometimes authors of a software package make some
1.87      wiz      8409:     modifications after the software was released, and they put up a
                   8410:     new distfile without changing the package's version number. If a
                   8411:     package is already in pkgsrc at that time, the checksum will
                   8412:     no longer match. The contents of the new distfile should be
                   8413:     compared against the old one before changing anything, to make
                   8414:     sure the distfile was really updated on purpose, and that
                   8415:     no trojan horse or so crept in.
1.97      rillig   8416:     Please mention that the distfiles were compared and what was found
1.159     rodent   8417:     in your commit message.</p>
1.220     wiz      8418: <p>Then, the correct way to work around this is to set
                   8419:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8420:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8421:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8422:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8423:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.385     leot     8424:     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      8425:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8426:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8427:     be appended, like
                   8428:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8429: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8430:     name does not contain a version and the distfile is apt to change. In
                   8431:     cases where the likelihood of this is very small,
                   8432:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8433:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8434:     distfile name changes, even if a package is being moved or
                   8435:     renamed.</p>
1.159     rodent   8436: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8437:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8438:     path in the filenames.
1.159     rodent   8439:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8440:     Furthermore, a mail to the package's authors seems appropriate
                   8441:     telling them that changing distfiles after releases without
                   8442:     changing the file names is not good practice.</p>
1.75      rillig   8443: </div>
1.199     tnn      8444: <div class="sect2">
                   8445: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8446: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8447: <p>Helper methods exist for packages hosted on github.com which
                   8448:     will often have distfile names that clash with other packages, for
                   8449:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8450:     from below:</p>
1.199     tnn      8451: <div class="sect3">
                   8452: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8453: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8454: <p>If your distfile URL looks similar to
1.303     bacon    8455:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8456:       then you are packaging a tagged release.</p>
1.199     tnn      8457: <pre class="programlisting">
1.303     bacon    8458: DISTNAME=       example-1.0
1.200     tnn      8459: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8460: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8461: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8462: EXTRACT_SUFX=   .zip
                   8463: </pre>
1.345     gutterid 8464: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
                   8465:     file fetching infrastructure to save the resulting file locally as
                   8466:     <code class="literal">example-1.0.zip</code>.</p>
1.199     tnn      8467: </div>
                   8468: <div class="sect3">
                   8469: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8470: <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    8471: <p>If your distfile looks similar to
                   8472:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8473:       release, then set the package version to 0.0.0.N, where N is the number
                   8474:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8475:       This will (almost) ensure that the first tagged release will have a
                   8476:       version greater than this one so that package upgrades will function
                   8477:       properly.</p>
                   8478: <pre class="programlisting">
                   8479: DISTNAME=       example-0.0.0.347
                   8480: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8481: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8482: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8483: </pre>
                   8484: </div>
                   8485: <div class="sect3">
                   8486: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8487: <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    8488: <p>If your distfile looks similar to
                   8489:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8490:       then include the last release version and the commit count since that
                   8491:       release in the package version and set GITHUB_TAG to the commit hash.
                   8492:       The latest release and commit count are shown in the output of
                   8493:       "git describe --tags":
                   8494:       </p>
                   8495: <pre class="screen">
                   8496: # git clone https://github.com/username/example
                   8497: # cd example
                   8498: # git describe --tags
                   8499: 1.2.3-5-g988881a
                   8500: </pre>
1.199     tnn      8501: <pre class="programlisting">
1.303     bacon    8502: DISTNAME=       example-1.2.3.5
                   8503: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8504: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8505: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8506: </pre>
1.199     tnn      8507: </div>
                   8508: <div class="sect3">
                   8509: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8510: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8511: <p>If your distfile URL looks similar to
1.303     bacon    8512:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8513:       then you are packaging a release.</p>
1.199     tnn      8514: <pre class="programlisting">
                   8515: DISTNAME=       offensive-1.6
1.200     tnn      8516: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8517: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8518: GITHUB_PROJECT= example
1.200     tnn      8519: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8520: EXTRACT_SUFX=   .zip
1.222     sevan    8521: </pre>
1.199     tnn      8522: </div>
                   8523: </div>
1.75      rillig   8524: </div>
1.148     asau     8525: <div class="sect1">
1.75      rillig   8526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8527: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8528: <div class="sect2">
1.75      rillig   8529: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8530: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8531: <p>pkgsrc supports many different machines, with different
1.87      wiz      8532:     object formats like a.out and ELF, and varying abilities to do
                   8533:     shared library and dynamic loading at all. To accompany this,
                   8534:     varying commands and options have to be passed to the
                   8535:     compiler, linker, etc. to get the Right Thing, which can be
                   8536:     pretty annoying especially if you don't have all the machines
                   8537:     at your hand to test things.  The
1.322     leot     8538:     <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     8539:     can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87      wiz      8540:     both static and dynamic libraries from a set of source files,
                   8541:     thus being platform-independent.</p>
                   8542: <p>Here's how to use libtool in a package in seven simple
                   8543:     steps:</p>
1.128     wiz      8544: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8545: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8546:        Makefile.</p></li>
1.385     leot     8547: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
                   8548:        ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87      wiz      8549:        add it to the definition of <code class="varname">CC</code>, if only
                   8550:        libraries are being built in a given Makefile. This one command
                   8551:        will build both PIC and non-PIC library objects, so you need not
                   8552:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8553: <li class="listitem">
1.75      rillig   8554: <p>For the linking of the library, remove any
1.385     leot     8555:        <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
                   8556:        -Bshareable</span>”</span> commands, and instead use:</p>
1.75      rillig   8557: <pre class="programlisting">
1.100     rillig   8558: ${LIBTOOL} --mode=link \
                   8559:     ${CC} -o ${.TARGET:.a=.la} \
                   8560:         ${OBJS:.o=.lo} \
                   8561:         -rpath ${PREFIX}/lib \
                   8562:         -version-info major:minor
1.222     sevan    8563: </pre>
1.75      rillig   8564: <p>Note that the library is changed to have a
1.87      wiz      8565:        <code class="filename">.la</code> extension, and the objects are
                   8566:        changed to have a <code class="filename">.lo</code>
                   8567:        extension. Change <code class="varname">OBJS</code> as
                   8568:        necessary. This automatically creates all of the
                   8569:        <code class="filename">.a</code>,
                   8570:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8571:        necessary) in the build directory. Be sure to include
1.385     leot     8572:        <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87      wiz      8573:        minor are zero, as libtool will otherwise strip off the
                   8574:        shared library version.</p>
1.75      rillig   8575: <p>From the libtool manual:</p>
                   8576: <pre class="programlisting">
1.100     rillig   8577: So, libtool library versions are described by three integers:
1.69      rillig   8578: 
1.100     rillig   8579: CURRENT
                   8580: The most recent interface number that this library implements.
1.69      rillig   8581: 
1.100     rillig   8582: REVISION
                   8583: The implementation number of the CURRENT interface.
1.69      rillig   8584: 
1.100     rillig   8585: AGE
                   8586: The difference between the newest and oldest interfaces that
                   8587: this library implements.  In other words, the library implements
                   8588: all the interface numbers in the range from number `CURRENT -
                   8589: AGE' to `CURRENT'.
1.1       grant    8590: 
1.100     rillig   8591: If two libraries have identical CURRENT and AGE numbers, then the
                   8592: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8593: </pre>
1.385     leot     8594: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87      wiz      8595:        different results for a.out and ELF (excluding symlinks)
                   8596:        in only one case. An ELF library of the form
1.385     leot     8597:        <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      8598:        will have a symlink of
1.385     leot     8599:        <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      8600:        on an a.out platform. This is handled
                   8601:        automatically.</p>
1.385     leot     8602: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87      wiz      8603:        directory of the library being built.</p>
1.76      rillig   8604: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8605:        <code class="filename">.la</code> file, the other files will be
                   8606:        added automatically.</p>
1.75      rillig   8607: </li>
1.128     wiz      8608: <li class="listitem">
1.76      rillig   8609: <p>When linking shared object (<code class="filename">.so</code>)
1.378     leot     8610:        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     8611:        shared libraries, use <span class="quote">“<span class="quote">-module
                   8612:        -avoid-version</span>”</span> to prevent them getting version
1.87      wiz      8613:        tacked on.</p>
1.76      rillig   8614: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8615:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8616: </li>
1.128     wiz      8617: <li class="listitem">
1.75      rillig   8618: <p>When linking programs that depend on these libraries
1.87      wiz      8619:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.385     leot     8620:        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}
                   8621:        --mode=link</span>”</span>, and it will find the correct
1.87      wiz      8622:        libraries (static or shared), but please be aware that
                   8623:        libtool will not allow you to specify a relative path in
1.385     leot     8624:        -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87      wiz      8625:        expects you to change that argument to be the
                   8626:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8627: <pre class="programlisting">
1.100     rillig   8628: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8629: </pre>
1.75      rillig   8630: <p>should be changed to:</p>
                   8631: <pre class="programlisting">
1.100     rillig   8632: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8633: </pre>
1.75      rillig   8634: <p>and it will do the right thing with the libraries.</p>
                   8635: </li>
1.128     wiz      8636: <li class="listitem">
1.378     leot     8637: <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     8638:        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}
                   8639:        --mode=install</span>”</span>, and change the library name to
1.87      wiz      8640:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8641: <pre class="programlisting">
1.126     jakllsch 8642: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8643: </pre>
1.76      rillig   8644: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8645:        shared library, any needed symlinks, and run
1.378     leot     8646:        <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   8647: </li>
1.128     wiz      8648: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8649:        the <code class="filename">.la</code>
                   8650:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8651: </ol></div>
                   8652: </div>
1.148     asau     8653: <div class="sect2">
1.75      rillig   8654: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8655: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8656: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8657:     package Makefile. This will override the package's own libtool
                   8658:     in most cases.  For older libtool using packages,  libtool is
                   8659:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8660:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8661:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8662: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8663:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.385     leot     8664:     default, it is set to <span class="quote">“<span class="quote">libtool */libtool
                   8665:     */*/libtool</span>”</span>.  If this does not match the location of the
1.87      wiz      8666:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8667: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8668:     libraries built and installed, then use
                   8669:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8670: <p>If your package makes use of the platform-independent library
1.87      wiz      8671:     for loading dynamic shared objects, that comes with libtool
                   8672:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8673: <p>Some packages use libtool incorrectly so that the package
                   8674:     may not work or build in some circumstances. Some of the more
                   8675:     common errors are:</p>
1.148     asau     8676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8677: <li class="listitem">
1.75      rillig   8678: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8679:        executable or library. This in itself isn't a problem if one of two things
                   8680:        has been done:</p>
1.128     wiz      8681: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8682: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8683:            <code class="filename">libfoo.la</code>, not
                   8684:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8685: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8686: </ol></div>
                   8687: </li>
1.128     wiz      8688: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8689:        The function lt_dlinit() should be called and the macro
                   8690:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8691:        executables.</p></li>
1.75      rillig   8692: </ul></div>
                   8693: </div>
1.148     asau     8694: <div class="sect2">
1.75      rillig   8695: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8696: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8697: <p>If a package needs GNU autoconf or automake to be executed
1.338     nia      8698:     to regenerate the
                   8699:     <code class="filename">configure</code>
                   8700:     script and <code class="filename">Makefile.in</code> makefile
                   8701:     templates from <code class="filename">configure.ac</code> and
                   8702:     <code class="filename">Makefile.am</code>,
                   8703:     then they should be executed in a pre-configure target:</p>
1.75      rillig   8704: <pre class="programlisting">
1.338     nia      8705: USE_TOOLS+=    autoconf automake autoreconf
                   8706: GNU_CONFIGURE= yes
1.100     rillig   8707: ...
1.1       grant    8708: 
1.100     rillig   8709: pre-configure:
1.338     nia      8710:         set -e; cd ${WRKSRC} &amp;&amp; autoreconf -fi
1.100     rillig   8711: ...
1.222     sevan    8712: </pre>
1.338     nia      8713: <p>Packages which use GNU Automake will sometimes
                   8714:     require GNU Make (<code class="literal">gmake</code> in
                   8715:     <code class="varname">USE_TOOLS</code>),
                   8716:     but not always.  Note that autoreconf
                   8717:     only needs to be executed if <code class="filename">configure.ac</code>
                   8718:     or Makefiles are modified, or <code class="filename">configure</code>
                   8719:     is not present.</p>
1.75      rillig   8720: <p>There are times when the configure process makes
1.87      wiz      8721:     additional changes to the generated files, which then causes
                   8722:     the build process to try to re-execute the automake sequence.
                   8723:     This is prevented by touching various files in the configure
                   8724:     stage. If this causes problems with your package you can set
                   8725:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8726:     Makefile.</p>
1.75      rillig   8727: </div>
1.338     nia      8728: <div class="sect2">
                   8729: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8730: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
1.338     nia      8731: <p>Packages using Meson to configure need to include:
                   8732: 
                   8733: </p>
                   8734: <pre class="programlisting">
                   8735: .include "../../devel/meson/build.mk"
                   8736: </pre>
                   8737: <p>In nearly all cases (any program with dependencies),
                   8738:     pkg-config needs to be added to
                   8739:     <code class="varname">USE_TOOLS</code>.  If the package installs
                   8740:     translation files for non-English languages, also
                   8741:     add msgfmt and xgettext:
                   8742: 
                   8743: </p>
                   8744: <pre class="programlisting">
                   8745: USE_TOOLS+=    pkg-config msgfmt xgettext
                   8746: </pre>
                   8747: <p>If any options need to be passed to Meson, use
                   8748:     <code class="varname">MESON_ARGS</code> instead of
                   8749:     <code class="varname">CONFIGURE_ARGS</code>:
                   8750: 
                   8751: </p>
                   8752: <pre class="programlisting">
                   8753: MESON_ARGS+=   -Dx11=false
                   8754: </pre>
                   8755: </div>
1.379     wiz      8756: <div class="sect2">
                   8757: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8758: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
1.379     wiz      8759: <p>To determine the endianness of the target platform,
                   8760:     have a look at <code class="filename">mk/endian.mk</code>.</p>
                   8761: </div>
1.75      rillig   8762: </div>
1.148     asau     8763: <div class="sect1">
1.75      rillig   8764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8765: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8766: <div class="sect2">
1.87      wiz      8767: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8768: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.358     gutterid 8769: <p>Compilers for the C and C++ languages come with
1.87      wiz      8770:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8771:     is written in C and will hide all other compilers (via the wrapper
1.385     leot     8772:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.357     gutterid 8773: <p>To declare which languages should be made available through
                   8774:     pkgsrc's compiler wrappers, use 
1.87      wiz      8775:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327     wiz      8776:     currently are:
1.352     wiz      8777: </p>
1.327     wiz      8778: <pre class="programlisting">
1.358     gutterid 8779: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.352     wiz      8780: </pre>
1.327     wiz      8781: <p>
                   8782:     (and any combination).  The default is
1.385     leot     8783:     <span class="quote">“<span class="quote">c</span>”</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8784:     written in C++, usually need a C compiler for the configure
1.358     gutterid 8785:     phase.</p>
1.364     jnemeth  8786: <p>To declare which features a package requires from the
1.357     gutterid 8787:     compiler, set either <code class="varname">USE_CC_FEATURES</code>
                   8788:     or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
                   8789:     <code class="varname">USE_CC_FEATURES</code> are currently:
                   8790: </p>
                   8791: <pre class="programlisting">
                   8792: c11, c99, has_include
                   8793: </pre>
                   8794: <p>
                   8795:     Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
                   8796:     currently:
                   8797: </p>
                   8798: <pre class="programlisting">
                   8799: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
                   8800: charconv, parallelism_ts, unique_ptr, put_time,
                   8801: is_trivially_copy_constructible
                   8802: </pre>
                   8803: <p>
1.365     gutterid 8804:     Note at present these variables only affect use of GCC, not other
                   8805:     compilers.
1.357     gutterid 8806:     </p>
1.358     gutterid 8807: <p>Language variants like <code class="literal">gnu99</code> and
                   8808:     <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
                   8809:     and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
                   8810:     <code class="literal">-std=...</code> when compiling (i.e. the package
                   8811:     assumes the compiler defaults to C++11 or some other standard).
                   8812:     This is a common bug in upstream build systems.</p>
                   8813: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
                   8814:     currently:
                   8815: </p>
                   8816: <pre class="programlisting">
                   8817: c90, c99, c11, gnu90, gnu99, gnu11
                   8818: </pre>
                   8819: <p>
                   8820:     </p>
                   8821: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
                   8822:     currently:
                   8823: </p>
                   8824: <pre class="programlisting">
                   8825: c++03, c++11, c++14, c++17, c++20,
                   8826: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
                   8827: </pre>
                   8828: <p>
1.365     gutterid 8829:     Note at present these variables only affect use of GCC and Clang.
1.358     gutterid 8830:     </p>
1.87      wiz      8831: </div>
1.148     asau     8832: <div class="sect2">
1.87      wiz      8833: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8834: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8835: <p>If a program is written in Java, use the Java framework in
                   8836:     pkgsrc.  The package must include
                   8837:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8838:     provides the following variables:</p>
1.148     asau     8839: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8840: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8841:       dependency on the JDK is added.  If
1.385     leot     8842:       <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87      wiz      8843:       there is only a runtime dependency on the JDK.  The default is
1.385     leot     8844:       <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87      wiz      8845:       JDK.</p></li>
1.128     wiz      8846: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8847:       a package needs a Java2 implementation.  The supported values
1.385     leot     8848:       are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
                   8849:       <span class="quote">“<span class="quote">1.5</span>”</span>.  <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
                   8850:       implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
                   8851:       above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87      wiz      8852:       above. This variable is not set by default.</p></li>
1.130     wiz      8853: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8854:       automatically set to the runtime location of the used Java
                   8855:       implementation dependency. It may be used to set
                   8856:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8857:       needs this variable to be defined.
                   8858:       </p></li>
1.87      wiz      8859: </ul></div>
                   8860: </div>
1.148     asau     8861: <div class="sect2">
1.87      wiz      8862: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8863: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
1.320     wiz      8864: <p>If a program is written in Go and has any dependencies on
                   8865:     other Go modules, have the package include
                   8866:     <code class="filename">../../lang/go/go-module.mk</code>.</p>
                   8867: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8868: <li class="listitem"><p>Generate a list of those dependencies with
                   8869:       <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
                   8870:       go-modules.mk</strong></span>.</p></li>
1.338     nia      8871: <li class="listitem"><p>Prepend
                   8872:       <code class="literal">.include "go-modules.mk"</code> to any other
                   8873:       <code class="literal">.include</code>s.</p></li>
                   8874: <li class="listitem"><p>Incorporate these modules in
                   8875:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8876:       makesum</strong></span>.</p></li>
                   8877: </ol></div>
                   8878: </div>
                   8879: <div class="sect2">
                   8880: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8881: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
1.338     nia      8882: <p>If a program is written in Rust and uses Cargo to build,
                   8883:     have the package include
                   8884:     <code class="filename">../../lang/rust/cargo.mk</code>.</p>
                   8885: <div class="orderedlist"><ol class="orderedlist" type="1">
1.393     wiz      8886: <li class="listitem"><p>It will usually depend on a lot of other code
                   8887:       (distributed in so-called crates). Generate a list of those
                   8888:       dependencies with <span class="command"><strong>make extract &amp;&amp; make
                   8889:       print-cargo-depends &gt;
                   8890:       cargo-depends.mk</strong></span>.</p></li>
1.338     nia      8891: <li class="listitem"><p>Prepend
                   8892:       <code class="literal">.include "cargo-depends.mk"</code> to any other
                   8893:       <code class="literal">.include</code>s.</p></li>
1.320     wiz      8894: <li class="listitem"><p>Incorporate these modules in
                   8895:       <code class="filename">distinfo</code> with <span class="command"><strong>make
                   8896:       makesum</strong></span>.</p></li>
                   8897: </ol></div>
                   8898: </div>
                   8899: <div class="sect2">
                   8900: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8901: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318     nia      8902: <p>If your package contains interpreted Perl scripts, add
1.385     leot     8903:     <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8904:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8905:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8906:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8907:     that you want adjusted. Every occurrence of
                   8908:     <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325     gutterid 8909:     replaced with the full path to the Perl executable.</p>
                   8910: <p>If a particular version of Perl is needed, set the
1.87      wiz      8911:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.385     leot     8912:     default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
                   8913: <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 8914:     about handling Perl modules.</p>
                   8915: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
                   8916:     for the language now known as Raku.</p>
1.87      wiz      8917: </div>
1.148     asau     8918: <div class="sect2">
1.87      wiz      8919: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8920: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8921: <p><code class="varname">REPLACE_SH</code>,
                   8922:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8923:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340     gutterid 8924:     she-bangs in files. Please use the appropriate one, preferring
                   8925:     <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183     wiz      8926:     Each should contain a list of scripts, relative to
                   8927:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8928:     occurrence of the matching shell in a she-bang line will be
                   8929:     replaced with the full path to the shell executable.
1.147     wiz      8930:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8931:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8932: </div>
1.148     asau     8933: <div class="sect2">
1.147     wiz      8934: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8935: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325     gutterid 8936: <p>There are further similar REPLACE variables available, e.g.,
                   8937:     <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
                   8938:     and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326     gutterid 8939:     noted above, have their actions defined centrally in
1.325     gutterid 8940:     <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326     gutterid 8941:     languages define the actions of these variables within their own
                   8942:     dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.359     gutterid 8943:     actioned in <code class="filename">lang/php/replace.mk</code>, and
1.326     gutterid 8944:     <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325     gutterid 8945:     <code class="filename">lang/python/application.mk</code>. For other languages,
                   8946:     consult the mk files found within their specific directories (the
1.331     gutterid 8947:     naming convention varies), or check the list found in
1.385     leot     8948:     <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325     gutterid 8949: <p>Currently, special handling for other languages varies
1.87      wiz      8950:     in pkgsrc.  If a compiler package provides a
                   8951:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8952:     just add a (build) dependency on the appropriate compiler
                   8953:     package.</p>
                   8954: </div>
                   8955: </div>
1.148     asau     8956: <div class="sect1">
1.87      wiz      8957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     8958: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8959: <p>The most common failures when building a package are that
                   8960:        some platforms do not provide certain header files, functions or
                   8961:        libraries, or they provide the functions in a library that the
                   8962:        original package author didn't know. To work around this, you
                   8963:        can rewrite the source code in most cases so that it does not
                   8964:        use the missing functions or provides a replacement function.</p>
1.148     asau     8965: <div class="sect2">
1.77      rillig   8966: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     8967: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8968: <p>If a package already comes with a GNU configure script, the
                   8969:        preferred way to fix the build failure is to change the
                   8970:        configure script, not the code. In the other cases, you can
                   8971:        utilize the C preprocessor, which defines certain macros
                   8972:        depending on the operating system and hardware architecture it
                   8973:        compiles for. These macros can be queried using for example
                   8974:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8975:        system, hardware architecture and compiler has its own macro.
                   8976:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8977:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8978:        are all defined, you know that you are using NetBSD on an i386
                   8979:        compatible CPU, and your compiler is GCC.</p>
                   8980: <p>The list of the following macros for hardware and
                   8981:        operating system depends on the compiler that is used. For
                   8982:        example, if you want to conditionally compile code on Solaris,
                   8983:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8984:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8985: <div class="sect3">
1.75      rillig   8986: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     8987: <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      8988: <p>To distinguish between specific NetBSD versions,
                   8989:         you should use the following code.</p>
                   8990: <pre class="programlisting">
                   8991: #ifdef __NetBSD__
                   8992: #include &lt;sys/param.h&gt;
                   8993: #if __NetBSD_Prereq__(9,99,17)
                   8994: /* use a newer feature */
                   8995: #else
                   8996: /* older code */
                   8997: #endif
                   8998: #endif
                   8999: 
                   9000: #ifndef _WIN32
                   9001: /* Unix-like specific code */
                   9002: #endif
                   9003: </pre>
1.75      rillig   9004: <p>To distinguish between 4.4 BSD-derived systems and the
                   9005:         rest of the world, you should use the following code.</p>
                   9006: <pre class="programlisting">
1.100     rillig   9007: #include &lt;sys/param.h&gt;
                   9008: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   9009: /* BSD-specific code goes here */
                   9010: #else
                   9011: /* non-BSD-specific code goes here */
                   9012: #endif
1.75      rillig   9013: </pre>
1.338     nia      9014: <p>You can also test for the following macros:</p>
1.75      rillig   9015: <pre class="programlisting">
1.151     obache   9016: Cygwin      __CYGWIN__
                   9017: DragonFly   __DragonFly__
1.100     rillig   9018: FreeBSD     __FreeBSD__
1.151     obache   9019: Haiku       __HAIKU__
1.100     rillig   9020: IRIX        __sgi (TODO: get a definite source for this)
1.338     nia      9021: Linux       __linux
1.193     dholland 9022: Mac OS X    __APPLE__
1.151     obache   9023: Minix3      __minix
1.100     rillig   9024: NetBSD      __NetBSD__
                   9025: OpenBSD     __OpenBSD__
                   9026: Solaris     sun, __sun
1.75      rillig   9027: </pre>
                   9028: </div>
1.148     asau     9029: <div class="sect3">
1.75      rillig   9030: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9031: <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   9032: <pre class="programlisting">
1.100     rillig   9033: i386        i386, __i386, __i386__
1.338     nia      9034: x86-64      __amd64__, __x86_64__
                   9035: ARM         __arm__
1.100     rillig   9036: MIPS        __mips
                   9037: SPARC       sparc, __sparc
1.338     nia      9038: PowerPC     __powerpc
1.75      rillig   9039: </pre>
                   9040: </div>
1.148     asau     9041: <div class="sect3">
1.75      rillig   9042: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9043: <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   9044: <pre class="programlisting">
1.100     rillig   9045: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   9046: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   9047: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   9048: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   9049: </pre>
                   9050: </div>
                   9051: </div>
1.148     asau     9052: <div class="sect2">
1.78      rillig   9053: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9054: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   9055: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      9056:         combinations of compiler version and architecture and almost
                   9057:         always relation to optimisation being enabled.  Common symptoms
                   9058:         are gcc internal errors or never finishing compiling a
1.78      rillig   9059:        file.</p>
                   9060: <p>Typically, a workaround involves testing the
                   9061:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   9062:         optimisation for that combination of file,
1.198     tnn      9063:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   9064: <p>This used to be a big problem in the past, but is rarely
                   9065:        needed now as compiler technology has matured. If you still need
                   9066:        to add a compiler specific workaround, please do so in the file
                   9067:        <code class="filename">hacks.mk</code> and describe the symptom and
                   9068:        compiler version as detailed as possible.</p>
1.78      rillig   9069: </div>
1.148     asau     9070: <div class="sect2">
1.78      rillig   9071: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9072: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
1.287     rillig   9073: <p>Compilation sometimes fails with an error message like this:</p>
                   9074: <pre class="programlisting">
                   9075: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   9076:     fatal error: pango/pango.h: No such file or directory
                   9077: </pre>
                   9078: <p>The proper way to fix this problem depends on the type of the
                   9079: header, which is described in the following sections.</p>
                   9080: <div class="sect3">
                   9081: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9082: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
1.287     rillig   9083: <p>If the header name looks like it comes from a different package,
                   9084: that other package should be included via the buildlink3
                   9085: framework.</p>
                   9086: <p>First, look whether the header is somewhere in the buildlink3
                   9087: directory below <code class="varname">WRKDIR</code>. In the above case of
                   9088: the missing Pango header:</p>
                   9089: <pre class="programlisting">
                   9090: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   9091: </pre>
                   9092: <p>In the case of Pango, the output is:</p>
                   9093: <pre class="programlisting">
                   9094: work/.buildlink/include/pango-1.0/pango/pango.h
                   9095: </pre>
                   9096: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   9097: in the <code class="filename">.buildlink</code> directory, it would have been
                   9098: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   9099: path component though, which means that the compiler command line must
                   9100: contain an option of the form
                   9101: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   9102: most cases this option is generated by the configure script, which can be examined using:</p>
                   9103: <pre class="programlisting">
                   9104: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   9105: -I/usr/pkg/include/pango-1.0
                   9106: -I/usr/pkg/include/pango-1.0
                   9107: -I/usr/pkg/include/pango-1.0
                   9108: -I/usr/pkg/include/pango-1.0
                   9109: -I/usr/pkg/include/pango-1.0
                   9110: </pre>
                   9111: <p>This looks good. These options are transformed by the buildlink
                   9112: wrapper to refer to the correct path inside
                   9113: <code class="filename">work/.buildlink</code>.</p>
                   9114: <p>Since the compilation fails though, examine the compiler command
                   9115: lines in <code class="filename">work/.work.log</code> to see whether the
                   9116: <code class="literal">-I</code> option is included in the particular command
                   9117: line.</p>
                   9118: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   9119: build-env</strong></span>, which sets up an interactive, realistic environment
                   9120: including all the pkgsrc wrapper commands and environment variables. From
                   9121: there, try to compile some simple example programs that use the
                   9122: header.</p>
                   9123: </div>
                   9124: <div class="sect3">
                   9125: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9126: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
1.287     rillig   9127: <p>If the name of the header seems to come from the package itself,
                   9128: and if the build is run with parallel jobs, the package may have some
                   9129: undeclared dependencies between the <code class="filename">.c</code> and the
                   9130: <code class="filename">.h</code> files, and a C file is compiled before its
                   9131: required header is generated.</p>
                   9132: <p>To see whether the build runs with parallel jobs, run
                   9133: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   9134: like this:</p>
                   9135: <pre class="programlisting">
                   9136:   usr   MAKE_JOBS=              7
                   9137:   pkg   MAKE_JOBS_SAFE          # undefined
                   9138:   def   _MAKE_JOBS_N=           7
                   9139: </pre>
                   9140: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   9141: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   9142: package could have disabled parallel builds by setting
                   9143: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   9144: in this case it hasn't.</p>
                   9145: <p>To see whether the build failure is caused by parallel builds,
                   9146: first save the exact error message and a bit of context, maybe you need
                   9147: it later for reporting a bug. Next, run:</p>
                   9148: <pre class="programlisting">
                   9149: MAKE_JOBS_SAFE=no bmake clean build
                   9150: </pre>
                   9151: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   9152: report</a> against the pkgsrc package, including the exact error
                   9153: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   9154: </div>
1.288     rillig   9155: <div class="sect3">
                   9156: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9157: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
1.288     rillig   9158: <p>Pkgsrc does not work reliably if any of
                   9159: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   9160: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   9161: bootstrap program prevents installing pkgsrc in symlink-based
                   9162: directories. Existing pkgsrc installations are not checked for symlinks
                   9163: though.</p>
                   9164: <p>The "No such file or directory" error messages are a typical
                   9165: symptom of symlinks, and it's quite difficult to find out that this is
                   9166: the actual cause.</p>
                   9167: </div>
                   9168: <div class="sect3">
                   9169: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9170: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
1.288     rillig   9171: <p>When building a hierarchy of packages, it may happen that one
                   9172: package is built and then pkgsrc is updated. This situation can provoke
                   9173: various hard to diagnose build errors. To clean up the situation:</p>
                   9174: <pre class="programlisting">
1.338     nia      9175: <code class="prompt">$</code> (cd ../../ &amp;&amp; cat mk/bsd.pkg.mk &gt;/dev/null &amp;&amp; rm -rf */*/work)
1.288     rillig   9176: </pre>
1.338     nia      9177: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
                   9178: prevent running this command in the wrong directory.)</p>
1.288     rillig   9179: <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
                   9180: that directory as well.</p>
                   9181: </div>
                   9182: <div class="sect3">
                   9183: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9184: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
1.288     rillig   9185: <p>On platforms other than BSD, third-party packages are installed in
                   9186: <code class="filename">/usr/include</code>, together with the base system. This
                   9187: means that pkgsrc cannot distinguish between headers provided by the base
                   9188: system (which it needs) and headers from third-party packages (which are
                   9189: often included in pkgsrc as well). This can lead to subtle version
                   9190: mismatches.</p>
                   9191: <p>In pkgsrc installations that have been active for several years, it
                   9192: may happen that some files are manually deleted. To exclude this unlikely
                   9193: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   9194: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   9195: check/fix dependencies.</p>
1.385     leot     9196: <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   9197: for contact information. Be prepared to describe what you have tried so
                   9198: far and what any error messages were.</p>
                   9199: </div>
1.287     rillig   9200: </div>
                   9201: <div class="sect2">
                   9202: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9203: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128     wiz      9204: </h3></div></div></div>
1.92      rillig   9205: <p>This error message often means that a package did not
1.78      rillig   9206:        link to a shared library it needs. The following functions are
                   9207:        known to cause this error message over and over.</p>
                   9208: <div class="informaltable">
1.216     tnn      9209: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   9210: <colgroup>
                   9211: <col>
                   9212: <col>
                   9213: <col>
                   9214: </colgroup>
                   9215: <thead><tr>
                   9216: <th>Function</th>
                   9217: <th>Library</th>
                   9218: <th>Affected platforms</th>
                   9219: </tr></thead>
                   9220: <tbody>
                   9221: <tr>
                   9222: <td>accept, bind, connect</td>
                   9223: <td>-lsocket</td>
                   9224: <td>Solaris</td>
                   9225: </tr>
                   9226: <tr>
                   9227: <td>crypt</td>
                   9228: <td>-lcrypt</td>
                   9229: <td>DragonFly, NetBSD</td>
                   9230: </tr>
                   9231: <tr>
                   9232: <td>dlopen, dlsym</td>
                   9233: <td>-ldl</td>
                   9234: <td>Linux</td>
                   9235: </tr>
                   9236: <tr>
                   9237: <td>gethost*</td>
                   9238: <td>-lnsl</td>
                   9239: <td>Solaris</td>
                   9240: </tr>
                   9241: <tr>
                   9242: <td>inet_aton</td>
                   9243: <td>-lresolv</td>
                   9244: <td>Solaris</td>
                   9245: </tr>
                   9246: <tr>
                   9247: <td>nanosleep, sem_*, timer_*</td>
                   9248: <td>-lrt</td>
                   9249: <td>Solaris</td>
                   9250: </tr>
                   9251: <tr>
                   9252: <td>openpty</td>
                   9253: <td>-lutil</td>
                   9254: <td>Linux</td>
                   9255: </tr>
                   9256: </tbody>
                   9257: </table>
                   9258: </div>
1.338     nia      9259: <p>To fix these linker errors, it is often sufficient to add
1.87      wiz      9260:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   9261:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338     nia      9262:     <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87      wiz      9263:     bmake</strong></span>.</p>
1.148     asau     9264: <div class="sect3">
1.92      rillig   9265: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9266: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92      rillig   9267: <p>When you are using the SunPro compiler, there is another
                   9268: possibility. That compiler cannot handle the following code:</p>
                   9269: <pre class="programlisting">
1.100     rillig   9270: extern int extern_func(int);
1.93      rillig   9271: 
1.100     rillig   9272: static inline int
                   9273: inline_func(int x)
                   9274: {
1.92      rillig   9275:         return extern_func(x);
1.100     rillig   9276: }
1.93      rillig   9277: 
1.100     rillig   9278: int main(void)
                   9279: {
1.92      rillig   9280:         return 0;
1.100     rillig   9281: }
1.92      rillig   9282: </pre>
                   9283: <p>It generates the code for <code class="function">inline_func</code> even if
                   9284: that function is never used. This code then refers to
                   9285: <code class="function">extern_func</code>, which can usually not be resolved. To
                   9286: solve this problem you can try to tell the package to disable inlining
                   9287: of functions.</p>
                   9288: </div>
1.343     gutterid 9289: <div class="sect3">
                   9290: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     9291: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
1.343     gutterid 9292: <p>When building for older machine architectures (e.g., i386, PowerPC),
                   9293:   builds may fail because the package expects modern 64-bit atomic functions
                   9294:   which the underlying hardware either doesn't support, or will only support
                   9295:   with specific compiler flags. This is generally handled via inclusion of
                   9296:   mk/atomic64.mk.</p>
                   9297: </div>
1.87      wiz      9298: </div>
1.148     asau     9299: <div class="sect2">
1.87      wiz      9300: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9301: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      9302: <p>Sometimes packages fail to build because the compiler runs
                   9303:     into an operating system specific soft limit.  With the
                   9304:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338     nia      9305:     to unlimit the resources.  The allowed values are any combination of
1.385     leot     9306:     <span class="quote">“<span class="quote">cputime</span>”</span>,
                   9307:     <span class="quote">“<span class="quote">datasize</span>”</span>,
                   9308:     <span class="quote">“<span class="quote">memorysize</span>”</span>,
                   9309:     <span class="quote">“<span class="quote">stacksize</span>”</span> and
                   9310:     <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.87      wiz      9311:     Setting this variable is similar to running the shell builtin
1.110     hubertf  9312:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      9313:     segment size or maximum stack size of a process, respectively, to
                   9314:     their hard limits.</p>
1.78      rillig   9315: </div>
1.75      rillig   9316: </div>
1.148     asau     9317: <div class="sect1">
1.75      rillig   9318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9319: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     9320: <div class="sect2">
1.75      rillig   9321: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9322: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  9323: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      9324:     with some operating systems cannot create more than one
                   9325:     directory at a time. As such, you should call
                   9326:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9327: <pre class="programlisting">
1.100     rillig   9328: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9329: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    9330: </pre>
1.338     nia      9331: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
1.385     leot     9332:     directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
                   9333:     dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
1.338     nia      9334:     variable, which will automatically do the right thing.</p>
1.75      rillig   9335: </div>
1.148     asau     9336: <div class="sect2">
1.75      rillig   9337: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9338: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      9339: <p>In general, documentation should be installed into
1.87      wiz      9340:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338     nia      9341:     <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87      wiz      9342:     includes the version number of the package).</p>
1.84      wiz      9343: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      9344:     directory where HTML documentation is installed with the
1.385     leot     9345:     <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
1.338     nia      9346:     needed because otherwise the documentation ends up in
                   9347:     <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
                   9348:     pkgsrc, the HTML documentation should go into the package-specific
                   9349:     directory, just like any other documentation.</p>
1.87      wiz      9350: <p>An exception to the above is that library API documentation
1.322     leot     9351:     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      9352:     browsers (devhelp) should be left at their default location, which
                   9353:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9354:     documentation can be recognized from files ending in
                   9355:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9356:     (It is also acceptable to install such files in
                   9357:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9358:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9359:     <code class="filename">.devhelp*</code> file must be directly in that
                   9360:     directory then, no additional subdirectory level is allowed in
                   9361:     this case. This is usually achieved by using
1.385     leot     9362:     <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87      wiz      9363:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9364:     though.)</p>
1.75      rillig   9365: </div>
1.148     asau     9366: <div class="sect2">
1.75      rillig   9367: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9368: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   9369: <p>Certain packages, most of them in the games category, install
1.87      wiz      9370:     a score file that allows all users on the system to record their
                   9371:     highscores.  In order for this to work, the binaries need to be
                   9372:     installed setgid and the score files owned by the appropriate
1.142     wiz      9373:     group and/or owner (traditionally the "games" user/group).  Set
                   9374:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      9375:     following variables, documented in more detail in
                   9376:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      9377:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9378:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     9379:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   9380:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   9381:     <code class="varname">GAMEDATA_PERMS</code> and
                   9382:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   9383: <p>An example that illustrates some of the variables described above is
                   9384:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   9385:     used to properly set directory permissions of the directory where the
                   9386:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   9387:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   9388:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   9389:     binary:</p>
                   9390: <pre class="programlisting">
1.223     rillig   9391: USE_GAMESGROUP=         yes
1.210     leot     9392: 
1.223     rillig   9393: BUILD_DEFS+=            VARBASE
1.210     leot     9394: 
1.223     rillig   9395: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   9396: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   9397: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    9398: </pre>
1.210     leot     9399: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   9400:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   9401:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   9402:     needed to be accessed by setgid games and
                   9403:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 9404: <p>A package should therefore never hard code file ownership or
1.210     leot     9405:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   9406:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   9407:     <code class="varname">INSTALL_GAME_DATA</code> and
                   9408:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   9409: </div>
1.148     asau     9410: <div class="sect2">
1.75      rillig   9411: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9412: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9413: <p><code class="varname">DESTDIR</code> support means that a package
                   9414:     installs into a staging directory, not the final location of the
                   9415:     files. Then a binary package is created which can be used for
                   9416:     installation as usual. There are two ways: Either the package must
1.385     leot     9417:     install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
                   9418:     install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148     asau     9419: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9420: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.385     leot     9421:       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     9422:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.385     leot     9423:       is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
1.145     wiz      9424:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9425:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9426:       the inclusion.</p></li>
1.128     wiz      9427: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9428:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9429: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9430:       automatically. Many manual rules and pre/post-install often are
                   9431:       incorrect; fix them.</p></li>
1.128     wiz      9432: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9433:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9434: <li class="listitem"><p>In general, packages should support
1.103     wiz      9435:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9436:       DESTDIR.</p></li>
                   9437: </ul></div>
                   9438: </div>
1.148     asau     9439: <div class="sect2">
1.103     wiz      9440: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9441: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9442: <p>Your package may also contain scripts with hardcoded paths to
1.318     nia      9443:       other interpreters besides (or as well as) Perl.  To correct the
1.87      wiz      9444:       full pathname to the script interpreter, you need to set the
                   9445:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9446:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9447: <pre class="programlisting">
1.100     rillig   9448: REPLACE_INTERPRETER+=   tcl
                   9449: REPLACE.tcl.old=        .*/bin/tclsh
                   9450: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9451: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9452: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    9453: </pre>
1.75      rillig   9454: </div>
1.148     asau     9455: <div class="sect2">
1.75      rillig   9456: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9457: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75      rillig   9458: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9459:     the Makefile fragment
                   9460:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9461:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9462:     configuration for such modules as well as various hooks to tune
                   9463:     this configuration.  See comments in this file for
                   9464:     details.</p>
1.75      rillig   9465: <p>Perl5 modules will install into different places depending
1.87      wiz      9466:     on the version of perl used during the build process.  To
                   9467:     address this, pkgsrc will append lines to the
                   9468:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9469:     the installed <code class="filename">.packlist</code> file generated by
                   9470:     most perl5 modules.  This is invoked by defining
                   9471:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9472:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9473:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9474:     e.g.:</p>
1.75      rillig   9475: <pre class="programlisting">
1.153     wiz      9476: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9477: </pre>
1.153     wiz      9478: <p>The perl5 config variables
                   9479:     <code class="varname">installarchlib</code>,
                   9480:     <code class="varname">installscript</code>,
                   9481:     <code class="varname">installvendorbin</code>,
                   9482:     <code class="varname">installvendorscript</code>,
                   9483:     <code class="varname">installvendorarch</code>,
                   9484:     <code class="varname">installvendorlib</code>,
                   9485:     <code class="varname">installvendorman1dir</code>, and
                   9486:     <code class="varname">installvendorman3dir</code> represent those
                   9487:     locations in which components of perl5 modules may be installed,
                   9488:     provided as variable with uppercase and prefixed with
                   9489:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9490:     and may be used by perl5 packages that don't have a packlist.
                   9491:     These variables are also substituted for in the
                   9492:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9493:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9494: </div>
1.148     asau     9495: <div class="sect2">
1.75      rillig   9496: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9497: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
1.369     wiz      9498: <p>Some packages, usually those providing libraries, install
                   9499:     pkg-config files so that their headers and libraries can easily be
                   9500:     found.  The file names end with <code class="filename">.pc</code>.</p>
                   9501: <p>Most of the time, these files only provide the linker flags
                   9502:     for the library, but do not include the flags for setting the
                   9503:     rpath so the libraries can also be found at runtime. Since this is
                   9504:     so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
                   9505:     for this. Many packages generate the <code class="filename">.pc</code> from
                   9506:     <code class="filename">.pc.in</code>, in that case add those files to the
                   9507:     <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
                   9508: <pre class="programlisting">
                   9509: PKGCONFIG_OVERRIDE+=   foo.pc.in
                   9510:     </pre>
                   9511: <p>For packages using meson, the files are generated during
                   9512:     build and you also need to change the phase in which the
                   9513:     replacement is done. For example:</p>
                   9514: <pre class="programlisting">
                   9515: PKGCONFIG_OVERRIDE+=            output/meson-private/foo.pc
                   9516: PKGCONFIG_OVERRIDE_STAGE=       post-build
                   9517:     </pre>
                   9518: </div>
                   9519: <div class="sect2">
                   9520: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9521: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.75      rillig   9522: <p>Some packages install info files or use the
1.385     leot     9523:     <span class="quote">“<span class="quote">makeinfo</span>”</span>  or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87      wiz      9524:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9525:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9526:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9527:     handle registration of the info files in the Info directory
1.385     leot     9528:     file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87      wiz      9529:     files registration is either provided by the system, or by a
                   9530:     special purpose package automatically added as dependency if
                   9531:     needed.</p>
1.75      rillig   9532: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9533:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9534:     located. <code class="varname">PKGINFODIR</code> defaults to
1.385     leot     9535:     <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75      rillig   9536: <p>The info files for the package should be listed in the
1.87      wiz      9537:     package <code class="filename">PLIST</code>; however any split info files
                   9538:     need not be listed.</p>
1.385     leot     9539: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
                   9540:     at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87      wiz      9541:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.385     leot     9542:     version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87      wiz      9543:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9544:     variable in the package <code class="filename">Makefile</code>. By
                   9545:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9546:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9547:     does not match the required minimum, a build dependency on the
1.322     leot     9548:     <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      9549:     be added automatically.</p>
1.75      rillig   9550: <p>The build and installation process of the software provided
1.87      wiz      9551:     by the package should not use the
1.110     hubertf  9552:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9553:     info files is the task of the package
                   9554:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9555:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9556: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9557:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9558:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9559:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9560: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9561:     no effect except the logging of a message. The script overriding
1.110     hubertf  9562:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9563:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9564:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9565: </div>
1.148     asau     9566: <div class="sect2">
1.75      rillig   9567: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9568: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.81      rillig   9569: <p>All packages that install manual pages should install them
1.87      wiz      9570:     into the same directory, so that there is one common place to look
                   9571:     for them. In pkgsrc, this place is
                   9572:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9573:     should be used in packages. The default for
                   9574:     <code class="varname">PKGMANDIR</code> is
1.385     leot     9575:     <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
                   9576:     is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148     asau     9577: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9578: <h3 class="title">Note</h3>
1.87      wiz      9579: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9580:     is far from complete.</p>
1.75      rillig   9581: </div>
1.81      rillig   9582: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9583:     <code class="filename">man/</code> as the top level directory for the man
                   9584:     page file entries, and the pkgsrc framework will convert as
                   9585:     needed. In all other places, the correct
                   9586:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9587: <p>Packages that are
                   9588:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.385     leot     9589:     <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87      wiz      9590:     <code class="filename">./configure</code>
                   9591:     --mandir switch to set where the man pages should be installed.
                   9592:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9593:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9594: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9595:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.385     leot     9596:     to <span class="quote">“<span class="quote">no</span>”</span>.
1.87      wiz      9597:     Or if the <code class="filename">./configure</code> script uses
                   9598:     a non-standard use of --mandir, you can set
                   9599:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.385     leot     9600: <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      9601:     information on installation of compressed manual pages.</p>
1.75      rillig   9602: </div>
1.148     asau     9603: <div class="sect2">
1.75      rillig   9604: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9605: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9606: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9607:     the fonts database in the directory where they get installed at
                   9608:     installation and deinstallation time.  This can be automatically
                   9609:     done by using the pkginstall framework.</p>
1.75      rillig   9610: <p>You can list the directories where fonts are installed in the
1.87      wiz      9611:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9612:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.385     leot     9613:     <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      9614:     Also make sure that the database file
                   9615:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9616: <p>Note that you should not create new directories for fonts;
1.87      wiz      9617:     instead use the standard ones to avoid that the user needs to
                   9618:     manually configure his X server to find them.</p>
1.75      rillig   9619: </div>
1.148     asau     9620: <div class="sect2">
1.75      rillig   9621: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9622: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9623: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9624:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9625:     etc.), you need to take some extra steps:</p>
1.128     wiz      9626: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9627: <li class="listitem"><p>Include
1.87      wiz      9628:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9629:        your <code class="filename">Makefile</code>, which takes care of
                   9630:        registering those files in system-wide catalogs at
                   9631:        installation and deinstallation time.</p></li>
1.128     wiz      9632: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9633:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9634: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9635:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9636: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9637:        to be added to the SGML catalog.  These come in groups of
                   9638:        three strings; see xmlcatmgr(1) for more information
                   9639:        (specifically, arguments recognized by the 'add' action).
                   9640:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9641: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9642:        to be added to the XML catalog.  These come in groups of three
                   9643:        strings; see xmlcatmgr(1) for more information (specifically,
                   9644:        arguments recognized by the 'add' action).  Note that you will
                   9645:        normally not use this variable.</p></li>
1.75      rillig   9646: </ol></div>
                   9647: </div>
1.148     asau     9648: <div class="sect2">
1.75      rillig   9649: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9650: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9651: <p>If a package provides extensions to the MIME database by
1.87      wiz      9652:     installing <code class="filename">.xml</code> files inside
                   9653:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9654:     need to take some extra steps to ensure that the database is kept
                   9655:     consistent with respect to these new files:</p>
1.128     wiz      9656: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9657: <li class="listitem"><p>Include
1.87      wiz      9658:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9659:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9660:        this same directory, which is reserved for inclusion from
                   9661:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9662:        care of rebuilding the MIME database at installation and
                   9663:        deinstallation time, and disallows any access to it directly
                   9664:        from the package.</p></li>
1.128     wiz      9665: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9666:        <code class="filename">share/mime</code> directory,
                   9667:        <span class="emphasis"><em>except</em></span> for files saved under
                   9668:        <code class="filename">share/mime/packages</code>.  The former are
                   9669:        handled automatically by
                   9670:        the update-mime-database program, but the latter are
                   9671:        package-dependent and must be removed by the package that
                   9672:        installed them in the first place.</p></li>
1.128     wiz      9673: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9674:        from the PLIST.  They will be handled by the shared-mime-info
                   9675:        package.</p></li>
1.75      rillig   9676: </ol></div>
                   9677: </div>
1.148     asau     9678: <div class="sect2">
1.75      rillig   9679: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9680: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.93      rillig   9681: <p>If a package uses intltool during its build, add
                   9682:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9683:     which forces it to use the intltool package provided by pkgsrc,
                   9684:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9685: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9686:     latest available version; this way, the package benefits of any
                   9687:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9688: </div>
1.148     asau     9689: <div class="sect2">
1.75      rillig   9690: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9691: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.374     wiz      9692: <p>If a package contains an rc.d script, it won't be copied into
                   9693:     the startup directory (<code class="filename">/etc/rc.d</code>) by default,
                   9694:     but you can enable copying by setting the option
                   9695:     <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9696:     <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
                   9697:     will be copied into <code class="filename">/etc/rc.d</code> when a package
                   9698:     is installed, but only if the target does not already exist.
                   9699:     Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
                   9700:     only if they have not been modified.
                   9701:     </p>
                   9702: <p>Note that this alone does not enable the service: It must still be
                   9703:     added to <code class="filename">/etc/rc.conf</code>.</p>
1.75      rillig   9704: </div>
1.148     asau     9705: <div class="sect2">
1.75      rillig   9706: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9707: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9708: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9709:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9710:     updated.</p>
1.148     asau     9711: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9712: <h3 class="title">Note</h3>
1.125     wiz      9713: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9714:     packages should install files
1.125     wiz      9715:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9716:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9717: </div>
1.128     wiz      9718: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9719: <li class="listitem"><p>Include
1.125     wiz      9720:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9721:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9722:       database at installation and deinstallation time.</p></li>
1.128     wiz      9723: <li class="listitem">
1.75      rillig   9724: <p>If your package installs files into a texmf
1.87      wiz      9725:       tree other than the one
1.125     wiz      9726:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9727:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9728:       trees that need database update.</p>
1.75      rillig   9729: <p>If your package also installs font map files that need
1.110     hubertf  9730:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9731:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9732:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9733:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9734:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9735:       be run automatically at installation/deinstallation to
                   9736:       enable/disable font map files for TeX output
                   9737:       drivers.</p>
1.75      rillig   9738: </li>
1.128     wiz      9739: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9740:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9741:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9742: </ol></div>
                   9743: </div>
1.148     asau     9744: <div class="sect2">
1.85      jmmv     9745: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9746: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.87      wiz      9747:     emulation</h3></div></div></div>
                   9748: <p>There are some packages that provide libraries and
                   9749:     executables for running binaries from a one operating system
                   9750:     on a different one (if the latter supports it).  One example
                   9751:     is running Linux binaries on NetBSD.</p>
1.322     leot     9752: <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      9753:     helps in extracting and packaging Linux rpm packages.</p>
                   9754: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9755:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9756:     if all libraries for each installed executable can be found by
                   9757:     the dynamic linker.  Since the standard dynamic linker is run,
                   9758:     this fails for emulation packages, because the libraries used
                   9759:     by the emulation are not in the standard directories.</p>
                   9760: </div>
1.299     rillig   9761: <div class="sect2">
                   9762: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9763: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.299     rillig   9764: <p>If a package installs images under the
                   9765:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9766:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9767:     database, you need to take some extra steps to make sure that the
                   9768:     shared theme directory is handled appropriately and that the cache
                   9769:     database is rebuilt:</p>
                   9770: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9771: <li class="listitem"><p>Include
                   9772:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9773: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9774:        entry that refers to the theme cache.</p></li>
                   9775: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9776:          directories from the <code class="filename">share/icons/hicolor</code>
                   9777:          hierarchy because they will be handled automatically.</p></li>
                   9778: </ol></div>
                   9779: <p>The best way to verify that the PLIST is correct with
                   9780:       respect to the last two points is to regenerate it using
                   9781:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9782: </div>
                   9783: <div class="sect2">
                   9784: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     9785: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.299     rillig   9786: <p>If a package installs <code class="filename">.desktop</code> files
                   9787:       under <code class="filename">share/applications</code> and these include
                   9788:       MIME information (MimeType key), you need to take extra steps to
                   9789:       ensure that they are registered into the MIME database:</p>
                   9790: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9791: <li class="listitem"><p>Include
                   9792:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9793: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9794:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9795:          It will be handled automatically.</p></li>
                   9796: </ol></div>
                   9797: <p>The best way to verify that the PLIST is correct with
                   9798:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9799:       print-PLIST</strong></span>.</p>
                   9800: </div>
                   9801: </div>
                   9802: <div class="sect1">
                   9803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9804: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.299     rillig   9805: <p>In some cases one does not have the time to solve a problem
                   9806:   immediately. In this case, one can plainly mark a package as broken.  For
                   9807:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9808:   reason why the package is broken (similar to the
                   9809:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9810:   the package will immediately be shown this message, and the build
                   9811:   will not be even tried.</p>
                   9812: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9813:   intervals.</p>
                   9814: </div>
                   9815: </div>
                   9816: <div class="chapter">
                   9817: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     9818: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.299     rillig   9819: <div class="toc">
                   9820: <p><b>Table of Contents</b></p>
                   9821: <dl class="toc">
                   9822: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9823: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9824: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9825: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9826: </dl>
                   9827: </div>
                   9828: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9829: site</a>:</p>
                   9830: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9831:   environment, an intuitive and attractive desktop for users, and the
                   9832:   GNOME development platform, an extensive framework for building
                   9833:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9834: <p>pkgsrc provides a seamless way to automatically build and install
                   9835: a complete GNOME environment <span class="emphasis"><em>under many different
                   9836: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9837: the most advanced build and packaging systems for GNOME due to its
                   9838: included technologies buildlink3, the wrappers and tools framework and
                   9839: automatic configuration file management.  Lots of efforts are put into
                   9840: achieving a completely clean deinstallation of installed software
                   9841: components.</p>
                   9842: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9843: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9844: under this operating system.</p>
1.299     rillig   9845: <p>This chapter is aimed at pkgsrc developers and other people
                   9846: interested in helping our GNOME porting and packaging efforts.  It
                   9847: provides instructions on how to manage the existing packages and some
                   9848: important information regarding their internals.</p>
                   9849: <div class="sect1">
                   9850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9851: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.299     rillig   9852: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9853: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322     leot     9854: <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   9855:     the core GNOME desktop environment.  It only includes the necessary
                   9856:     bits to get it to boot correctly, although it may lack important
                   9857:     functionality for daily operation.  The idea behind this package is
                   9858:     to let end users build their own configurations on top of this one,
                   9859:     first installing this meta package to achieve a functional setup and
                   9860:     then adding individual applications.</p></li>
1.322     leot     9861: <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   9862:     complete installation of the GNOME platform and desktop as defined
                   9863:     by the GNOME project; this is based on the components distributed in
                   9864:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9865:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9866:     official FTP server.  Developer-only tools found in those
                   9867:     directories are not installed unless required by some other
                   9868:     component to work properly.  Similarly, packages from the bindings
                   9869:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9870:     in unless required as a dependency for an end-user component.  This
1.322     leot     9871:     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>
                   9872: <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   9873:     Installs all the tools required to build a GNOME component when
                   9874:     fetched from the CVS repository.  These are required to let the
                   9875:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9876: </ul></div>
                   9877: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9878: sorted in a way that eases updates: a package may depend on other
                   9879: packages listed before it but not on any listed after it.  It is very
                   9880: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9881: change it to alphabetical sorting!</em></span></p>
                   9882: </div>
                   9883: <div class="sect1">
                   9884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9885: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.299     rillig   9886: <p>Almost all GNOME applications are written in C and use a common
                   9887: set of tools as their build system.  Things get different with the new
                   9888: bindings to other languages (such as Python), but the following will
                   9889: give you a general idea on the minimum required tools:</p>
                   9890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9891: <li class="listitem">
                   9892: <p>Almost all GNOME applications use the GNU Autotools as their
                   9893:     build system.  As a general rule you will need to tell this to your
                   9894:     package:</p>
                   9895: <pre class="programlisting">
1.338     nia      9896: GNU_CONFIGURE=  yes
                   9897: USE_LIBTOOL=    yes
                   9898: USE_TOOLS+=     gmake
1.299     rillig   9899: </pre>
                   9900: </li>
                   9901: <li class="listitem">
                   9902: <p>If the package uses pkg-config to detect dependencies, add this
                   9903:     tool to the list of required utilities:</p>
                   9904: <pre class="programlisting">
1.338     nia      9905: USE_TOOLS+=     pkg-config
1.299     rillig   9906: </pre>
1.322     leot     9907: <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   9908:     the end of the build process to ensure that you did not miss to
                   9909:     specify any dependency in your package and that the version
                   9910:     requirements are all correct.</p>
                   9911: </li>
                   9912: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9913:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9914:     to handle dependencies and to force the package to use the latest
                   9915:     available version.</p></li>
                   9916: <li class="listitem">
                   9917: <p>If the package uses gtk-doc (a documentation generation
                   9918:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9919:     tool is rather big and the distfile should come with pregenerated
                   9920:     documentation anyway; if it does not, it is a bug that you ought to
                   9921:     report.  For such packages you should disable gtk-doc (unless it is
                   9922:     the default):</p>
                   9923: <pre class="programlisting">
1.338     nia      9924: CONFIGURE_ARGS+=        --disable-gtk-doc
1.299     rillig   9925: </pre>
                   9926: <p>The default location of installed HTML files
                   9927:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9928:     and should not be changed unless the package insists on installing
                   9929:     them somewhere else.  Otherwise programs as
                   9930:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9931:     do that with an entry similar to:</p>
                   9932: <pre class="programlisting">
1.338     nia      9933: CONFIGURE_ARGS+=        --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299     rillig   9934: </pre>
                   9935: </li>
                   9936: </ul></div>
                   9937: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9938: files under the installation prefix to maintain databases.  In this
                   9939: context, shared means that those exact same directories and files are
                   9940: used among several different packages, leading to conflicts in the
                   9941: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9942: handle the most common cases, so you have to forget about using
                   9943: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9944: omitting shared files from them.  If you find yourself doing those,
                   9945: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9946: <p>The following table lists the common situations that result in
                   9947: using shared directories or files.  For each of them, the appropriate
                   9948: solution is given.  After applying the solution be sure to
                   9949: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9950: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9951: <div class="table">
1.385     leot     9952: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.299     rillig   9953: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9954: <colgroup>
                   9955: <col>
                   9956: <col>
                   9957: </colgroup>
                   9958: <thead><tr>
                   9959: <th>If the package...</th>
                   9960: <th>Then...</th>
                   9961: </tr></thead>
                   9962: <tbody>
                   9963: <tr>
                   9964: <td>Installs icons under the
                   9965:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9966:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.385     leot     9967: <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   9968: </tr>
                   9969: <tr>
                   9970: <td>Installs files under
                   9971:         <code class="filename">share/mime/packages</code>.</td>
1.385     leot     9972: <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   9973: </tr>
                   9974: <tr>
                   9975: <td>Installs <code class="filename">.desktop</code> files under
                   9976:         <code class="filename">share/applications</code> and these include MIME
                   9977:         information.</td>
1.385     leot     9978: <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   9979: </tr>
                   9980: </tbody>
                   9981: </table></div>
1.75      rillig   9982: </div>
1.299     rillig   9983: <br class="table-break">
1.75      rillig   9984: </div>
1.148     asau     9985: <div class="sect1">
1.87      wiz      9986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     9987: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.299     rillig   9988: <p>When seeing GNOME as a whole, there are two kinds of
                   9989: updates:</p>
                   9990: <div class="variablelist"><dl class="variablelist">
                   9991: <dt><span class="term">Major update</span></dt>
                   9992: <dd>
                   9993: <p>Given that there is still a very long way for GNOME 3 (if it
                   9994:       ever appears), we consider a major update one that goes from a
                   9995:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9996:       where <code class="literal">Y</code> is even and greater than
                   9997:       <code class="literal">X</code>.  These are hard to achieve because they
                   9998:       introduce lots of changes in the components' code and almost all
                   9999:       GNOME distfiles are updated to newer versions.  Some of them can
                   10000:       even break API and ABI compatibility with the previous major
                   10001:       version series.  As a result, the update needs to be done all at
                   10002:       once to minimize breakage.</p>
                   10003: <p>A major update typically consists of around 80 package
                   10004:       updates and the addition of some new ones.</p>
                   10005: </dd>
                   10006: <dt><span class="term">Minor update</span></dt>
                   10007: <dd>
                   10008: <p>We consider a minor update one that goes from a
                   10009:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10010:       one where <code class="literal">Y</code> is greater than
                   10011:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10012:       not update all GNOME components, can be done in an incremental way
                   10013:       and do not break API nor ABI compatibility.</p>
                   10014: <p>A minor update typically consists of around 50 package
                   10015:       updates, although the numbers here may vary a lot.</p>
                   10016: </dd>
                   10017: </dl></div>
                   10018: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10019: release (either major or minor), the following steps should be
                   10020: followed:</p>
                   10021: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      10022: <li class="listitem">
1.299     rillig   10023: <p>Get a list of all the tarballs that form the new release by
                   10024:     using the following commands.  These will leave the full list of the
                   10025:     components' distfiles into the <code class="filename">list.txt</code>
                   10026:     file:</p>
                   10027: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10028:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10029:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10030: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10031:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10032:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   10033: </li>
1.299     rillig   10034: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   10035:     bump their version to the release you are updating them to.  The
                   10036:     three meta packages should be always consistent with versioning.
                   10037:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10038:     in them.</p></li>
1.128     wiz      10039: <li class="listitem">
1.299     rillig   10040: <p>For each meta package, update all its
                   10041:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10042:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10043:     newer version (even if found in the FTP) because the meta packages
                   10044:     are supposed to list the exact versions that form a specific GNOME
                   10045:     release.  Exceptions are permitted here if a newer version solves a
                   10046:     serious issue in the overall desktop experience; these typically
                   10047:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10048:     from the developers.</p>
                   10049: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10050:     should be updated to the latest version available (if found in
                   10051:     pkgsrc).  This is the case, for example, of the dependencies on the
1.322     leot     10052:     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   10053: </li>
1.128     wiz      10054: <li class="listitem">
1.299     rillig   10055: <p>Generate a patch from the modified meta packages and extract the
                   10056:     list of "new" lines.  This will provide you an outline on what
                   10057:     packages need to be updated in pkgsrc and in what order:</p>
                   10058: <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   10059: </li>
1.299     rillig   10060: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   10061:     installed packages and start over from scratch at this point.</p></li>
                   10062: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   10063:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10064:     it in order.  For major desktop updates none of these should be
                   10065:     committed until the entire set is completed because there are chances
                   10066:     of breaking not-yet-updated packages.</p></li>
                   10067: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   10068:     the tree one by one with appropriate log messages.  At the end,
                   10069:     commit the three meta package updates and all the corresponding
                   10070:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
1.395     leot     10071:     <a href="//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>
1.299     rillig   10072: </ol></div>
                   10073: </div>
                   10074: <div class="sect1">
                   10075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10076: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.299     rillig   10077: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10078: packages.  Please, it is very important that you always, always,
                   10079: <span class="strong"><strong>always</strong></span> feed back any portability
1.385     leot     10080: 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   10081: their attention on portability issues and to ensure that future versions
                   10082: can be built out-of-the box on NetBSD.  The less custom patches in
                   10083: pkgsrc, the easier further updates are.  Those developers in charge of
                   10084: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 10085: <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
                   10086: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   10087: of them do.  Do not be short on your reports: always provide detailed
                   10088: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 10089: maximum portability and, if at all possible, provide a patch against the
                   10090: main Git branch.  The more verbose you are, the higher chances of your
                   10091: patch being accepted.</p>
1.299     rillig   10092: <p>Also, please avoid using preprocessor magic to fix portability
                   10093: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10094: GNOME to their operating system, the official GNOME sources are now
                   10095: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10096: and similar macros.  This hurts portability.  Please see our patching
1.385     leot     10097: 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   10098: details.</p>
                   10099: </div>
1.75      rillig   10100: </div>
1.148     asau     10101: <div class="chapter">
1.75      rillig   10102: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10103: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   10104: <div class="toc">
                   10105: <p><b>Table of Contents</b></p>
1.210     leot     10106: <dl class="toc">
1.267     rillig   10107: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   10108: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   10109: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   10110: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   10111: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   10112: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   10113: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   10114: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   10115: </dl>
                   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="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   10120: <p>Our policy is that we accept binaries only from pkgsrc
                   10121:        developers to guarantee that the packages don't contain any
                   10122:        trojan horses etc. This is not to annoy anyone but rather to
                   10123:        protect our users! You're still free to put up your home-made
                   10124:        binary packages and tell the world where to get them. NetBSD
                   10125:        developers doing bulk builds and wanting to upload them please
1.385     leot     10126:        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     10127: builds)</i></a>.</p>
1.75      rillig   10128: </div>
1.148     asau     10129: <div class="sect1">
1.75      rillig   10130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10131: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333     nia      10132: <p>Firstly, you can import new packages into
1.385     leot     10133:        pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.333     nia      10134:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
                   10135:        for details.</p>
                   10136: <p>Next, check that your package is complete, compiles and
1.385     leot     10137:        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      10138:        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>
                   10139:        tool and fix any errors that appear.</p>
                   10140: <p>Finally, send a report to the pkgsrc bug tracking system,
1.378     leot     10141:        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      10142:        that, go to the web page
1.289     leot     10143:        <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      10144:        which contains some instructions and a link to a form where you
                   10145:        can submit packages.  The
1.322     leot     10146:        <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      10147:        also available as a substitute for either of the above two tools.
                   10148:        </p>
1.87      wiz      10149: <p>In the form of the problem report, the category should be
1.385     leot     10150:        <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87      wiz      10151:        and version number, and the description field should contain a
                   10152:        short description of your package (contents of the COMMENT
1.333     nia      10153:        variable or DESCR file are OK).</p>
1.75      rillig   10154: </div>
1.148     asau     10155: <div class="sect1">
1.75      rillig   10156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10157: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   10158: <p>Please note all package additions, updates, moves, and
1.93      rillig   10159:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   10160:        important to keep this file up to date and conforming to the
                   10161:        existing format, because it will be used by scripts to
1.289     leot     10162:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   10163:        sites. Additionally, check the
1.76      rillig   10164:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   10165:        for the package you updated or removed, in case it was mentioned
                   10166:        there.</p>
                   10167: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   10168:        bumped, the change should appear in
1.93      rillig   10169:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   10170:        related or otherwise relevant. Mass bumps that result from a
                   10171:        dependency being updated should not be mentioned. In all other
                   10172:        cases it's the developer's decision.</p>
                   10173: <p>There is a make target that helps in creating proper
1.110     hubertf  10174:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   10175:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   10176:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   10177:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   10178:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  10179:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   10180:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   10181:   For new packages, or package moves or removals, set the
                   10182:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   10183:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  10184:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      10185:   not the same as your NetBSD login name. The target also automatically
                   10186:   removes possibly existing entries for the package in the
                   10187:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     10188:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 10189:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      10190:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   10191:   makes the cvs commands use the main repository.
                   10192:   </p>
1.75      rillig   10193: </div>
1.148     asau     10194: <div class="sect1">
1.75      rillig   10195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10196: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      10197: <p>For several years, there have been mirrors of pkgsrc in
1.375     jkoshy   10198:   fossil, git, and hg. Standard practice when using these tools is to
1.243     wiz      10199:   make the first line of a commit message function as a summary that
                   10200:   can be read without the rest, such as is commonly done with "git log
                   10201:   --oneline". For this reason, we have the following guidelines for
                   10202:   pkgsrc commit messages:</p>
                   10203: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10204: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      10205:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      10206:     package, include the name of the package. For updates, include the
                   10207:     version to which it is updated.</p></li>
                   10208: <li class="listitem"><p>Leave the next line empty.</p></li>
                   10209: <li class="listitem"><p>Then come the details for the commit (changes in that
                   10210:     package, reason for a change) and any relevant PRs. Wrap this
                   10211:     section.</p></li>
                   10212: </ul></div>
                   10213: <p>Here is an example:
1.352     wiz      10214: </p>
1.243     wiz      10215: <pre class="programlisting">
1.352     wiz      10216: libxslt: update to 1.0.30
1.243     wiz      10217: 
1.352     wiz      10218: Changes since 1.0.29:
                   10219: ...
                   10220: </pre>
1.243     wiz      10221: <p>
                   10222:   </p>
                   10223: <p>Here is another example:
1.352     wiz      10224: </p>
1.243     wiz      10225: <pre class="programlisting">
1.352     wiz      10226: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.243     wiz      10227: 
1.352     wiz      10228: (rationale)
                   10229: </pre>
1.243     wiz      10230: <p>
                   10231:   </p>
1.385     leot     10232: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
1.243     wiz      10233:   allowed on the pkgsrc repository to change commit messages.</p>
                   10234: </div>
                   10235: <div class="sect1">
                   10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10237: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      10238: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      10239:   access to the pkgsrc repository.</p>
1.385     leot     10240: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
1.140     wiz      10241: Start by adding the directory and then files in the directory. Don't
                   10242: forget to add the new package to the category's
                   10243: <code class="filename">Makefile</code>. Make sure you don't forget any files;
1.385     leot     10244: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
1.140     wiz      10245: <pre class="programlisting">
                   10246: <code class="prompt">$</code> cd .../pkgsrc/category
                   10247: <code class="prompt">$</code> cvs add pkgname
                   10248: <code class="prompt">$</code> cd pkgname
                   10249: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   10250: <code class="prompt">$</code> cvs add patches/p*
                   10251: <code class="prompt">$</code> cvs status | less
1.141     wiz      10252: <code class="prompt">$</code> cvs commit
1.140     wiz      10253: <code class="prompt">$</code> cd ..
1.350     gutterid 10254: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.141     wiz      10255: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     10256: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  10257: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      10258: </pre>
1.87      wiz      10259: <p>The commit message of the initial import should include part of the
1.76      rillig   10260:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      10261:   what the package is/does.</p>
1.140     wiz      10262: <p>Also mention the new package in
                   10263: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
1.385     leot     10264: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
                   10265: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75      rillig   10266: </div>
1.148     asau     10267: <div class="sect1">
1.75      rillig   10268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10269: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      10270: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   10271:   changes between old and new versions into the commit log when updating
1.87      wiz      10272:   a package. There are various reasons for this:</p>
1.148     asau     10273: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10274: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      10275:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      10276: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      10277:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      10278: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   10279:   repository is very useful for people who read the pkgsrc-changes mailing
                   10280:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      10281:   the package.</p></li>
1.75      rillig   10282: </ul></div>
1.87      wiz      10283: <p>Please also recognize that, just because a new version of a package
1.75      rillig   10284:   has been released, it should not automatically be upgraded in the CVS
                   10285:   repository.  We prefer to be conservative in the packages that are
                   10286:   included in pkgsrc - development or beta packages are not really the
                   10287:   best thing for most places in which pkgsrc is used. Please use your
                   10288:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      10289:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   10290: </div>
1.148     asau     10291: <div class="sect1">
1.75      rillig   10292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10293: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     10294: <p>Renaming packages is not recommended.</p>
1.290     gutterid 10295: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     10296:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     10297: <p>
1.290     gutterid 10298:   Also, when renaming a package, please add
1.282     leot     10299:   the package name and version pattern(s) of the previous package
                   10300:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     10301:   This may be repeated for multiple renames.
                   10302:   The new package would be an exact replacement.
1.282     leot     10303:   Example:
1.122     reed     10304: </p>
1.282     leot     10305: <pre class="programlisting">
                   10306: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   10307: SUPERSEDES+=    optcomp-[0-9]*
                   10308: </pre>
1.385     leot     10309: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122     reed     10310:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   10311:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   10312:   not be an exact replacement but is a suggestion for the replaced
                   10313:   functionality.</p>
                   10314: </div>
1.148     asau     10315: <div class="sect1">
1.122     reed     10316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10317: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     10318: <p>It is preferred that packages are not renamed or moved, but if needed
                   10319:   please follow these steps.
                   10320: </p>
1.128     wiz      10321: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10322: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   10323: <li class="listitem">
1.75      rillig   10324: <p>Remove all CVS dirs.</p>
1.87      wiz      10325: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   10326: <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      10327: <p>and use that for further work.</p>
1.75      rillig   10328: </li>
1.128     wiz      10329: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
1.385     leot     10330: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
                   10331: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
1.128     wiz      10332: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     10333: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   10334: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   10335: for doing an update using pkgsrc building; for example, it can
1.378     leot     10336: 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     10337: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   10338: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   10339: it may have multiple matches, so the tool should also check on the
                   10340: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   10341: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   10342: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.351     gutterid 10343: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.75      rillig   10344: place.</p></li>
1.128     wiz      10345: <li class="listitem">
1.75      rillig   10346: <p>Check if any package depends on it:
                   10347: </p>
                   10348: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   10349: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   10350: </li>
1.128     wiz      10351: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   10352: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   10353: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   10354: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   10355: <li class="listitem">
1.75      rillig   10356: <p>Commit the changed and removed files:</p>
                   10357: <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      10358: <p>(and any packages from step 5, of course).</p>
1.75      rillig   10359: </li>
                   10360: </ol></div>
                   10361: </div>
                   10362: </div>
1.148     asau     10363: <div class="chapter">
1.75      rillig   10364: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10365: <a name="policies"></a>Chapter 24. pkgsrc Policies</h2></div></div></div>
1.382     wiz      10366: <div class="toc">
                   10367: <p><b>Table of Contents</b></p>
                   10368: <dl class="toc">
                   10369: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
                   10370: <dd><dl>
                   10371: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
                   10372: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
                   10373: </dl></dd>
                   10374: </dl>
                   10375: </div>
                   10376: <div class="sect1">
                   10377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10378: <a name="stability"></a>24.1. Packages for which updating is restricted</h2></div></div></div>
1.382     wiz      10379: <p>In the past, some packages have caused more package failures than others, and we'd like to reduce this in the future.</p>
                   10380: <p>For this reason, pkgsrc-pmc marks some packages with <code class="varname">POLICY_UPDATE_LIMITED</code>. The possible values currently are:
                   10381: </p>
                   10382: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10383: <li class="listitem"><p><code class="literal">abi</code> for packages where ABI/API changes often broke the packages depending on them</p></li>
                   10384: <li class="listitem"><p><code class="literal">bootstrap</code> for packages that are used during the pkgsrc bootstrap</p></li>
                   10385: </ul></div>
                   10386: <p>
                   10387: <code class="filename">pkglint</code> will warn when committing updates to these packages.</p>
                   10388: <div class="sect2">
                   10389: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10390: <a name="stability.abi"></a>24.1.1. Limited Updates - ABI</h3></div></div></div>
1.382     wiz      10391: <p>Before committing non-micro version updates to packages marked
                   10392:   with <code class="varname">POLICY_UPDATE_LIMITED=abi</code>, a limited bulk
                   10393:   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
                   10394:   and the result posted to the tech-pkg mailing list, highlighting
                   10395:   what packages would stop building (if any).</p>
                   10396: <p>Depending on the result, pkgsrc-pmc then decides:
                   10397:   </p>
                   10398: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   10399: <li class="listitem"><p>go ahead with the update</p></li>
                   10400: <li class="listitem"><p>wait for packages X, Y, Z to be fixed (upstream or
                   10401:     locally) with the updated version, which is put in wip in the
                   10402:     meantime</p></li>
                   10403: <li class="listitem"><p>In the second case, all pkgsrc developers are
                   10404:     encouraged to work on fixing this - it is not only the updater's
                   10405:     task to fix them.</p></li>
                   10406: </ul></div>
                   10407: <p>
                   10408:   </p>
                   10409: <p>The decision to wait for packages can be revisited.</p>
                   10410: </div>
                   10411: <div class="sect2">
                   10412: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10413: <a name="stability.bootstrap"></a>24.1.2. Limited Updates - Bootstrap</h3></div></div></div>
1.382     wiz      10414: <p>When updating packages used in the bootstrap, i.e. marked with
                   10415:   <code class="varname">POLICY_UPDATE_LIMITED=bootstrap</code>, test the
                   10416:   bootstrap process and preferably some basic packages and send the
                   10417:   patch to the tech-pkg mailing list so it can be tested on other
                   10418:   platforms as well. Give at least two weeks for feedback and testing
                   10419:   by others.</p>
                   10420: </div>
                   10421: </div>
                   10422: </div>
                   10423: <div class="chapter">
                   10424: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10425: <a name="devfaq"></a>Chapter 25. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   10426: <p>This section contains the answers to questions that may
                   10427:        arise when you are writing a package. If you don't find your
                   10428:        question answered here, first have a look in the other chapters,
                   10429:        and if you still don't have the answer, ask on the
                   10430:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     10431: <div class="qandaset">
1.289     leot     10432: <a name="devfaq.qandaset"></a><dl>
1.382     wiz      10433: <dt>25.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   10434:        MAKEFLAGS, .MAKEFLAGS and
                   10435:        MAKE_FLAGS?</a>
                   10436: </dt>
1.382     wiz      10437: <dt>25.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   10438:        MAKE, GMAKE and
                   10439:        MAKE_PROGRAM?</a>
                   10440: </dt>
1.382     wiz      10441: <dt>25.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   10442:        CC, PKG_CC and
                   10443:        PKGSRC_COMPILER?</a>
                   10444: </dt>
1.382     wiz      10445: <dt>25.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   10446:        VARNAME=BUILDLINK_PREFIX.foo
                   10447:        say it's empty?</a>
                   10448: </dt>
1.382     wiz      10449: <dt>25.5. <a href="#devfaq.master_sites">What does
1.78      rillig   10450:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   10451:        don't understand the := inside
                   10452:        it.</a>
                   10453: </dt>
1.382     wiz      10454: <dt>25.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   10455:        developers?</a>
                   10456: </dt>
1.382     wiz      10457: <dt>25.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   10458:        documentation?</a>
                   10459: </dt>
1.382     wiz      10460: <dt>25.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289     leot     10461: What shall I do?</a>
1.92      rillig   10462: </dt>
1.75      rillig   10463: </dl>
1.148     asau     10464: <table border="0" style="width: 100%;">
                   10465: <colgroup>
1.75      rillig   10466: <col align="left" width="1%">
1.128     wiz      10467: <col>
1.148     asau     10468: </colgroup>
1.75      rillig   10469: <tbody>
1.148     asau     10470: <tr class="question">
1.75      rillig   10471: <td align="left" valign="top">
1.382     wiz      10472: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>25.1.</b></p>
1.75      rillig   10473: </td>
                   10474: <td align="left" valign="top"><p>What is the difference between
                   10475:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10476:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10477: </tr>
                   10478: <tr class="answer">
1.91      rillig   10479: <td align="left" valign="top"></td>
1.338     nia      10480: <td align="left" valign="top">
                   10481: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.378     leot     10482:        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      10483: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
                   10484:        passed to the <code class="varname">MAKE_PROGRAM</code> when building the
                   10485:        package.</p>
                   10486: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
                   10487:        <span class="command"><strong>bmake</strong></span> and should not be used by
                   10488:        packages.</p>
                   10489: </td>
1.75      rillig   10490: </tr>
1.148     asau     10491: <tr class="question">
1.75      rillig   10492: <td align="left" valign="top">
1.382     wiz      10493: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>25.2.</b></p>
1.75      rillig   10494: </td>
                   10495: <td align="left" valign="top"><p>What is the difference between
                   10496:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10497:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10498: </tr>
                   10499: <tr class="answer">
1.91      rillig   10500: <td align="left" valign="top"></td>
1.338     nia      10501: <td align="left" valign="top">
                   10502: <p><code class="varname">MAKE</code> is the path to the
1.378     leot     10503:        <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      10504:        infrastructure.</p>
                   10505: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
                   10506:        need to say <code class="varname">USE_TOOLS+=gmake</code> to use
                   10507:        that.</p>
                   10508: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
                   10509:        program that is used for building the package.</p>
                   10510: </td>
1.75      rillig   10511: </tr>
1.148     asau     10512: <tr class="question">
1.75      rillig   10513: <td align="left" valign="top">
1.382     wiz      10514: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>25.3.</b></p>
1.75      rillig   10515: </td>
                   10516: <td align="left" valign="top"><p>What is the difference between
                   10517:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10518:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10519: </tr>
                   10520: <tr class="answer">
1.91      rillig   10521: <td align="left" valign="top"></td>
1.75      rillig   10522: <td align="left" valign="top">
1.338     nia      10523: <p><code class="varname">CC</code> is the path to the real C
                   10524:        compiler, which can be configured by the pkgsrc user.</p>
                   10525: <p><code class="varname">PKG_CC</code> is the path to the compiler
                   10526:        wrapper.</p>
                   10527: <p><code class="varname">PKGSRC_COMPILER</code> is
                   10528:        <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
                   10529:        compiler that should be used. See
                   10530:        <code class="filename">mk/compiler.mk</code> for more information about
                   10531:        the latter variable.</p>
1.75      rillig   10532: </td>
                   10533: </tr>
1.148     asau     10534: <tr class="question">
1.75      rillig   10535: <td align="left" valign="top">
1.382     wiz      10536: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>25.4.</b></p>
1.75      rillig   10537: </td>
1.110     hubertf  10538: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10539:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10540:        say it's empty?</p></td>
                   10541: </tr>
                   10542: <tr class="answer">
1.91      rillig   10543: <td align="left" valign="top"></td>
1.75      rillig   10544: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.385     leot     10545:        available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
                   10546:        <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110     hubertf  10547:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10548:        command.</p></td>
                   10549: </tr>
1.148     asau     10550: <tr class="question">
1.78      rillig   10551: <td align="left" valign="top">
1.382     wiz      10552: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>25.5.</b></p>
1.78      rillig   10553: </td>
                   10554: <td align="left" valign="top"><p>What does
1.220     wiz      10555:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10556:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10557:        it.</p></td>
                   10558: </tr>
                   10559: <tr class="answer">
1.91      rillig   10560: <td align="left" valign="top"></td>
1.338     nia      10561: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
                   10562:        assignment operator, even though it may look like one.
1.78      rillig   10563:        Instead, it is a degenerate form of
1.220     wiz      10564:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.378     leot     10565:        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      10566:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10567:        case of <code class="varname">MASTER_SITE_*</code>,
                   10568:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10569:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10570:        <code class="code">package/</code>. That's where the
                   10571:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10572:        together.</p></td>
                   10573: </tr>
1.148     asau     10574: <tr class="question">
1.78      rillig   10575: <td align="left" valign="top">
1.382     wiz      10576: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>25.6.</b></p>
1.78      rillig   10577: </td>
                   10578: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10579:        developers?</p></td>
                   10580: </tr>
                   10581: <tr class="answer">
1.91      rillig   10582: <td align="left" valign="top"></td>
1.148     asau     10583: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10584: <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   10585: <dd><p>This is a list for technical discussions related
                   10586:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10587:        pkgsrc infrastructure, proposed new features, questions related
                   10588:        to porting pkgsrc to a new platform, advice for maintaining a
                   10589:        package, patches that affect many packages, help requests moved
                   10590:        from pkgsrc-users when an infrastructure bug is found,
                   10591:        etc.</p></dd>
1.289     leot     10592: <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   10593: <dd><p>All bug reports in category "pkg" sent with
1.378     leot     10594:        <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   10595:        directly; use one of the other mailing
                   10596:        lists.</p></dd>
                   10597: </dl></div></td>
                   10598: </tr>
1.148     asau     10599: <tr class="question">
1.80      rillig   10600: <td align="left" valign="top">
1.382     wiz      10601: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>25.7.</b></p>
1.80      rillig   10602: </td>
                   10603: <td align="left" valign="top"><p>Where is the pkgsrc
                   10604:        documentation?</p></td>
                   10605: </tr>
                   10606: <tr class="answer">
1.91      rillig   10607: <td align="left" valign="top"></td>
1.80      rillig   10608: <td align="left" valign="top">
                   10609: <p>There are many places where you can find
                   10610:        documentation about pkgsrc:</p>
1.148     asau     10611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10612: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10613:        of chapters that explain large parts of pkgsrc, but some
                   10614:        chapters tend to be outdated. Which ones they are is hard to
                   10615:        say.</p></li>
1.289     leot     10616: <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   10617:        about certain features, announcements of new parts of the pkgsrc
                   10618:        infrastructure and sometimes even announcements that a certain
                   10619:        feature has been marked as obsolete. The benefit here is that
                   10620:        each message has a date appended to it.</p></li>
1.128     wiz      10621: <li class="listitem"><p>Many of the files in the
1.80      rillig   10622:        <code class="filename">mk/</code> directory start with a comment that
                   10623:        describes the purpose of the file and how it can be used by the
1.92      rillig   10624:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10625:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10626:        help</strong></span>.</p></li>
1.128     wiz      10627: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10628:        information, but they tend to be highly abbreviated, especially
                   10629:        for actions that occur often. Some contain a detailed
                   10630:        description of what has changed, but they are geared towards the
                   10631:        other pkgsrc developers, not towards an average pkgsrc user.
                   10632:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10633:        don't know what has been before, these messages may not be worth
                   10634:        too much to you.</p></li>
1.385     leot     10635: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
                   10636:        documented</span>”</span>, that is the documentation exists only in the
1.80      rillig   10637:        mind of the developer who wrote the code. To get this
1.110     hubertf  10638:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10639:        to see who has written it and ask on the
                   10640:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10641:        find your questions later (see above). To be sure that the
                   10642:        developer in charge reads the mail, you may CC him or
                   10643:        her.</p></li>
                   10644: </ul></div>
1.299     rillig   10645: </td>
                   10646: </tr>
                   10647: <tr class="question">
                   10648: <td align="left" valign="top">
1.382     wiz      10649: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>25.8.</b></p>
1.299     rillig   10650: </td>
1.338     nia      10651: <td align="left" valign="top"><p>I have a little time to kill.
1.299     rillig   10652: What shall I do?</p></td>
                   10653: </tr>
                   10654: <tr class="answer">
                   10655: <td align="left" valign="top"></td>
                   10656: <td align="left" valign="top">
                   10657: <p>This is not really an FAQ yet, but here's the answer
                   10658: anyway.</p>
1.148     asau     10659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10660: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322     leot     10661:     <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   10662:     will tell you about newer versions of installed packages that are
                   10663:     available, but not yet updated in pkgsrc.</p></li>
                   10664: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10665:     &mdash; it contains a list of suggested new packages and a list of
                   10666:     cleanups and enhancements for pkgsrc that would be nice to
                   10667:     have.</p></li>
                   10668: <li class="listitem"><p>Review packages for which review was requested on
                   10669:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10670:     mailing list.</p></li>
1.85      jmmv     10671: </ul></div>
1.299     rillig   10672: </td>
1.85      jmmv     10673: </tr>
                   10674: </tbody>
1.299     rillig   10675: </table>
1.85      jmmv     10676: </div>
                   10677: </div>
1.75      rillig   10678: </div>
1.148     asau     10679: <div class="part">
1.75      rillig   10680: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     10681: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10682: <div class="partintro">
1.75      rillig   10683: <div></div>
                   10684: <p>This part of the guide deals with everything
                   10685:        from the infrastructure that is behind the interfaces described
                   10686:        in the developer's guide. A casual package maintainer should not
                   10687:        need anything from this part.</p>
                   10688: <div class="toc">
                   10689: <p><b>Table of Contents</b></p>
1.210     leot     10690: <dl class="toc">
1.382     wiz      10691: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10692: <dd><dl>
1.382     wiz      10693: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10694: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10695: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75      rillig   10696: <dd><dl>
1.382     wiz      10697: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10698: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75      rillig   10699: </dl></dd>
1.382     wiz      10700: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10701: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10702: <dd><dl>
1.382     wiz      10703: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10704: <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   10705: </dl></dd>
1.382     wiz      10706: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10707: <dd><dl>
1.382     wiz      10708: <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>
                   10709: <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   10710: </dl></dd>
                   10711: </dl></dd>
1.382     wiz      10712: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig   10713: <dd><dl>
1.382     wiz      10714: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10715: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10716: <dd><dl>
1.382     wiz      10717: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10718: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10719: </dl></dd>
                   10720: </dl></dd>
1.382     wiz      10721: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   10722: <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   10723: </dl>
                   10724: </div>
                   10725: </div>
1.148     asau     10726: <div class="chapter">
1.75      rillig   10727: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     10728: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10729: <div class="toc">
                   10730: <p><b>Table of Contents</b></p>
1.210     leot     10731: <dl class="toc">
1.382     wiz      10732: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   10733: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   10734: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig   10735: <dd><dl>
1.382     wiz      10736: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   10737: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig   10738: </dl></dd>
1.382     wiz      10739: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   10740: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10741: <dd><dl>
1.382     wiz      10742: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   10743: <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   10744: </dl></dd>
1.382     wiz      10745: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10746: <dd><dl>
1.382     wiz      10747: <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>
                   10748: <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   10749: </dl></dd>
                   10750: </dl>
                   10751: </div>
                   10752: <p>The pkgsrc infrastructure consists of many small Makefile
                   10753:        fragments. Each such fragment needs a properly specified
                   10754:        interface. This chapter explains how such an interface looks
                   10755:        like.</p>
1.148     asau     10756: <div class="sect1">
1.75      rillig   10757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10758: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10759: <p>Whenever a variable is defined in the pkgsrc
                   10760:        infrastructure, the location and the way of definition provide
                   10761:        much information about the intended use of that variable.
                   10762:        Additionally, more documentation may be found in a header
                   10763:        comment or in this pkgsrc guide.</p>
                   10764: <p>A special file is
                   10765:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10766:        variables that are intended to be user-defined. They are either
                   10767:        defined using the <code class="literal">?=</code> operator or they are
                   10768:        left undefined because defining them to anything would
1.385     leot     10769:        effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81      rillig   10770:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10771:        file.</p>
                   10772: <p>Outside this file, the following conventions apply:
                   10773:        Variables that are defined using the <code class="literal">?=</code>
                   10774:        operator may be overridden by a package.</p>
                   10775: <p>Variables that are defined using the <code class="literal">=</code>
                   10776:        operator may be used read-only at run-time.</p>
                   10777: <p>Variables whose name starts with an underscore must not be
                   10778:        accessed outside the pkgsrc infrastructure at all. They may
                   10779:        change without further notice.</p>
1.148     asau     10780: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10781: <h3 class="title">Note</h3>
                   10782: <p>These conventions are currently not applied
                   10783:        consistently to the complete pkgsrc
                   10784:        infrastructure.</p>
                   10785: </div>
                   10786: </div>
1.148     asau     10787: <div class="sect1">
1.81      rillig   10788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10789: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10790: <p>All variables that contain lists of things should default
                   10791:        to being empty. Two examples that do not follow this rule are
                   10792:        <code class="varname">USE_LANGUAGES</code> and
                   10793:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10794:        modified using the <code class="literal">+=</code> operator in package
                   10795:        <code class="filename">Makefile</code>s (or other files included by
                   10796:        them), since there is no guarantee whether the variable is
                   10797:        already set or not, and what its value is. In the case of
1.385     leot     10798:        <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81      rillig   10799:        the default value and just define it as in the following
                   10800:        example.</p>
                   10801: <pre class="programlisting">
1.100     rillig   10802: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10803: </pre>
                   10804: <p>Because of the selection of this default value, the same
                   10805:        value appears in many package Makefiles. Similarly for
                   10806:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.385     leot     10807:        value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81      rillig   10808:        doesn't stand out. Nevertheless it is mentioned in many
                   10809:        files.</p>
                   10810: </div>
1.148     asau     10811: <div class="sect1">
1.81      rillig   10812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10813: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148     asau     10814: <div class="sect2">
1.75      rillig   10815: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10816: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75      rillig   10817: <p>Variable evaluation takes place either at load time or at
                   10818:        runtime, depending on the context in which they occur. The
                   10819:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10820: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10821: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10822:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10823: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10824:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10825: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10826: </ul></div>
                   10827: <p>A special exception are references to the iteration
                   10828:        variables of <code class="literal">.for</code> loops, which are expanded
                   10829:        inline, no matter in which context they appear.</p>
                   10830: <p>As the values of variables may change during load time,
                   10831:        care must be taken not to evaluate them by accident. Typical
                   10832:        examples for variables that should not be evaluated at load time
                   10833:        are <code class="varname">DEPENDS</code> and
                   10834:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10835:        clear, here is an example:</p>
                   10836: <pre class="programlisting">
1.100     rillig   10837: CONFIGURE_ARGS=         # none
                   10838: CFLAGS=                 -O
                   10839: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10840: 
1.100     rillig   10841: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10842: 
1.100     rillig   10843: CFLAGS+=                -Wall
1.222     sevan    10844: </pre>
1.75      rillig   10845: <p>This code shows how the use of the <code class="literal">:=</code>
                   10846:        operator can quickly lead to unexpected results. The first
                   10847:        paragraph is fairly common code. The second paragraph evaluates
                   10848:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10849:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10850:        <code class="literal">-Wall</code> is appended to the
                   10851:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10852:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10853:        paragraphs from above typically occur in completely unrelated
                   10854:        files.</p>
                   10855: </div>
1.148     asau     10856: <div class="sect2">
1.75      rillig   10857: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10858: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75      rillig   10859: <p>After all the files have been loaded, the values of the
                   10860:        variables cannot be changed anymore. Variables that are used in
                   10861:        the shell commands are expanded at this point.</p>
                   10862: </div>
                   10863: </div>
1.148     asau     10864: <div class="sect1">
1.75      rillig   10865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10866: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10867: <p>There are many ways in which the definition and use of a
1.218     rillig   10868:        variable can be restricted in order to detect bugs and violations
                   10869:        of the (mostly unwritten) policies. A package can be checked with
                   10870:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10871:        rules.</p>
1.78      rillig   10872: </div>
1.148     asau     10873: <div class="sect1">
1.78      rillig   10874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10875: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10876: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10877:        of the following classes. Cases where a file falls into more
                   10878:        than one class should be avoided as it often leads to subtle
                   10879:        bugs.</p>
1.148     asau     10880: <div class="sect2">
1.75      rillig   10881: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10882: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10883: <p>In a traditional imperative programming language some of
1.76      rillig   10884:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10885:        procedures. They take some input parameters and&mdash;after
                   10886:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10887:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10888:        care must be taken not to use parameter names that have already
                   10889:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10890:        bad choice for a parameter name.</p>
                   10891: <p>Procedures are completely evaluated at preprocessing time.
                   10892:        That is, when calling a procedure all input parameters must be
                   10893:        completely resolvable. For example,
                   10894:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10895:        parameter since it is very likely that further text will be
                   10896:        added after calling the procedure, which would effectively apply
                   10897:        the procedure to only a part of the variable. Also, references
1.218     rillig   10898:        to other variables will be modified after calling the
1.75      rillig   10899:        procedure.</p>
                   10900: <p>A procedure can declare its output parameters either as
                   10901:        suitable for use in preprocessing directives or as only
                   10902:        available at runtime. The latter alternative is for variables
                   10903:        that contain references to other runtime variables.</p>
                   10904: <p>Procedures shall be written such that it is possible to
                   10905:        call the procedure more than once. That is, the file must not
                   10906:        contain multiple-inclusion guards.</p>
                   10907: <p>Examples for procedures are
1.76      rillig   10908:        <code class="filename">mk/bsd.options.mk</code> and
                   10909:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10910:        that the parameters are evaluated at load time, they should be
                   10911:        assigned using the <code class="literal">:=</code> operator, which should
                   10912:        be used only for this purpose.</p>
                   10913: </div>
1.148     asau     10914: <div class="sect2">
1.75      rillig   10915: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10916: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10917: <p>Action files take some input parameters and may define
                   10918:        runtime variables. They shall not define loadtime variables.
                   10919:        There are action files that are included implicitly by the
                   10920:        pkgsrc infrastructure, while other must be included
                   10921:        explicitly.</p>
                   10922: <p>An example for action files is
1.76      rillig   10923:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10924: </div>
                   10925: </div>
1.148     asau     10926: <div class="sect1">
1.81      rillig   10927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     10928: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10929: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10930:        a set of variable definitions, and include the file
                   10931:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10932:        Before that, they may also include various other
                   10933:        <code class="filename">*.mk</code> files if they need to query the
                   10934:        availability of certain features like the type of compiler or
                   10935:        the X11 implementation. Due to the heavy use of preprocessor
                   10936:        directives like <code class="literal">.if</code> and
                   10937:        <code class="literal">.for</code>, the order in which the files are loaded
                   10938:        matters.</p>
                   10939: <p>This section describes at which point the various files
                   10940:        are loaded and gives reasons for that order.</p>
1.148     asau     10941: <div class="sect2">
1.81      rillig   10942: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10943: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10944: </h3></div></div></div>
                   10945: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10946:        is to define some essential variables like
                   10947:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10948:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10949: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10950:        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   10951:        After that, those variables
1.81      rillig   10952:        that have not been overridden by the user are loaded from
                   10953:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10954: <p>After the user settings, the system settings and platform
                   10955:        settings are loaded, which may override the user
                   10956:        settings.</p>
                   10957: <p>Then, the tool definitions are loaded. The tool wrappers
                   10958:        are not yet in effect. This only happens when building a
                   10959:        package, so the proper variables must be used instead of the
                   10960:        direct tool names.</p>
                   10961: <p>As the last steps, some essential variables from the
                   10962:        wrapper and the package system flavor are loaded, as well as the
                   10963:        variables that have been cached in earlier phases of a package
                   10964:        build.</p>
                   10965: </div>
1.148     asau     10966: <div class="sect2">
1.81      rillig   10967: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     10968: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10969: </h3></div></div></div>
1.81      rillig   10970: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10971: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10972:        loaded, which fill default values for those variables that have
1.93      rillig   10973:        not been defined by the package. These variables may later
1.81      rillig   10974:        be used even in unrelated files.</p>
                   10975: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10976:        provides the target <code class="literal">error-check</code> that is added
                   10977:        as a special dependency to all other targets that use
                   10978:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10979:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10980: <p>Then, the package-specific hacks from
                   10981:        <code class="filename">hacks.mk</code> are included.</p>
                   10982: <p>Then, various other files follow. Most of them don't have
                   10983:        any dependencies on what they need to have included before or
                   10984:        after them, though some do.</p>
                   10985: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10986:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10987:        restricts the use of these variables to all the files that have
                   10988:        been included before. Appearances in later files will be
                   10989:        silently ignored.</p>
                   10990: <p>Then, the files for the main targets are included, in the
                   10991:        order of later execution, though the actual order should not
                   10992:        matter.</p>
                   10993: <p>At last, some more files are included that don't set any
                   10994:        interesting variables but rather just define make targets to be
                   10995:        executed.</p>
                   10996: </div>
                   10997: </div>
1.75      rillig   10998: </div>
1.148     asau     10999: <div class="chapter">
1.75      rillig   11000: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     11001: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75      rillig   11002: <div class="toc">
                   11003: <p><b>Table of Contents</b></p>
1.210     leot     11004: <dl class="toc">
1.382     wiz      11005: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   11006: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   11007: <dd><dl>
1.382     wiz      11008: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   11009: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   11010: </dl></dd>
                   11011: </dl>
                   11012: </div>
                   11013: <p>The pkgsrc infrastructure consists of a large codebase,
                   11014:        and there are many corners where every little bit of a file is
                   11015:        well thought out, making pkgsrc likely to fail as soon as
                   11016:        anything is changed near those parts. To prevent most changes
                   11017:        from breaking anything, a suite of regression tests should go
                   11018:        along with every important part of the pkgsrc infrastructure.
                   11019:        This chapter describes how regression tests work in pkgsrc and
                   11020:        how you can add new tests.</p>
1.148     asau     11021: <div class="sect1">
1.75      rillig   11022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11023: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.322     leot     11024: <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  11025:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   11026:        can simply run that command, which will run all tests in the
1.283     rillig   11027:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   11028: </div>
1.148     asau     11029: <div class="sect1">
1.75      rillig   11030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11031: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   11032: <p>Every directory in the <code class="filename">regress/</code>
                   11033:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   11034:        is considered a regression test. This file is a shell program
1.110     hubertf  11035:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   11036:        The following functions can be overridden to suit your
                   11037:        needs.</p>
1.148     asau     11038: <div class="sect2">
1.75      rillig   11039: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11040: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   11041: <p>These functions do not take any parameters. Although they
1.385     leot     11042:        are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289     leot     11043:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   11044:        question</a> for details.</p>
1.148     asau     11045: <div class="variablelist"><dl class="variablelist">
1.218     rillig   11046: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   11047: <dd><p>This function prepares the environment for the
                   11048:        test. By default it does nothing.</p></dd>
1.218     rillig   11049: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   11050: <dd>
                   11051: <p>This function runs the actual test. By default,
1.75      rillig   11052:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   11053:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   11054:        error messages into the file
1.218     rillig   11055:        <code class="varname">TEST_OUTFILE</code>.</p>
                   11056: <p>When defining this function, make sure that all output that
                   11057:        needs to be checked is written to the correct output file.
                   11058:        Example:</p>
                   11059: <pre class="programlisting">
                   11060: do_test() {
1.223     rillig   11061:         echo "Example output"
1.218     rillig   11062: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   11063: </pre>
                   11064: </dd>
                   11065: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   11066: <dd>
                   11067: <p>This function is run after the test and is
1.75      rillig   11068:        typically used to compare the actual output from the one that is
                   11069:        expected. It can make use of the various helper functions from
1.218     rillig   11070:        the next section. Example:</p>
                   11071: <pre class="programlisting">
                   11072: check_result() {
1.223     rillig   11073:         exit_status 0
                   11074:         output_require "Example"
                   11075:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   11076:         output_prohibit "no such file or directory"
1.283     rillig   11077:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   11078: }
                   11079: </pre>
                   11080: </dd>
                   11081: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   11082: <dd><p>This function cleans everything up after the
                   11083:        test has been run. By default it does nothing.</p></dd>
                   11084: </dl></div>
                   11085: </div>
1.148     asau     11086: <div class="sect2">
1.75      rillig   11087: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11088: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148     asau     11089: <div class="variablelist"><dl class="variablelist">
1.283     rillig   11090: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   11091: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   11092: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   11093: <dd><p>This function compares the exitcode of the
1.218     rillig   11094:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   11095:        If they differ, the test will fail.</p></dd>
1.218     rillig   11096: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   11097: <dd>
                   11098: <p>This function checks for each of its parameters
                   11099:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   11100:        extended regular expression. If it does not, the test will
1.218     rillig   11101:        fail. Example:</p>
                   11102: <pre class="programlisting">
1.219     rillig   11103: output_require "looks fine"
                   11104: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   11105: </pre>
                   11106: </dd>
1.292     leot     11107: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   11108: <dd><p>This function checks for each of its parameters
1.110     hubertf  11109:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   11110:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   11111:        If any of the regular expressions matches, the test will
                   11112:        fail.</p></dd>
                   11113: </dl></div>
                   11114: </div>
                   11115: </div>
                   11116: </div>
1.148     asau     11117: <div class="chapter">
1.75      rillig   11118: <div class="titlepage"><div><div><h2 class="title">
1.385     leot     11119: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75      rillig   11120: <div class="toc">
                   11121: <p><b>Table of Contents</b></p>
1.382     wiz      11122: <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   11123: </div>
                   11124: <p>The pkgsrc system has already been ported to many
                   11125:        operating systems, hardware architectures and compilers. This
                   11126:        chapter explains the necessary steps to make pkgsrc even more
                   11127:        portable.</p>
1.148     asau     11128: <div class="sect1">
1.75      rillig   11129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11130: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   11131: <p>To port pkgsrc to a new operating system (called
                   11132:        <code class="literal">MyOS</code> in this example), you need to touch the
                   11133:        following files:</p>
1.148     asau     11134: <div class="variablelist"><dl class="variablelist">
1.93      rillig   11135: <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   11136: <dd><p>This file contains some basic definitions, for
                   11137:        example the name of the C
                   11138:        compiler.</p></dd>
1.76      rillig   11139: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   11140: <dd><p>Insert code that defines the variables
                   11141:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327     wiz      11142:        <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75      rillig   11143:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   11144:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   11145:        appear in this file.</p></dd>
1.93      rillig   11146: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11147: <dd><p>This file contains the platform-specific
                   11148:        definitions that are used by pkgsrc. Start by copying one of the
                   11149:        other files and edit it to your
                   11150:        needs.</p></dd>
1.93      rillig   11151: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   11152: <dd><p>This file defines the paths to all the tools
                   11153:        that are needed by one or the other package in pkgsrc, as well
                   11154:        as by pkgsrc itself. Find out where these tools are on your
                   11155:        platform and add them.</p></dd>
                   11156: </dl></div>
                   11157: <p>Now, you should be able to build some basic packages, like
1.322     leot     11158:        <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   11159: </div>
                   11160: </div>
                   11161: </div>
1.148     asau     11162: <div class="appendix">
                   11163: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11164: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   11165: <div class="toc">
                   11166: <p><b>Table of Contents</b></p>
1.210     leot     11167: <dl class="toc">
1.75      rillig   11168: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   11169: <dd><dl>
                   11170: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   11171: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   11172: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   11173: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   11174: </dl></dd>
                   11175: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   11176: </dl>
                   11177: </div>
                   11178: <p>We checked to find a piece of software that wasn't in the packages
                   11179:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  11180:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   11181:     present in the tree is beyond us, but it's useful for the purposes of
                   11182:     this exercise.</p>
1.148     asau     11183: <div class="sect1">
1.75      rillig   11184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11185: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     11186: <div class="sect2">
1.75      rillig   11187: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11188: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
1.75      rillig   11189: <pre class="programlisting">
1.100     rillig   11190: # $NetBSD$
                   11191: #
1.1       grant    11192: 
1.100     rillig   11193: DISTNAME=       bison-1.25
                   11194: CATEGORIES=     devel
1.286     rillig   11195: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    11196: 
1.136     dholland 11197: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     11198: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   11199: COMMENT=        GNU yacc clone
1.1       grant    11200: 
1.100     rillig   11201: GNU_CONFIGURE=  yes
1.152     wiz      11202: INFO_FILES=     yes
1.1       grant    11203: 
1.100     rillig   11204: .include "../../mk/bsd.pkg.mk"
1.1       grant    11205: </pre>
1.75      rillig   11206: </div>
1.148     asau     11207: <div class="sect2">
1.75      rillig   11208: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11209: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
1.75      rillig   11210: <pre class="programlisting">
1.100     rillig   11211: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.378     leot     11212: 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   11213: of the NetBSD source tree is beyond me.
1.1       grant    11214: </pre>
1.75      rillig   11215: </div>
1.148     asau     11216: <div class="sect2">
1.75      rillig   11217: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11218: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
1.75      rillig   11219: <pre class="programlisting">
1.100     rillig   11220: @comment $NetBSD$
                   11221: bin/bison
                   11222: man/man1/bison.1.gz
                   11223: share/bison.simple
                   11224: share/bison.hairy
1.1       grant    11225: </pre>
1.75      rillig   11226: </div>
1.148     asau     11227: <div class="sect2">
1.75      rillig   11228: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11229: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   11230: <p>The NetBSD package system comes with
1.322     leot     11231:         <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   11232:        which helps to check the contents of these
                   11233:        files. After installation it is quite easy to use, just change to the
1.286     rillig   11234:        directory of the package you wish to examine and run
1.110     hubertf  11235:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   11236: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   11237: ERROR: Makefile: Each package must define its LICENSE.
                   11238: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   11239: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   11240: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   11241: 1 error, 2 warnings and 1 note found.
                   11242: (Run "pkglint -e" to show explanations.)
                   11243: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   11244: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   11245: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   11246:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   11247:        -Wall</strong></span> for a very thorough check.</p>
                   11248: </div>
                   11249: </div>
1.148     asau     11250: <div class="sect1">
1.75      rillig   11251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11252: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
1.75      rillig   11253: <p>Create the directory where the package lives,
                   11254:       plus any auxiliary directories:</p>
                   11255: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   11256: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   11257: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   11258: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   11259: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.385     leot     11260:       <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   11261:       then continue with fetching the distfile:</p>
                   11262: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    11263: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   11264: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   11265: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11266: ftp: Error retrieving file: 500 Internal error
                   11267: 
                   11268: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   11269: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   11270: ftp: Error retrieving file: 500 Internal error
                   11271: 
                   11272: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   11273: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   11274: Successfully retrieved file.</pre>
                   11275: <p>Generate the checksum of the distfile into
1.76      rillig   11276:       <code class="filename">distinfo</code>:</p>
1.88      wiz      11277: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   11278: <p>Now compile:</p>
                   11279: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    11280: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11281: ===&gt;  Extracting for bison-1.25
                   11282: ===&gt;  Patching for bison-1.25
                   11283: ===&gt;   Ignoring empty patch directory
                   11284: ===&gt;  Configuring for bison-1.25
                   11285: creating cache ./config.cache
                   11286: checking for gcc... cc
                   11287: checking whether we are using GNU C... yes
                   11288: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   11289: checking how to run the C preprocessor... cc -E
                   11290: checking for minix/config.h... no
                   11291: checking for POSIXized ISC... no
                   11292: checking whether cross-compiling... no
                   11293: checking for ANSI C header files... yes
                   11294: checking for string.h... yes
                   11295: checking for stdlib.h... yes
                   11296: checking for memory.h... yes
                   11297: checking for working const... yes
                   11298: checking for working alloca.h... no
                   11299: checking for alloca... yes
                   11300: checking for strerror... yes
                   11301: updating cache ./config.cache
                   11302: creating ./config.status
                   11303: creating Makefile
                   11304: ===&gt;  Building for bison-1.25
                   11305: 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
                   11306: 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
                   11307: 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
                   11308: 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
                   11309: 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   11310: 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    11311: 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
                   11312: 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
                   11313: 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
                   11314: 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
                   11315: 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
                   11316: 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
                   11317: 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
                   11318: 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
                   11319: 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
                   11320: 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
                   11321: 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
                   11322: 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
                   11323: 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
                   11324: 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
                   11325: 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
                   11326: 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
                   11327: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   11328: rm -f bison.s1
1.75      rillig   11329: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   11330: <p>Everything seems OK, so install the files:</p>
                   11331: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    11332: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11333: ===&gt;  Installing for bison-1.25
                   11334: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   11335: rm -f /usr/pkg/bin/bison
                   11336: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   11337: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   11338: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   11339: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   11340: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   11341: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   11342: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   11343: ===&gt;  Registering installation for bison-1.25</pre>
                   11344: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  11345:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   11346:       binary package, do this now:</p>
                   11347: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11348: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11349: ===&gt;  Building package for bison-1.25
                   11350: Creating package bison-1.25.tgz
                   11351: Registering depends:.
1.75      rillig   11352: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   11353: <p>Now that you don't need the source and object files
                   11354:       any more, clean up:</p>
                   11355: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   11356: ===&gt;  Cleaning for bison-1.25</pre>
                   11357: </div>
                   11358: </div>
1.148     asau     11359: <div class="appendix">
                   11360: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11361: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75      rillig   11362: <div class="toc">
                   11363: <p><b>Table of Contents</b></p>
1.210     leot     11364: <dl class="toc">
1.322     leot     11365: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
                   11366: <dd><dl>
                   11367: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
                   11368: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
                   11369: </dl></dd>
                   11370: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
                   11371: <dd><dl>
                   11372: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
                   11373: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
                   11374: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
                   11375: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
                   11376: </dl></dd>
                   11377: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
                   11378: <dd><dl>
                   11379: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
                   11380: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
                   11381: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
                   11382: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
                   11383: </dl></dd>
1.75      rillig   11384: </dl>
                   11385: </div>
1.322     leot     11386: <p>
                   11387: A number of mechanisms are available in pkgsrc to improve the security of the
                   11388: resulting system. This page describes the mechanisms, and gives hints
                   11389: about detecting and fixing problems.
                   11390: </p>
                   11391: <p>
                   11392: Mechanisms can be enabled individually in
                   11393: <code class="filename">mk.conf</code>, and are
                   11394: individually described below.
                   11395: </p>
                   11396: <p>
                   11397: Typically, a feature will cause some programs to fail to build or work
                   11398: when first enabled. This can be due to latent problems in the
                   11399: program, and can be due to other reasons. After enough testing to
                   11400: have confidence that user problems will be quite rare, individual
                   11401: mechanisms will be enabled by default.
                   11402: </p>
                   11403: <p>
                   11404: For each mechanism, see the Caveats section below for an explanation
                   11405: of what might go wrong at compile time and at run time, and how to
                   11406: notice and address these problems.
                   11407: </p>
1.148     asau     11408: <div class="sect1">
1.75      rillig   11409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11410: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
1.322     leot     11411: <div class="sect2">
                   11412: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11413: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
1.322     leot     11414: <div class="sect3">
                   11415: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11416: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
1.322     leot     11417: <p>
                   11418: This allows substitute wrappers to be used for some commonly used
                   11419: library functions that do not have built-in bounds checking - but
                   11420: could in some cases.
                   11421: </p>
                   11422: <p>
                   11423: Two mitigation levels are available:
                   11424: </p>
                   11425: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11426: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
                   11427: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
                   11428: </ul></div>
                   11429: <p>
                   11430: "strong" has been enabled by default since pkgsrc-2017Q3.
                   11431: </p>
                   11432: </div>
                   11433: <div class="sect3">
                   11434: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11435: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
1.322     leot     11436: <p>
                   11437: This enables a stack-smashing protection mitigation. It is done by adding a
                   11438: guard variable to functions with vulnerable objects. The guards are initialized
                   11439: when a function is entered and then checked when the function exits. The guard
                   11440: check will fail and the program forcibly exited if the variable was modified in
                   11441: the meantime. This can happen in case of buffer overflows or memory corruption,
                   11442: and therefore exposing these bugs.
                   11443: </p>
                   11444: <p>
                   11445: Different mitigation levels are available:
                   11446: </p>
                   11447: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11448: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
                   11449: by the compiler;</p></li>
                   11450: <li class="listitem"><p>"all", which will protect every function;</p></li>
                   11451: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
                   11452: two settings above.</p></li>
                   11453: </ul></div>
                   11454: <p>
                   11455: This mitigation is supported by both GCC and clang. It may be supported in
                   11456: additional compilers, possibly under a different name. It is particularly useful
                   11457: for unsafe programming languages, such as C/C++.
                   11458: </p>
                   11459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11460: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
                   11461: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
                   11462: </ul></div>
                   11463: <p>More details can be found here:</p>
                   11464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11465: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
                   11466: </p></li></ul></div>
                   11467: </div>
                   11468: <div class="sect3">
                   11469: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11470: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
1.322     leot     11471: <p>
                   11472: This requests the creation of PIE (Position Independent Executables) for all
                   11473: executables. The PIE mechanism is normally used for shared libraries, so that
                   11474: they can be loaded at differing addresses at runtime. PIE itself does not have
                   11475: useful security properties; however, it is necessary to fully leverage some,
                   11476: such as ASLR.  Some operating systems support Address Space Layout Randomization
                   11477: (ASLR), which causes different addresses to be used each time a program is run.
                   11478: This makes it more difficult for an attacker to guess addresses and thus makes
                   11479: exploits harder to construct. With PIE, ASLR can really be applied to the entire
                   11480: program, instead of the stack and heap only.
                   11481: </p>
                   11482: <p>
                   11483: PIE executables will only be built for toolchains that are known to support PIE.
                   11484: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
                   11485: </p>
                   11486: <p>
                   11487: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
                   11488: </p>
1.75      rillig   11489: </div>
1.325     gutterid 11490: <div class="sect3">
                   11491: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11492: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322     leot     11493: <p>
                   11494: This also makes the exploitation of some security vulnerabilities more
                   11495: difficult in some cases.
                   11496: </p>
                   11497: <p>Two different mitigation levels are available:</p>
                   11498: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   11499: <li class="listitem"><p>
1.334     nia      11500: partial (the default): the ELF sections are reordered so that internal data sections
1.322     leot     11501: precede the program's own data sections, and non-PLT GOT is read-only;
                   11502: </p></li>
                   11503: <li class="listitem"><p>
                   11504: full: in addition to partial RELRO, every relocation is performed immediately
1.333     nia      11505: when starting the program, allowing the entire GOT to be read-only.  This
                   11506: can greatly slow down startup of large programs.
1.322     leot     11507: </p></li>
                   11508: </ul></div>
                   11509: <p>
                   11510: This is currently supported by GCC. Many software distributions now enable this
1.335     nia      11511: feature by default, at the "partial" level.
1.322     leot     11512: </p>
                   11513: <p>
                   11514: More details can be found here:
                   11515: </p>
                   11516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11517: <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>
                   11518: </p></li></ul></div>
1.75      rillig   11519: </div>
1.334     nia      11520: </div>
                   11521: <div class="sect2">
                   11522: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11523: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
1.334     nia      11524: <div class="sect3">
                   11525: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11526: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
1.334     nia      11527: <p>
                   11528: With this option, pkgsrc will try to build packages reproducibly. This allows
                   11529: packages built from the same tree and with the same options, to produce
                   11530: identical results bit by bit. This option should be combined with ASLR and
                   11531: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
                   11532: attackers attempting to exploit security vulnerabilities.
                   11533: </p>
                   11534: <p>
                   11535: More details can be found here:
                   11536: </p>
                   11537: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
                   11538: <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>
                   11539: </p></li></ul></div>
                   11540: <p>
                   11541: More work likely needs to be done before pkgsrc is fully reproducible.
                   11542: </p>
                   11543: </div>
1.322     leot     11544: <div class="sect3">
                   11545: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11546: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322     leot     11547: <p>
                   11548: This uses <code class="literal">-fstack-check</code> with GCC for
                   11549: another stack protection mitigation.
                   11550: </p>
                   11551: <p>
                   11552: It asks the compiler to generate code verifying that it does not corrupt the
                   11553: stack. According to GCC's manual page, this is really only useful for
                   11554: multi-threaded programs.
                   11555: </p>
1.76      rillig   11556: </div>
                   11557: </div>
                   11558: </div>
1.148     asau     11559: <div class="sect1">
1.76      rillig   11560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11561: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
1.322     leot     11562: <div class="sect2">
                   11563: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11564: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
1.322     leot     11565: <div class="sect3">
                   11566: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11567: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
1.322     leot     11568: <p>
                   11569: A number of packages may fail to build with this option enabled. The
                   11570: failures are often related to the absence of the <code class="literal">-fPIC</code>
                   11571: compilation flag when building libraries or executables (or ideally
                   11572: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
                   11573: <code class="varname">CFLAGS</code> already, but requires the package to
                   11574: actually support it.
                   11575: </p>
                   11576: <div class="sect4">
                   11577: <div class="titlepage"><div><div><h5 class="title">
1.385     leot     11578: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
1.322     leot     11579: <p>
                   11580: These instructions are meant as a reference only; they likely need to be adapted
                   11581: for many packages individually.
                   11582: </p>
                   11583: <p>
                   11584: For packages using <code class="filename">Makefiles</code>:
                   11585: </p>
                   11586: <pre class="programlisting">
                   11587: MAKE_FLAGS+=   CFLAGS=${CFLAGS:Q}
                   11588: MAKE_FLAGS+=   LDFLAGS=${LDFLAGS:Q}
                   11589: </pre>
                   11590: <p>
                   11591: For packages using <code class="filename">Imakefiles</code>:
                   11592: </p>
                   11593: <pre class="programlisting">
                   11594: MAKE_FLAGS+=   CCOPTIONS=${CFLAGS:Q}
                   11595: MAKE_FLAGS+=   LOCAL_LDFLAGS=${LDFLAGS:Q}
                   11596: </pre>
                   11597: </div>
                   11598: </div>
                   11599: <div class="sect3">
                   11600: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11601: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
1.322     leot     11602: <p>
                   11603: Some programs may fail to run, or crash at random times once built as PIE. Two
                   11604: scenarios are essentially possible. This is nearly always due to a bug in
                   11605: the program being exposed due to ASLR.
                   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.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
1.322     leot     11611: <p>
                   11612: Ideally, packages should be fixed for compatibility with MKPIE.
                   11613: However, in some cases this is very difficult, due to complex build systems,
                   11614: packages using non-standard toolchains, or programming languages with odd
                   11615: bootstrapping mechanisms.
                   11616: </p>
                   11617: <p>
                   11618: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
                   11619: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
                   11620: <code class="filename">bsd.prefs.mk</code> is included.
                   11621: </p>
                   11622: </div>
                   11623: </div>
                   11624: <div class="sect2">
                   11625: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11626: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
1.322     leot     11627: <div class="sect3">
                   11628: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11629: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
1.322     leot     11630: <p>
                   11631: This feature makes use of pre-processing directives to look for hardened,
                   11632: alternative implementations of essential library calls. Some programs may fail
                   11633: to build as a result; this usually happens for those trying too hard to be
                   11634: portable, or otherwise abusing definitions in the standard library.
                   11635: </p>
                   11636: </div>
                   11637: <div class="sect3">
                   11638: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11639: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
1.322     leot     11640: <p>
                   11641: This feature may cause some programs to crash, usually indicating an
                   11642: actual bug in the program. The fix will typically involve patching the
                   11643: original program's source code.
                   11644: </p>
                   11645: </div>
                   11646: <div class="sect3">
                   11647: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11648: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
1.322     leot     11649: <p>
                   11650: At least in the case of GCC, FORTIFY will only be applied if optimization is
                   11651: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
                   11652: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
                   11653: optimization level. This cannot easily be applied globally, as some packages
                   11654: may require specific optimization levels.
                   11655: </p>
                   11656: </div>
                   11657: <div class="sect3">
                   11658: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11659: <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     11660: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11661: <h3 class="title">Note</h3>
                   11662: <p>FORTIFY should not be disabled to work around runtime crashes in
                   11663: the program!  This is a very bad idea and will expose you to security
                   11664: vulnerabilities.
                   11665: </p>
                   11666: </div>
                   11667: <p>
                   11668: To disable FORTIFY on a per-package basis, set the following
                   11669: in the package's <code class="filename">Makefile</code>
                   11670: before <code class="filename">bsd.prefs.mk</code> is included:
                   11671: </p>
                   11672: <pre class="programlisting">
                   11673: FORTIFY_SUPPORTED=     no
                   11674: </pre>
                   11675: </div>
                   11676: </div>
                   11677: <div class="sect2">
                   11678: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11679: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
1.322     leot     11680: <div class="sect3">
                   11681: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11682: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
1.322     leot     11683: <p>
                   11684: For better protection, full RELRO requires every symbol to be resolved when the
                   11685: program starts, rather than simply when required at run-time. This will have
                   11686: more impact on programs using a lot of symbols, or linked to libraries exposing
                   11687: a lot of symbols. Therefore, daemons or programs otherwise running in
                   11688: background are affected only when started. Programs loading plug-ins at
                   11689: run-time are affected when loading the plug-ins.
                   11690: </p>
                   11691: <p>
                   11692: The impact is not expected to be noticeable on modern hardware, except in some
                   11693: cases for big programs.
                   11694: </p>
                   11695: </div>
                   11696: <div class="sect3">
                   11697: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11698: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
1.322     leot     11699: <p>
                   11700: Some programs handle plug-ins and dependencies in a way that conflicts with
                   11701: RELRO: for instance, with an initialization routine listing any other plug-in
                   11702: required. With full RELRO, the missing symbols are resolved before the
                   11703: initialization routine can run, and the dynamic loader will not be able to find
                   11704: them directly and abort as a result. Unfortunately, this is how Xorg loads its
                   11705: drivers. Partial RELRO can be applied instead in this case.
                   11706: </p>
                   11707: </div>
                   11708: <div class="sect3">
                   11709: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11710: <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     11711: <p>
                   11712: To disable RELRO on a per-package basis, set the following
                   11713: in the package's <code class="filename">Makefile</code>
                   11714: before <code class="filename">bsd.prefs.mk</code> is included:
                   11715: </p>
                   11716: <pre class="programlisting">
                   11717: RELRO_SUPPORTED=       no
                   11718: </pre>
1.324     nia      11719: <p>
                   11720: It is also possible to at most enable partial RELRO, by
                   11721: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
                   11722: </p>
1.322     leot     11723: </div>
                   11724: </div>
                   11725: <div class="sect2">
                   11726: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11727: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
1.322     leot     11728: <div class="sect3">
                   11729: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11730: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
1.322     leot     11731: <p>
                   11732: The stack-smashing protection provided by this option does not work for some
                   11733: programs. The most common situation in which this happens is when the program
                   11734: allocates variables on the stack, with the size determined at run-time.
                   11735: </p>
                   11736: </div>
                   11737: <div class="sect3">
                   11738: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11739: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
1.322     leot     11740: <p>
                   11741: Again, this feature may cause some programs to crash via a
                   11742: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
                   11743: </p>
                   11744: <p>
                   11745: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
                   11746: messages are sent and - by default -
                   11747: appended to <code class="filename">/var/log/messages</code>, e.g.:
                   11748: </p>
                   11749: <pre class="programlisting">
                   11750: Jan  6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
                   11751: </pre>
                   11752: <p>
                   11753: (where <code class="literal">hostname</code> is the hostname(1) and
                   11754: <code class="literal">program</code> is the basename(1) of the program crashed).
                   11755: </p>
                   11756: <p>
                   11757: Patching the original program is then required.
                   11758: </p>
                   11759: <p>
                   11760: Rebuilding the package via:
                   11761: </p>
                   11762: <pre class="programlisting">
                   11763: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
                   11764: </pre>
                   11765: <p>
                   11766: and inspecting the backtrace of the coredump via the debugger
                   11767: should point out the problematic call by inspecting the frame
                   11768: calling the _chk() (SSP) function.
                   11769: </p>
                   11770: </div>
                   11771: <div class="sect3">
                   11772: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11773: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
1.322     leot     11774: <p>
                   11775: The compiler emits extra code when using this feature: a check for buffer
                   11776: overflows is performed when entering and exiting functions, requiring an extra
                   11777: variable on the stack. The level of protection can otherwise be adjusted to
                   11778: affect only those functions considered more sensitive by the compiler (with
                   11779: -fstack-protector instead of -fstack-protector-all).
                   11780: </p>
                   11781: <p>
                   11782: The impact is not expected to be noticeable on modern hardware. However,
                   11783: programs with a hard requirement to run at the fastest possible speed should
                   11784: avoid using this feature, or using libraries built with this feature.
                   11785: </p>
                   11786: </div>
                   11787: <div class="sect3">
                   11788: <div class="titlepage"><div><div><h4 class="title">
1.385     leot     11789: <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     11790: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11791: <h3 class="title">Note</h3>
                   11792: <p>SSP should not be disabled to work around runtime crashes in
                   11793: the program!  This is a very bad idea and will expose you to security
                   11794: vulnerabilities.</p>
                   11795: </div>
                   11796: <p>
                   11797: To disable SSP on a per-package basis, set the following
                   11798: in the package's <code class="filename">Makefile</code>
                   11799: before <code class="filename">bsd.prefs.mk</code> is included:
                   11800: </p>
                   11801: <pre class="programlisting">
                   11802: SSP_SUPPORTED= no
                   11803: </pre>
                   11804: </div>
                   11805: </div>
                   11806: </div>
                   11807: <div class="sect1">
                   11808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11809: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
1.322     leot     11810: <p>
                   11811: The illusion of security is worse than having no security at all. This section
                   11812: lists a number of ways to ensure the security features requested are actually
                   11813: effective.
                   11814: </p>
                   11815: <p>
                   11816: These instructions were obtained and tested on a system derived from NetBSD 7
                   11817: (amd64). YMMV.
                   11818: </p>
                   11819: <div class="sect2">
                   11820: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11821: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
1.322     leot     11822: <p>
                   11823: The ELF executable type in use changes for binaries built as PIE; without:
                   11824: </p>
                   11825: <pre class="programlisting">
                   11826: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
                   11827: /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
                   11828: </pre>
                   11829: <p>as opposed to the following binary, built as PIE:</p>
                   11830: <pre class="programlisting">
                   11831: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
                   11832: /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
                   11833: </pre>
                   11834: <p>
                   11835: The latter result is then what is expected.
                   11836: </p>
                   11837: </div>
                   11838: <div class="sect2">
                   11839: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11840: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
1.322     leot     11841: <p>
                   11842: The following command should list a section called RELRO:
                   11843: </p>
                   11844: <pre class="programlisting">
                   11845: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
                   11846: 
                   11847: /path/to/bin/ary:     file format elf64-x86-64
                   11848: 
                   11849: Program Header:
                   11850: [...]
                   11851:    RELRO off    0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
                   11852: </pre>
                   11853: <p>
                   11854: This check is now performed automatically if
                   11855: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
                   11856: </p>
                   11857: </div>
                   11858: <div class="sect2">
                   11859: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11860: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
1.322     leot     11861: <p>
                   11862: The dynamic loader will apply RELRO immediately when detecting the presence of
                   11863: the <code class="varname">BIND_NOW</code> flag:
                   11864: </p>
                   11865: <pre class="programlisting">
                   11866: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
                   11867: 
                   11868: /path/to/bin/ary:     file format elf64-x86-64
                   11869: 
                   11870: Dynamic Section:
                   11871: [...]
                   11872:   BIND_NOW             0x0000000000000000
                   11873: </pre>
                   11874: <p>
                   11875: This has to be combined with partial RELRO (see above) to be fully efficient.
                   11876: </p>
                   11877: <p>
                   11878: This check is now performed automatically (where supported) if
                   11879: <code class="varname">PKG_DEVELOPER</code> is set.
                   11880: </p>
                   11881: </div>
                   11882: <div class="sect2">
                   11883: <div class="titlepage"><div><div><h3 class="title">
1.385     leot     11884: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323     nia      11885: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11886: <h3 class="title">Note</h3>
                   11887: <p>
                   11888: Checking for SSP using this method only works where the operating system
                   11889: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
                   11890: on recent NetBSD/FreeBSD/Linux versions.
                   11891: </p>
                   11892: </div>
1.322     leot     11893: <p>
                   11894: Building objects, binaries and libraries with SSP will affect the presence of
                   11895: additional symbols in the resulting file:
                   11896: </p>
                   11897: <pre class="programlisting">
                   11898: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
                   11899: [...]
                   11900:                  U __stack_chk_fail
                   11901: 0000000000600ea0 B __stack_chk_guard
                   11902: </pre>
                   11903: <p>
                   11904: This is an indicator that the program was indeed built with support for SSP.
                   11905: </p>
                   11906: <p>
                   11907: This check is now performed automatically (where supported) if
                   11908: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
                   11909: </p>
                   11910: </div>
                   11911: </div>
                   11912: </div>
                   11913: <div class="appendix">
                   11914: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     11915: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
1.322     leot     11916: <div class="toc">
                   11917: <p><b>Table of Contents</b></p>
                   11918: <dl class="toc">
                   11919: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
                   11920: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
                   11921: </dl>
                   11922: </div>
                   11923: <div class="sect1">
                   11924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     11925: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
1.322     leot     11926: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   11927: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11928: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11929: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11930: =&gt; [172219 bytes]
                   11931: Connected to ftp.plig.net.
                   11932: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11933: 331 Guest login ok, send your complete e-mail address as password.
                   11934: 230-You are user #5 of 500 simultaneous users allowed.
                   11935: 230-
                   11936: 230-  ___ _             _ _
                   11937: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   11938: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11939: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11940: 230-         |_|   |_|     |___|         |___|
                   11941: 230-
                   11942: 230-** Welcome to ftp.plig.org **
                   11943: 230-
                   11944: 230-Please note that all transfers from this FTP site are logged. If you
                   11945: 230-do not like this, please disconnect now.
                   11946: 230-
                   11947: 230-This archive is available via
                   11948: 230-
                   11949: 230-HTTP:  http://ftp.plig.org/
                   11950: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11951: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11952: 230-
                   11953: 230-Please email comments, bug reports and requests for packages to be
                   11954: 230-mirrored to ftp-admin@plig.org.
                   11955: 230-
                   11956: 230-
                   11957: 230 Logged in anonymously.
                   11958: Remote system type is UNIX.
                   11959: Using binary mode to transfer files.
                   11960: 200 Type okay.
                   11961: 250 "/pub" is new cwd.
                   11962: 250-"/pub/figlet" is new cwd.
                   11963: 250-
                   11964: 250-Welcome to the figlet archive at ftp.figlet.org
                   11965: 250-
                   11966: 250-   ftp://ftp.figlet.org/pub/figlet/
                   11967: 250-
                   11968: 250-The official FIGlet web page is:
                   11969: 250-   http://www.figlet.org/
                   11970: 250-
                   11971: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11972: 250-contribute a font or something else, you can email us.
                   11973: 250
                   11974: 250 "/pub/figlet/program" is new cwd.
                   11975: 250 "/pub/figlet/program/unix" is new cwd.
                   11976: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11977: 502 Unimplemented command.
                   11978: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11979: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11980: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11981: 226 Transfer completed.
                   11982: 172219 bytes received in 00:02 (75.99 KB/s)
                   11983: 221 Goodbye.
                   11984: =&gt; Checksum OK for figlet221.tar.gz.
                   11985: ===&gt; Extracting for figlet-2.2.1nb2
                   11986: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11987: ===&gt; Patching for figlet-2.2.1nb2
                   11988: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11989: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11990: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11991: ===&gt; Configuring for figlet-2.2.1nb2
                   11992: ===&gt; Building for figlet-2.2.1nb2
                   11993: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11994: chmod a+x figlet
                   11995: gcc -O2 -o chkfont chkfont.c
                   11996: =&gt; Unwrapping files-to-be-installed.
                   11997: <code class="prompt">#</code>
                   11998: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11999: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   12000: ===&gt; Installing for figlet-2.2.1nb2
                   12001: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   12002: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   12003: mkdir -p /usr/pkg/share/figlet
                   12004: cp figlet /usr/pkg/bin
                   12005: cp chkfont /usr/pkg/bin
                   12006: chmod 555 figlist showfigfonts
                   12007: cp figlist /usr/pkg/bin
                   12008: cp showfigfonts /usr/pkg/bin
                   12009: cp fonts/*.flf /usr/pkg/share/figlet
                   12010: cp fonts/*.flc /usr/pkg/share/figlet
                   12011: cp figlet.6 /usr/pkg/man/man6
                   12012: ===&gt; Registering installation for figlet-2.2.1nb2
                   12013: <code class="prompt">#</code></pre>
                   12014: </div>
                   12015: <div class="sect1">
                   12016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12017: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
1.322     leot     12018: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   12019: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   12020: ===&gt; Packaging figlet-2.2.1nb2
                   12021: ===&gt; Building binary package for figlet-2.2.1nb2
                   12022: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   12023: Using SrcDir value of /usr/pkg
                   12024: Registering depends:.
                   12025: <code class="prompt">#</code></pre>
                   12026: </div>
                   12027: </div>
                   12028: <div class="appendix">
                   12029: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     12030: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.322     leot     12031: <div class="toc">
                   12032: <p><b>Table of Contents</b></p>
                   12033: <dl class="toc">
                   12034: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   12035: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   12036: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   12037: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   12038: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
                   12039: <code class="filename">stable</code>,
                   12040: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   12041: source packages</a></span></dt>
                   12042: </dl>
                   12043: </div>
                   12044: <p>As in other big projects, the directory layout of pkgsrc
                   12045:        is quite complex for newbies. This chapter explains where you
                   12046:        find things on the FTP server. The base directory on
                   12047:        <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>.
                   12048:        On other servers it may be different, but inside this directory,
                   12049:        everything should look the same, no matter on which server you
                   12050:        are. This directory contains some subdirectories, which are
                   12051:        explained below.</p>
                   12052: <div class="sect1">
                   12053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12054: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.322     leot     12055: <p>The directory <code class="filename">distfiles</code> contains lots
                   12056:        of archive files from all pkgsrc packages, which are mirrored
                   12057:        here. The subdirectories are called after their package names
                   12058:        and are used when the distributed files have names that don't
                   12059:        explicitly contain a version number or are otherwise too generic
                   12060:        (for example <code class="filename">release.tar.gz</code>).</p>
                   12061: </div>
                   12062: <div class="sect1">
                   12063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12064: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.322     leot     12065: <p>This directory contains things that individual pkgsrc
                   12066:        developers find worth publishing.</p>
                   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-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.322     leot     12071: <p>This directory contains binary packages for the various
                   12072:        platforms that are supported by pkgsrc.
                   12073:        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>
                   12074: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   12075: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
                   12076:        operating system for which the packages have been built. The
                   12077:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
                   12078:        command, so it may differ from the one you are used to
                   12079:        hear.</p></li>
                   12080: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
                   12081:        architecture of the platform for which the packages have been
                   12082:        built. It also includes the <code class="varname">ABI</code> (Application
                   12083:        Binary Interface) for platforms that have several of
                   12084:        them.</p></li>
                   12085: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.370     gdt      12086:        the operating system.  Typically it is the version defining an
                   12087:        ABI, e.g. 9.0.</p></li>
1.322     leot     12088: <li class="listitem"><p><code class="varname">TAG</code> is either
1.370     gdt      12089:        <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
                   12090:        for a stable branch, or <code class="literal">current</code> for packages
1.322     leot     12091:        built from the HEAD branch. The latter should only be used when
1.370     gdt      12092:        the packages are updated on a regular basis.</p></li>
1.322     leot     12093: </ul></div>
1.370     gdt      12094: <p>The rationale for this scheme is that users can first
                   12095:        search by OPSYS and ARCH, since these are more or less
                   12096:        unchangeable.  After that, there is a management set of
                   12097:        directories with OSVERSION and TAG.</p>
                   12098: <p>See also <code class="filename">README.md</code> in
                   12099:        <code class="filename">packages</code> for more details, including
                   12100:        about symlinks.</p>
1.322     leot     12101: <p>In each of these directories, there is a
                   12102:        whole binary packages collection for a specific platform. It has a directory called
                   12103:        <code class="filename">All</code> which contains all binary packages.
1.370     gdt      12104:        </p>
1.322     leot     12105: </div>
                   12106: <div class="sect1">
                   12107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12108: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   12109: <p>Here are the reports from bulk builds, for those who want
                   12110:        to fix packages that didn't build on some of the platforms. The
1.385     leot     12111:        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   12112: </div>
1.148     asau     12113: <div class="sect1">
1.108     rillig   12114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     12115: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261     leot     12116: <code class="filename">stable</code>,
1.126     jakllsch 12117: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   12118: source packages</h2></div></div></div>
1.385     leot     12119: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76      rillig   12120:        that is the files that define how to create binary packages from
                   12121:        source archives.</p>
1.262     leot     12122: <p>Each of the <code class="filename">current</code>,
                   12123:        <code class="filename">stable</code> and
                   12124:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12125:        directories share the same structure.  They each contain a
                   12126:        <code class="filename">pkgsrc</code> directory and
                   12127:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   12128: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   12129:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     12130:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   12131:        as the directory, ready to be downloaded as a whole.</p>
                   12132: <p>The <code class="filename">current</code> directory contains files
                   12133:        related to the HEAD branch of the CVS repository.
                   12134:        In this directory there is an additional file called
                   12135:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   12136:        all pkgsrc <code class="filename">README</code>s with information about
                   12137:        categories and packages.
                   12138:        </p>
                   12139: <p>The <code class="filename">stable</code> directory is a symlink to
                   12140:        the latest 
                   12141:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12142:        </p>
                   12143: <p>The
                   12144:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   12145:        directories contain files related to the 
                   12146:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   12147:        stable branch of the CVS repository. In these directories there is
                   12148:        an additional file called
                   12149:        <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   12150:        which contains the state of pkgsrc when it was branched.</p>
                   12151: </div>
1.75      rillig   12152: </div>
1.148     asau     12153: <div class="appendix">
                   12154: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     12155: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267     rillig   12156: <p>
                   12157:        The following list contains all help topics that are available
                   12158:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   12159: </p>
1.269     leot     12160: <table border="0" summary="Simple list" class="simplelist">
                   12161: <tr>
                   12162: <td>#!</td>
                   12163: <td>-lintl</td>
                   12164: </tr>
                   12165: <tr>
1.320     wiz      12166: <td>32bit</td>
1.269     leot     12167: <td>64bit</td>
1.320     wiz      12168: </tr>
                   12169: <tr>
1.269     leot     12170: <td>ABI</td>
1.320     wiz      12171: <td>ACCEPTABLE_LICENSES</td>
1.269     leot     12172: </tr>
                   12173: <tr>
                   12174: <td>ACROREAD_FONTPATH</td>
1.384     leot     12175: <td>AFAIK</td>
1.269     leot     12176: </tr>
                   12177: <tr>
1.320     wiz      12178: <td>AIX</td>
1.384     leot     12179: <td>ALLOW_NETWORK_ACCESS</td>
1.269     leot     12180: </tr>
                   12181: <tr>
1.357     gutterid 12182: <td>ALLOW_NEWER_COMPILER</td>
1.384     leot     12183: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.269     leot     12184: </tr>
                   12185: <tr>
1.357     gutterid 12186: <td>ALL_ENV</td>
1.384     leot     12187: <td>ALSA_PC</td>
1.369     wiz      12188: </tr>
                   12189: <tr>
1.368     gutterid 12190: <td>ALTERNATIVES_SRC</td>
1.384     leot     12191: <td>AMANDA_TMP</td>
1.382     wiz      12192: </tr>
                   12193: <tr>
                   12194: <td>AMANDA_USER</td>
1.384     leot     12195: <td>AMANDA_VAR</td>
1.378     leot     12196: </tr>
                   12197: <tr>
1.382     wiz      12198: <td>APACHE_GROUP</td>
1.384     leot     12199: <td>APACHE_MODULE_NAME</td>
1.376     wiz      12200: </tr>
                   12201: <tr>
1.382     wiz      12202: <td>APACHE_MODULE_SRC</td>
1.384     leot     12203: <td>APACHE_MODULE_SRCDIR</td>
1.367     gdt      12204: </tr>
                   12205: <tr>
1.382     wiz      12206: <td>APACHE_PKG_PREFIX</td>
1.384     leot     12207: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.360     leot     12208: </tr>
                   12209: <tr>
1.382     wiz      12210: <td>APACHE_SUEXEC_DOCROOT</td>
1.384     leot     12211: <td>APACHE_USER</td>
1.355     rillig   12212: </tr>
                   12213: <tr>
1.382     wiz      12214: <td>ARGMAX_REQ</td>
1.384     leot     12215: <td>ARG_MAX</td>
1.352     wiz      12216: </tr>
                   12217: <tr>
1.382     wiz      12218: <td>ARLA_CACHE</td>
1.384     leot     12219: <td>AUDIT_PACKAGES_FLAGS</td>
1.348     wiz      12220: </tr>
                   12221: <tr>
1.382     wiz      12222: <td>AUTOCONF_REQD</td>
1.384     leot     12223: <td>AUTOMAKE_OVERRIDE</td>
1.342     wiz      12224: </tr>
                   12225: <tr>
1.382     wiz      12226: <td>AUTOMAKE_REQD</td>
1.384     leot     12227: <td>AUTO_MKDIRS</td>
1.376     wiz      12228: </tr>
                   12229: <tr>
1.382     wiz      12230: <td>AUX</td>
1.384     leot     12231: <td>BDB185_DEFAULT</td>
1.338     nia      12232: </tr>
                   12233: <tr>
1.382     wiz      12234: <td>BDBBASE</td>
1.384     leot     12235: <td>BDB_ACCEPTED</td>
1.332     rillig   12236: </tr>
                   12237: <tr>
1.382     wiz      12238: <td>BDB_DEFAULT</td>
1.384     leot     12239: <td>BDB_LIBS</td>
1.329     leot     12240: </tr>
                   12241: <tr>
1.382     wiz      12242: <td>BDB_TYPE</td>
1.384     leot     12243: <td>BINCIMAP_GROUP</td>
1.327     wiz      12244: </tr>
                   12245: <tr>
1.382     wiz      12246: <td>BINCIMAP_LOG_USER</td>
1.384     leot     12247: <td>BINCIMAP_USER</td>
1.311     leot     12248: </tr>
                   12249: <tr>
1.382     wiz      12250: <td>BIND_DIR</td>
1.384     leot     12251: <td>BIND_GROUP</td>
1.292     leot     12252: </tr>
                   12253: <tr>
1.382     wiz      12254: <td>BIND_USER</td>
1.384     leot     12255: <td>BINOWN</td>
1.274     rillig   12256: </tr>
                   12257: <tr>
1.382     wiz      12258: <td>BINPKG_SITES</td>
1.384     leot     12259: <td>BIN_INSTALL_FLAGS</td>
1.269     leot     12260: </tr>
                   12261: <tr>
1.382     wiz      12262: <td>BISON_PKGDATADIR</td>
1.384     leot     12263: <td>BLAS</td>
1.369     wiz      12264: </tr>
                   12265: <tr>
1.382     wiz      12266: <td>BLAS_ACCEPTED</td>
1.384     leot     12267: <td>BLAS_C_INTERFACE</td>
1.269     leot     12268: </tr>
                   12269: <tr>
1.382     wiz      12270: <td>BLAS_INCLUDES</td>
1.384     leot     12271: <td>BLAS_INDEX64</td>
1.269     leot     12272: </tr>
                   12273: <tr>
1.382     wiz      12274: <td>BLAS_LIBS</td>
1.384     leot     12275: <td>BLAS_PC</td>
1.269     leot     12276: </tr>
                   12277: <tr>
1.382     wiz      12278: <td>BLAS_TYPE</td>
1.384     leot     12279: <td>BOOTSTRAP_DEPENDS</td>
1.269     leot     12280: </tr>
                   12281: <tr>
1.382     wiz      12282: <td>BROKEN</td>
1.384     leot     12283: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269     leot     12284: </tr>
                   12285: <tr>
1.382     wiz      12286: <td>BROKEN_ON_PLATFORM</td>
1.384     leot     12287: <td>BSDSRCDIR</td>
1.269     leot     12288: </tr>
                   12289: <tr>
1.384     leot     12290: <td>BSD_MAKE_ENV</td>
1.386     wiz      12291: <td>BUILDLINK_AUTO_DIRS</td>
1.269     leot     12292: </tr>
                   12293: <tr>
1.384     leot     12294: <td>BUILDLINK_AUTO_VARS</td>
1.386     wiz      12295: <td>BUILDLINK_CFLAGS</td>
1.269     leot     12296: </tr>
                   12297: <tr>
1.384     leot     12298: <td>BUILDLINK_CONTENTS_FILTER</td>
1.386     wiz      12299: <td>BUILDLINK_CPPFLAGS</td>
1.269     leot     12300: </tr>
                   12301: <tr>
1.384     leot     12302: <td>BUILDLINK_DEPMETHOD</td>
1.386     wiz      12303: <td>BUILDLINK_FILES</td>
1.269     leot     12304: </tr>
                   12305: <tr>
1.384     leot     12306: <td>BUILDLINK_FILES_CMD</td>
1.386     wiz      12307: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.269     leot     12308: </tr>
                   12309: <tr>
1.384     leot     12310: <td>BUILDLINK_LDFLAGS</td>
1.386     wiz      12311: <td>BUILDLINK_LIBS</td>
1.320     wiz      12312: </tr>
                   12313: <tr>
1.384     leot     12314: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.386     wiz      12315: <td>BUILDLINK_PKGNAME</td>
1.269     leot     12316: </tr>
                   12317: <tr>
1.384     leot     12318: <td>BUILDLINK_PREFIX</td>
1.386     wiz      12319: <td>BUILDLINK_RPATHDIRS</td>
1.269     leot     12320: </tr>
                   12321: <tr>
1.384     leot     12322: <td>BUILDLINK_TREE</td>
1.386     wiz      12323: <td>BUILD_DEFS</td>
1.269     leot     12324: </tr>
                   12325: <tr>
1.384     leot     12326: <td>BUILD_DEFS_EFFECTS</td>
1.386     wiz      12327: <td>BUILD_DEPENDS</td>
1.269     leot     12328: </tr>
                   12329: <tr>
1.384     leot     12330: <td>BUILD_DIRS</td>
1.386     wiz      12331: <td>BUILD_ENV_SHELL</td>
1.269     leot     12332: </tr>
                   12333: <tr>
1.384     leot     12334: <td>BUILD_MAKE_CMD</td>
1.386     wiz      12335: <td>BUILD_MAKE_FLAGS</td>
1.269     leot     12336: </tr>
                   12337: <tr>
1.384     leot     12338: <td>BUILD_TARGET</td>
1.386     wiz      12339: <td>BUILTIN_FIND_FILES</td>
1.269     leot     12340: </tr>
                   12341: <tr>
1.384     leot     12342: <td>BUILTIN_FIND_FILES_VAR</td>
1.386     wiz      12343: <td>BUILTIN_FIND_GREP</td>
1.269     leot     12344: </tr>
                   12345: <tr>
1.384     leot     12346: <td>BUILTIN_FIND_HEADERS</td>
1.386     wiz      12347: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269     leot     12348: </tr>
                   12349: <tr>
1.384     leot     12350: <td>BUILTIN_FIND_PKGCONFIG</td>
1.386     wiz      12351: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.269     leot     12352: </tr>
                   12353: <tr>
1.384     leot     12354: <td>BUILTIN_PKG</td>
1.386     wiz      12355: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.269     leot     12356: </tr>
                   12357: <tr>
1.384     leot     12358: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.386     wiz      12359: <td>BUILTIN_VERSION_SCRIPT</td>
1.309     gutterid 12360: </tr>
                   12361: <tr>
1.384     leot     12362: <td>BUILTIN_X11_TYPE</td>
1.386     wiz      12363: <td>BUILTIN_X11_VERSION</td>
1.269     leot     12364: </tr>
                   12365: <tr>
1.384     leot     12366: <td>CACTI_GROUP</td>
1.386     wiz      12367: <td>CACTI_USER</td>
1.269     leot     12368: </tr>
                   12369: <tr>
1.384     leot     12370: <td>CANNA_GROUP</td>
1.386     wiz      12371: <td>CANNA_USER</td>
1.269     leot     12372: </tr>
                   12373: <tr>
1.384     leot     12374: <td>CAT</td>
1.386     wiz      12375: <td>CBLAS_LIBS</td>
1.269     leot     12376: </tr>
                   12377: <tr>
1.384     leot     12378: <td>CBLAS_PC</td>
1.386     wiz      12379: <td>CCACHE_BASE</td>
1.269     leot     12380: </tr>
                   12381: <tr>
1.384     leot     12382: <td>CCACHE_DIR</td>
1.386     wiz      12383: <td>CCACHE_LOGFILE</td>
1.269     leot     12384: </tr>
                   12385: <tr>
1.384     leot     12386: <td>CCACHE_RECACHE</td>
1.386     wiz      12387: <td>CC_VERSION</td>
1.269     leot     12388: </tr>
                   12389: <tr>
1.386     wiz      12390: <td>CDRECORD_CONF</td>
1.389     wiz      12391: <td>CDROM_PKG_URL_DIR</td>
1.269     leot     12392: </tr>
                   12393: <tr>
1.386     wiz      12394: <td>CDROM_PKG_URL_HOST</td>
1.389     wiz      12395: <td>CHANGES</td>
1.269     leot     12396: </tr>
                   12397: <tr>
1.386     wiz      12398: <td>CHECKOUT_DATE</td>
1.389     wiz      12399: <td>CHECK_COMPILER</td>
1.338     nia      12400: </tr>
                   12401: <tr>
1.386     wiz      12402: <td>CHECK_FAKEHOME</td>
1.389     wiz      12403: <td>CHECK_FILES</td>
1.382     wiz      12404: </tr>
                   12405: <tr>
1.386     wiz      12406: <td>CHECK_FILES_ONLY_PREFIX</td>
1.389     wiz      12407: <td>CHECK_FILES_SKIP</td>
1.378     leot     12408: </tr>
                   12409: <tr>
1.386     wiz      12410: <td>CHECK_FILES_STRICT</td>
1.389     wiz      12411: <td>CHECK_HEADERS</td>
1.376     wiz      12412: </tr>
                   12413: <tr>
1.386     wiz      12414: <td>CHECK_HEADERS_SKIP</td>
1.389     wiz      12415: <td>CHECK_INTERPRETER</td>
1.369     wiz      12416: </tr>
                   12417: <tr>
1.386     wiz      12418: <td>CHECK_INTERPRETER_SKIP</td>
1.389     wiz      12419: <td>CHECK_PERMS</td>
1.367     gdt      12420: </tr>
                   12421: <tr>
1.386     wiz      12422: <td>CHECK_PERMS_AUTOFIX</td>
1.389     wiz      12423: <td>CHECK_PERMS_SKIP</td>
1.360     leot     12424: </tr>
                   12425: <tr>
1.386     wiz      12426: <td>CHECK_PIE</td>
1.389     wiz      12427: <td>CHECK_PIE_SKIP</td>
1.355     rillig   12428: </tr>
                   12429: <tr>
1.386     wiz      12430: <td>CHECK_PIE_SUPPORTED</td>
1.389     wiz      12431: <td>CHECK_PORTABILITY</td>
1.352     wiz      12432: </tr>
                   12433: <tr>
1.386     wiz      12434: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.389     wiz      12435: <td>CHECK_PORTABILITY_SKIP</td>
1.348     wiz      12436: </tr>
                   12437: <tr>
1.386     wiz      12438: <td>CHECK_RELRO</td>
1.389     wiz      12439: <td>CHECK_RELRO_SKIP</td>
1.342     wiz      12440: </tr>
                   12441: <tr>
1.386     wiz      12442: <td>CHECK_RELRO_SUPPORTED</td>
1.389     wiz      12443: <td>CHECK_SHLIBS</td>
1.332     rillig   12444: </tr>
                   12445: <tr>
1.386     wiz      12446: <td>CHECK_SHLIBS_SKIP</td>
1.389     wiz      12447: <td>CHECK_SHLIBS_SUPPORTED</td>
1.329     leot     12448: </tr>
                   12449: <tr>
1.386     wiz      12450: <td>CHECK_SHLIBS_TOXIC</td>
1.389     wiz      12451: <td>CHECK_SSP</td>
1.327     wiz      12452: </tr>
                   12453: <tr>
1.386     wiz      12454: <td>CHECK_SSP_SKIP</td>
1.389     wiz      12455: <td>CHECK_SSP_SUPPORTED</td>
1.320     wiz      12456: </tr>
                   12457: <tr>
1.386     wiz      12458: <td>CHECK_STRIPPED</td>
1.389     wiz      12459: <td>CHECK_STRIPPED_SKIP</td>
1.311     leot     12460: </tr>
                   12461: <tr>
1.386     wiz      12462: <td>CHECK_WRKREF</td>
1.389     wiz      12463: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.292     leot     12464: </tr>
                   12465: <tr>
1.386     wiz      12466: <td>CHECK_WRKREF_SKIP</td>
1.389     wiz      12467: <td>CLAMAV_DBDIR</td>
1.274     rillig   12468: </tr>
                   12469: <tr>
1.386     wiz      12470: <td>CLAMAV_GROUP</td>
1.389     wiz      12471: <td>CLAMAV_USER</td>
1.331     gutterid 12472: </tr>
                   12473: <tr>
1.386     wiz      12474: <td>CLANGBASE</td>
1.389     wiz      12475: <td>CLEANDEPENDS</td>
1.269     leot     12476: </tr>
                   12477: <tr>
1.386     wiz      12478: <td>CLT</td>
1.389     wiz      12479: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269     leot     12480: </tr>
                   12481: <tr>
1.386     wiz      12482: <td>CMAKE_INSTALL_NAME_DIR</td>
1.389     wiz      12483: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     12484: </tr>
                   12485: <tr>
1.386     wiz      12486: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.389     wiz      12487: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     12488: </tr>
                   12489: <tr>
1.386     wiz      12490: <td>CMAKE_PREFIX_PATH</td>
1.389     wiz      12491: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.269     leot     12492: </tr>
                   12493: <tr>
1.396   ! wiz      12494: <td>CODEBERG_PROJECT</td>
        !          12495: <td>CODEBERG_RELEASE</td>
        !          12496: </tr>
        !          12497: <tr>
        !          12498: <td>CODEBERG_SUBMODULES</td>
        !          12499: <td>CODEBERG_TAG</td>
        !          12500: </tr>
        !          12501: <tr>
        !          12502: <td>CODEBERG_TYPE</td>
1.386     wiz      12503: <td>COMMON_LISP_DOCFILES</td>
1.369     wiz      12504: </tr>
                   12505: <tr>
1.396   ! wiz      12506: <td>COMMON_LISP_EXAMPLES</td>
1.386     wiz      12507: <td>COMMON_LISP_EXTRAFILES</td>
1.382     wiz      12508: </tr>
                   12509: <tr>
1.396   ! wiz      12510: <td>COMMON_LISP_PACKAGES</td>
1.386     wiz      12511: <td>COMMON_LISP_SYSTEM</td>
1.382     wiz      12512: </tr>
                   12513: <tr>
1.396   ! wiz      12514: <td>COMPILER_RPATH_FLAG</td>
1.386     wiz      12515: <td>COMPILER_USE_SYMLINKS</td>
1.269     leot     12516: </tr>
                   12517: <tr>
1.396   ! wiz      12518: <td>CONFIGURE_ARGS</td>
1.386     wiz      12519: <td>CONFIGURE_DIRS</td>
1.269     leot     12520: </tr>
                   12521: <tr>
1.396   ! wiz      12522: <td>CONFIGURE_ENV</td>
1.386     wiz      12523: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     12524: </tr>
                   12525: <tr>
1.396   ! wiz      12526: <td>CONFIGURE_HAS_INFODIR</td>
1.386     wiz      12527: <td>CONFIGURE_HAS_MANDIR</td>
1.269     leot     12528: </tr>
                   12529: <tr>
1.396   ! wiz      12530: <td>CONFIGURE_SCRIPT</td>
1.386     wiz      12531: <td>CONFIG_SHELL</td>
1.269     leot     12532: </tr>
                   12533: <tr>
1.396   ! wiz      12534: <td>CONFIG_SHELL_FLAGS</td>
1.386     wiz      12535: <td>CONF_FILES</td>
1.269     leot     12536: </tr>
                   12537: <tr>
1.396   ! wiz      12538: <td>CONF_FILES_MODE</td>
1.386     wiz      12539: <td>CONF_FILES_PERMS</td>
1.269     leot     12540: </tr>
                   12541: <tr>
1.396   ! wiz      12542: <td>CONSERVER_DEFAULTHOST</td>
1.386     wiz      12543: <td>CONSERVER_DEFAULTPORT</td>
1.269     leot     12544: </tr>
                   12545: <tr>
1.396   ! wiz      12546: <td>CP</td>
1.386     wiz      12547: <td>CPE</td>
1.269     leot     12548: </tr>
                   12549: <tr>
1.396   ! wiz      12550: <td>CPE_EDITION</td>
1.386     wiz      12551: <td>CPE_LANG</td>
1.347     gutterid 12552: </tr>
                   12553: <tr>
1.396   ! wiz      12554: <td>CPE_OTHER</td>
1.386     wiz      12555: <td>CPE_PART</td>
1.347     gutterid 12556: </tr>
                   12557: <tr>
1.396   ! wiz      12558: <td>CPE_PRODUCT</td>
1.386     wiz      12559: <td>CPE_SW_EDITION</td>
1.347     gutterid 12560: </tr>
                   12561: <tr>
1.396   ! wiz      12562: <td>CPE_TARGET_HW</td>
1.386     wiz      12563: <td>CPE_TARGET_SW</td>
1.347     gutterid 12564: </tr>
                   12565: <tr>
1.396   ! wiz      12566: <td>CPE_UPDATE</td>
1.386     wiz      12567: <td>CPE_URI</td>
1.347     gutterid 12568: </tr>
                   12569: <tr>
1.396   ! wiz      12570: <td>CPE_VENDOR</td>
1.386     wiz      12571: <td>CPE_VERSION</td>
1.347     gutterid 12572: </tr>
                   12573: <tr>
1.396   ! wiz      12574: <td>CPP</td>
1.386     wiz      12575: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     12576: </tr>
                   12577: <tr>
1.396   ! wiz      12578: <td>CREATE_WRKDIR_SYMLINK</td>
1.386     wiz      12579: <td>CROSSBASE</td>
1.269     leot     12580: </tr>
                   12581: <tr>
1.396   ! wiz      12582: <td>CTFCONVERT</td>
1.386     wiz      12583: <td>CTF_FILES_SKIP</td>
1.269     leot     12584: </tr>
                   12585: <tr>
1.396   ! wiz      12586: <td>CTF_SUPPORTED</td>
1.386     wiz      12587: <td>CTYPE</td>
1.269     leot     12588: </tr>
                   12589: <tr>
1.396   ! wiz      12590: <td>CUPS_GROUP</td>
1.386     wiz      12591: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     12592: </tr>
                   12593: <tr>
1.396   ! wiz      12594: <td>CUPS_USER</td>
1.386     wiz      12595: <td>CURSES_DEFAULT</td>
1.292     leot     12596: </tr>
                   12597: <tr>
1.396   ! wiz      12598: <td>CURSES_TYPE</td>
1.386     wiz      12599: <td>CVS_EXTRACTDIR</td>
1.342     wiz      12600: </tr>
                   12601: <tr>
1.396   ! wiz      12602: <td>CVS_MODULE</td>
1.386     wiz      12603: <td>CVS_PROJECT</td>
1.382     wiz      12604: </tr>
                   12605: <tr>
1.396   ! wiz      12606: <td>CVS_REPOSITORIES</td>
1.386     wiz      12607: <td>CVS_ROOT</td>
1.382     wiz      12608: </tr>
                   12609: <tr>
1.396   ! wiz      12610: <td>CVS_ROOT_GNU</td>
1.386     wiz      12611: <td>CVS_ROOT_NONGNU</td>
1.382     wiz      12612: </tr>
                   12613: <tr>
1.396   ! wiz      12614: <td>CVS_ROOT_SOURCEFORGE</td>
1.386     wiz      12615: <td>CVS_TAG</td>
1.382     wiz      12616: </tr>
                   12617: <tr>
1.396   ! wiz      12618: <td>CYRUS_GROUP</td>
1.386     wiz      12619: <td>CYRUS_IDLE</td>
1.378     leot     12620: </tr>
                   12621: <tr>
1.396   ! wiz      12622: <td>CYRUS_USER</td>
1.386     wiz      12623: <td>DAEMONTOOLS_GROUP</td>
1.376     wiz      12624: </tr>
                   12625: <tr>
1.396   ! wiz      12626: <td>DAEMONTOOLS_LOG_USER</td>
1.386     wiz      12627: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.369     wiz      12628: </tr>
                   12629: <tr>
1.396   ! wiz      12630: <td>DARWIN_REQUIRES_FILTER</td>
1.386     wiz      12631: <td>DBUS_GROUP</td>
1.367     gdt      12632: </tr>
                   12633: <tr>
1.396   ! wiz      12634: <td>DBUS_USER</td>
1.386     wiz      12635: <td>DEFANG_GROUP</td>
1.360     leot     12636: </tr>
                   12637: <tr>
1.396   ! wiz      12638: <td>DEFANG_USER</td>
1.386     wiz      12639: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.352     wiz      12640: </tr>
                   12641: <tr>
1.396   ! wiz      12642: <td>DEFAULT_DISTFILES</td>
1.386     wiz      12643: <td>DEFAULT_IRC_SERVER</td>
1.348     wiz      12644: </tr>
                   12645: <tr>
1.396   ! wiz      12646: <td>DEFAULT_SERIAL_DEVICE</td>
1.386     wiz      12647: <td>DEF_UMASK</td>
1.332     rillig   12648: </tr>
                   12649: <tr>
1.396   ! wiz      12650: <td>DEINSTALLDEPENDS</td>
1.386     wiz      12651: <td>DEINSTALL_SRC</td>
1.329     leot     12652: </tr>
                   12653: <tr>
1.396   ! wiz      12654: <td>DEINSTALL_TEMPLATES</td>
1.386     wiz      12655: <td>DELAYED_ERROR_MSG</td>
1.327     wiz      12656: </tr>
                   12657: <tr>
1.396   ! wiz      12658: <td>DELAYED_WARNING_MSG</td>
1.386     wiz      12659: <td>DEPENDS</td>
1.320     wiz      12660: </tr>
                   12661: <tr>
1.396   ! wiz      12662: <td>DEPENDS_TARGET</td>
1.386     wiz      12663: <td>DEPENDS_TYPE</td>
1.311     leot     12664: </tr>
                   12665: <tr>
1.396   ! wiz      12666: <td>DESTDIR</td>
1.386     wiz      12667: <td>DESTDIR_VARNAME</td>
1.269     leot     12668: </tr>
                   12669: <tr>
1.396   ! wiz      12670: <td>DIALER_GROUP</td>
1.386     wiz      12671: <td>DIGEST_REQD</td>
1.269     leot     12672: </tr>
                   12673: <tr>
1.396   ! wiz      12674: <td>DISTDIR</td>
1.386     wiz      12675: <td>DISTFILES</td>
1.269     leot     12676: </tr>
                   12677: <tr>
1.396   ! wiz      12678: <td>DISTINFO_FILE</td>
1.386     wiz      12679: <td>DISTNAME</td>
1.309     gutterid 12680: </tr>
                   12681: <tr>
1.396   ! wiz      12682: <td>DIST_PATH</td>
1.386     wiz      12683: <td>DIST_SUBDIR</td>
1.269     leot     12684: </tr>
                   12685: <tr>
1.396   ! wiz      12686: <td>DJBDNS_AXFR_USER</td>
1.386     wiz      12687: <td>DJBDNS_CACHE_USER</td>
1.269     leot     12688: </tr>
                   12689: <tr>
1.396   ! wiz      12690: <td>DJBDNS_DJBDNS_GROUP</td>
1.386     wiz      12691: <td>DJBDNS_LOG_USER</td>
1.269     leot     12692: </tr>
                   12693: <tr>
1.396   ! wiz      12694: <td>DJBDNS_RBL_USER</td>
1.386     wiz      12695: <td>DJBDNS_TINY_USER</td>
1.269     leot     12696: </tr>
                   12697: <tr>
1.396   ! wiz      12698: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.386     wiz      12699: <td>DL_AUTO_VARS</td>
1.269     leot     12700: </tr>
                   12701: <tr>
1.396   ! wiz      12702: <td>DL_CFLAGS</td>
1.386     wiz      12703: <td>DL_LDFLAGS</td>
1.269     leot     12704: </tr>
                   12705: <tr>
1.396   ! wiz      12706: <td>DL_LIBS</td>
1.386     wiz      12707: <td>DNS</td>
1.269     leot     12708: </tr>
                   12709: <tr>
1.396   ! wiz      12710: <td>DOCOWN</td>
1.386     wiz      12711: <td>DOWNLOADED_DISTFILE</td>
1.269     leot     12712: </tr>
                   12713: <tr>
1.396   ! wiz      12714: <td>DQCACHE_GROUP</td>
1.386     wiz      12715: <td>DQCACHE_USER</td>
1.269     leot     12716: </tr>
                   12717: <tr>
1.396   ! wiz      12718: <td>DT_LAYOUT</td>
1.386     wiz      12719: <td>DYNAMIC_SITES_CMD</td>
1.269     leot     12720: </tr>
                   12721: <tr>
1.396   ! wiz      12722: <td>DYNAMIC_SITES_SCRIPT</td>
1.386     wiz      12723: <td>ECHO</td>
1.269     leot     12724: </tr>
                   12725: <tr>
1.396   ! wiz      12726: <td>ECHO_N</td>
1.386     wiz      12727: <td>ELK_GUI</td>
1.269     leot     12728: </tr>
                   12729: <tr>
1.396   ! wiz      12730: <td>EMACS_TYPE</td>
1.386     wiz      12731: <td>EMULDIR</td>
1.269     leot     12732: </tr>
                   12733: <tr>
1.396   ! wiz      12734: <td>EMULSUBDIR</td>
1.386     wiz      12735: <td>EMULSUBDIRSLASH</td>
1.269     leot     12736: </tr>
                   12737: <tr>
1.396   ! wiz      12738: <td>EMUL_ARCH</td>
1.386     wiz      12739: <td>EMUL_DISTRO</td>
1.269     leot     12740: </tr>
                   12741: <tr>
1.396   ! wiz      12742: <td>EMUL_EXEC_FMT</td>
1.386     wiz      12743: <td>EMUL_IS_NATIVE</td>
1.269     leot     12744: </tr>
                   12745: <tr>
1.396   ! wiz      12746: <td>EMUL_MODULES</td>
1.386     wiz      12747: <td>EMUL_OPSYS</td>
1.357     gutterid 12748: </tr>
                   12749: <tr>
1.396   ! wiz      12750: <td>EMUL_PKG_FMT</td>
1.386     wiz      12751: <td>EMUL_PLATFORM</td>
1.333     nia      12752: </tr>
                   12753: <tr>
1.396   ! wiz      12754: <td>EMUL_PLATFORMS</td>
1.386     wiz      12755: <td>EMUL_PREFER</td>
1.269     leot     12756: </tr>
                   12757: <tr>
1.396   ! wiz      12758: <td>EMUL_REQD</td>
1.386     wiz      12759: <td>EMUL_TYPE</td>
1.269     leot     12760: </tr>
                   12761: <tr>
1.396   ! wiz      12762: <td>ERROR_MSG</td>
1.386     wiz      12763: <td>EXIM_GROUP</td>
1.269     leot     12764: </tr>
                   12765: <tr>
1.396   ! wiz      12766: <td>EXIM_USER</td>
1.386     wiz      12767: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269     leot     12768: </tr>
                   12769: <tr>
1.396   ! wiz      12770: <td>EXTRACTOR</td>
1.386     wiz      12771: <td>EXTRACT_CMD</td>
1.269     leot     12772: </tr>
                   12773: <tr>
1.396   ! wiz      12774: <td>EXTRACT_CMD_DEFAULT</td>
1.386     wiz      12775: <td>EXTRACT_DIR</td>
1.269     leot     12776: </tr>
                   12777: <tr>
1.396   ! wiz      12778: <td>EXTRACT_ELEMENTS</td>
1.386     wiz      12779: <td>EXTRACT_ENV</td>
1.269     leot     12780: </tr>
                   12781: <tr>
1.396   ! wiz      12782: <td>EXTRACT_ONLY</td>
1.386     wiz      12783: <td>EXTRACT_OPTS</td>
1.269     leot     12784: </tr>
                   12785: <tr>
1.396   ! wiz      12786: <td>EXTRACT_SUFX</td>
1.386     wiz      12787: <td>EXTRACT_USING</td>
1.269     leot     12788: </tr>
                   12789: <tr>
1.396   ! wiz      12790: <td>FAIL</td>
1.386     wiz      12791: <td>FAILOVER_FETCH</td>
1.269     leot     12792: </tr>
                   12793: <tr>
1.396   ! wiz      12794: <td>FAIL_MSG</td>
1.386     wiz      12795: <td>FAKE_NCURSES</td>
1.269     leot     12796: </tr>
                   12797: <tr>
1.396   ! wiz      12798: <td>FAM</td>
1.386     wiz      12799: <td>FAM_ACCEPTED</td>
1.269     leot     12800: </tr>
                   12801: <tr>
1.396   ! wiz      12802: <td>FAM_DEFAULT</td>
1.386     wiz      12803: <td>FAM_SERVER</td>
1.269     leot     12804: </tr>
                   12805: <tr>
1.396   ! wiz      12806: <td>FCPATH</td>
1.386     wiz      12807: <td>FETCH_AFTER_ARGS</td>
1.338     nia      12808: </tr>
                   12809: <tr>
1.396   ! wiz      12810: <td>FETCH_BEFORE_ARGS</td>
1.386     wiz      12811: <td>FETCH_CMD</td>
1.269     leot     12812: </tr>
                   12813: <tr>
1.396   ! wiz      12814: <td>FETCH_INSECURE</td>
1.381     dholland 12815: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     12816: </tr>
                   12817: <tr>
1.396   ! wiz      12818: <td>FETCH_PROXY</td>
1.381     dholland 12819: <td>FETCH_RESUME_ARGS</td>
1.269     leot     12820: </tr>
                   12821: <tr>
1.396   ! wiz      12822: <td>FETCH_TIMEOUT</td>
1.381     dholland 12823: <td>FETCH_USE_IPV4_ONLY</td>
1.269     leot     12824: </tr>
                   12825: <tr>
1.396   ! wiz      12826: <td>FETCH_USING</td>
1.381     dholland 12827: <td>FILES_SUBST</td>
1.269     leot     12828: </tr>
                   12829: <tr>
1.396   ! wiz      12830: <td>FILES_SUBST_SED</td>
1.378     leot     12831: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     12832: </tr>
                   12833: <tr>
1.396   ! wiz      12834: <td>FONTDIR</td>
1.377     jnemeth  12835: <td>FONTS_DIRS</td>
1.382     wiz      12836: </tr>
                   12837: <tr>
1.396   ! wiz      12838: <td>FONTS_VERBOSE</td>
1.382     wiz      12839: <td>FOO_HACKS_MK</td>
1.269     leot     12840: </tr>
                   12841: <tr>
1.396   ! wiz      12842: <td>FORCE_CXX_STD</td>
1.382     wiz      12843: <td>FORCE_C_STD</td>
                   12844: </tr>
                   12845: <tr>
1.396   ! wiz      12846: <td>FOSSIL_EXTRACTDIR</td>
1.382     wiz      12847: <td>FOSSIL_REPO</td>
                   12848: </tr>
                   12849: <tr>
1.396   ! wiz      12850: <td>FOSSIL_REPOSITORIES</td>
1.382     wiz      12851: <td>FOSSIL_VERSION</td>
1.292     leot     12852: </tr>
                   12853: <tr>
1.396   ! wiz      12854: <td>FOX_USE_XUNICODE</td>
1.382     wiz      12855: <td>FREEWNN_GROUP</td>
1.378     leot     12856: </tr>
                   12857: <tr>
1.396   ! wiz      12858: <td>FREEWNN_USER</td>
1.382     wiz      12859: <td>FTP_PKG_URL_DIR</td>
1.269     leot     12860: </tr>
                   12861: <tr>
1.396   ! wiz      12862: <td>FTP_PKG_URL_HOST</td>
1.382     wiz      12863: <td>GAMEDATAMODE</td>
1.269     leot     12864: </tr>
                   12865: <tr>
1.396   ! wiz      12866: <td>GAMEDATA_PERMS</td>
1.382     wiz      12867: <td>GAMEDIRMODE</td>
1.269     leot     12868: </tr>
                   12869: <tr>
1.396   ! wiz      12870: <td>GAMEDIR_PERMS</td>
1.382     wiz      12871: <td>GAMEGRP</td>
1.269     leot     12872: </tr>
                   12873: <tr>
1.396   ! wiz      12874: <td>GAMEMODE</td>
1.382     wiz      12875: <td>GAMEOWN</td>
1.269     leot     12876: </tr>
                   12877: <tr>
1.396   ! wiz      12878: <td>GAMES_GROUP</td>
1.382     wiz      12879: <td>GAMES_USER</td>
1.269     leot     12880: </tr>
                   12881: <tr>
1.396   ! wiz      12882: <td>GCC</td>
1.382     wiz      12883: <td>GCCBASE</td>
1.269     leot     12884: </tr>
                   12885: <tr>
1.396   ! wiz      12886: <td>GCC_REQD</td>
1.382     wiz      12887: <td>GCC_VERSION_SUFFIX</td>
1.269     leot     12888: </tr>
                   12889: <tr>
1.396   ! wiz      12890: <td>GEM_BUILD</td>
1.382     wiz      12891: <td>GEM_CLEANBUILD</td>
1.269     leot     12892: </tr>
                   12893: <tr>
1.396   ! wiz      12894: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.382     wiz      12895: <td>GEM_DOCDIR</td>
1.269     leot     12896: </tr>
                   12897: <tr>
1.396   ! wiz      12898: <td>GEM_EXTSDIR</td>
1.382     wiz      12899: <td>GEM_HOME</td>
1.269     leot     12900: </tr>
                   12901: <tr>
1.396   ! wiz      12902: <td>GEM_KEEPBUILD</td>
1.382     wiz      12903: <td>GEM_LIBDIR</td>
1.374     wiz      12904: </tr>
                   12905: <tr>
1.396   ! wiz      12906: <td>GEM_NAME</td>
1.382     wiz      12907: <td>GEM_PATH</td>
1.292     leot     12908: </tr>
                   12909: <tr>
1.396   ! wiz      12910: <td>GEM_PLUGINSDIR</td>
1.382     wiz      12911: <td>GEM_SPECFILE</td>
1.269     leot     12912: </tr>
                   12913: <tr>
1.396   ! wiz      12914: <td>GENERATE_PLIST</td>
1.382     wiz      12915: <td>GHC</td>
1.269     leot     12916: </tr>
                   12917: <tr>
1.396   ! wiz      12918: <td>GHOSTSCRIPT_REQD</td>
1.382     wiz      12919: <td>GITHUB_PROJECT</td>
1.269     leot     12920: </tr>
                   12921: <tr>
1.396   ! wiz      12922: <td>GITHUB_RELEASE</td>
1.382     wiz      12923: <td>GITHUB_SUBMODULES</td>
1.269     leot     12924: </tr>
                   12925: <tr>
1.396   ! wiz      12926: <td>GITHUB_TAG</td>
1.382     wiz      12927: <td>GITHUB_TYPE</td>
1.292     leot     12928: </tr>
                   12929: <tr>
1.396   ! wiz      12930: <td>GITLAB_PROJECT</td>
1.382     wiz      12931: <td>GITLAB_RELEASE</td>
1.311     leot     12932: </tr>
                   12933: <tr>
1.396   ! wiz      12934: <td>GITLAB_SUBMODULES</td>
1.382     wiz      12935: <td>GITLAB_TAG</td>
1.269     leot     12936: </tr>
                   12937: <tr>
1.396   ! wiz      12938: <td>GITLAB_TYPE</td>
1.382     wiz      12939: <td>GIT_BRANCH</td>
1.396   ! wiz      12940: </tr>
        !          12941: <tr>
1.389     wiz      12942: <td>GIT_ENV</td>
1.396   ! wiz      12943: <td>GIT_EXTRACTDIR</td>
1.382     wiz      12944: </tr>
                   12945: <tr>
1.389     wiz      12946: <td>GIT_REPO</td>
1.396   ! wiz      12947: <td>GIT_REPOSITORIES</td>
1.382     wiz      12948: </tr>
                   12949: <tr>
1.389     wiz      12950: <td>GIT_REVISION</td>
1.396   ! wiz      12951: <td>GIT_TAG</td>
1.382     wiz      12952: </tr>
                   12953: <tr>
1.389     wiz      12954: <td>GNAT</td>
1.396   ! wiz      12955: <td>GNU</td>
1.338     nia      12956: </tr>
                   12957: <tr>
1.389     wiz      12958: <td>GNU_CONFIGURE</td>
1.396   ! wiz      12959: <td>GNU_CONFIGURE_ICONV</td>
1.378     leot     12960: </tr>
                   12961: <tr>
1.389     wiz      12962: <td>GNU_CONFIGURE_INFODIR</td>
1.396   ! wiz      12963: <td>GNU_CONFIGURE_MANDIR</td>
1.376     wiz      12964: </tr>
                   12965: <tr>
1.389     wiz      12966: <td>GNU_CONFIGURE_QUIET</td>
1.396   ! wiz      12967: <td>GNU_CONFIGURE_STRICT</td>
1.369     wiz      12968: </tr>
                   12969: <tr>
1.391     wiz      12970: <td>GOFLAGS</td>
1.396   ! wiz      12971: <td>GO_BUILD_PATTERN</td>
1.391     wiz      12972: </tr>
                   12973: <tr>
                   12974: <td>GO_DIST_BASE</td>
1.396   ! wiz      12975: <td>GO_EXTRA_MOD_DIRS</td>
1.360     leot     12976: </tr>
                   12977: <tr>
1.391     wiz      12978: <td>GO_MODULE_EXTRACT</td>
1.396   ! wiz      12979: <td>GO_MODULE_FILES</td>
1.355     rillig   12980: </tr>
                   12981: <tr>
1.391     wiz      12982: <td>GO_SRCPATH</td>
1.396   ! wiz      12983: <td>GROUP_SPECIFIC_PKGS</td>
1.348     wiz      12984: </tr>
                   12985: <tr>
1.391     wiz      12986: <td>GRUB_NETWORK_CARDS</td>
1.396   ! wiz      12987: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     12988: </tr>
                   12989: <tr>
1.391     wiz      12990: <td>GRUB_SCAN_ARGS</td>
1.396   ! wiz      12991: <td>GZIP</td>
1.269     leot     12992: </tr>
                   12993: <tr>
1.391     wiz      12994: <td>HASKELL_COMPILER</td>
1.396   ! wiz      12995: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.352     wiz      12996: </tr>
                   12997: <tr>
1.391     wiz      12998: <td>HASKELL_DISABLE_LIBRARIES</td>
1.396   ! wiz      12999: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.382     wiz      13000: </tr>
                   13001: <tr>
1.391     wiz      13002: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.396   ! wiz      13003: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.276     leot     13004: </tr>
                   13005: <tr>
1.391     wiz      13006: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.396   ! wiz      13007: <td>HASKELL_ENABLE_TESTS</td>
1.269     leot     13008: </tr>
                   13009: <tr>
1.391     wiz      13010: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.396   ! wiz      13011: <td>HASKELL_PKG_NAME</td>
1.332     rillig   13012: </tr>
                   13013: <tr>
1.391     wiz      13014: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.396   ! wiz      13015: <td>HEADER_TEMPLATES</td>
1.341     gutterid 13016: </tr>
                   13017: <tr>
1.391     wiz      13018: <td>HG_REPO</td>
1.396   ! wiz      13019: <td>HG_REPOSITORIES</td>
1.382     wiz      13020: </tr>
                   13021: <tr>
1.391     wiz      13022: <td>HG_TAG</td>
1.396   ! wiz      13023: <td>HOMEPAGE</td>
1.335     nia      13024: </tr>
                   13025: <tr>
1.391     wiz      13026: <td>HOST_PKGTOOLS_ARGS</td>
1.396   ! wiz      13027: <td>HOST_SPECIFIC_PKGS</td>
1.378     leot     13028: </tr>
                   13029: <tr>
1.391     wiz      13030: <td>HOWL_GROUP</td>
1.396   ! wiz      13031: <td>HOWL_USER</td>
1.378     leot     13032: </tr>
                   13033: <tr>
1.391     wiz      13034: <td>ICCBASE</td>
1.396   ! wiz      13035: <td>ICECAST_CHROOTDIR</td>
1.329     leot     13036: </tr>
                   13037: <tr>
1.391     wiz      13038: <td>ICON_THEMES</td>
1.396   ! wiz      13039: <td>IDOBASE</td>
1.360     leot     13040: </tr>
                   13041: <tr>
1.391     wiz      13042: <td>IGNORE_CCACHE</td>
1.396   ! wiz      13043: <td>IGNORE_INFO_DIRS</td>
1.355     rillig   13044: </tr>
                   13045: <tr>
1.391     wiz      13046: <td>IGNORE_INTERACTIVE_FETCH</td>
1.396   ! wiz      13047: <td>IMAKE</td>
1.348     wiz      13048: </tr>
                   13049: <tr>
1.391     wiz      13050: <td>IMAKEOPTS</td>
1.396   ! wiz      13051: <td>IMAKE_MAKE</td>
1.342     wiz      13052: </tr>
                   13053: <tr>
1.391     wiz      13054: <td>IMAKE_MANINSTALL</td>
1.396   ! wiz      13055: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.338     nia      13056: </tr>
                   13057: <tr>
1.391     wiz      13058: <td>IMDICTDIR</td>
1.396   ! wiz      13059: <td>INCOMPAT_CURSES</td>
1.269     leot     13060: </tr>
                   13061: <tr>
1.391     wiz      13062: <td>INFO_DIR</td>
1.396   ! wiz      13063: <td>INFO_FILES</td>
1.305     bacon    13064: </tr>
                   13065: <tr>
1.391     wiz      13066: <td>INFO_MSG</td>
1.396   ! wiz      13067: <td>INIT_SYSTEM</td>
1.269     leot     13068: </tr>
                   13069: <tr>
1.391     wiz      13070: <td>INN_DATA_DIR</td>
1.396   ! wiz      13071: <td>INN_GROUP</td>
1.269     leot     13072: </tr>
                   13073: <tr>
1.391     wiz      13074: <td>INN_USER</td>
1.396   ! wiz      13075: <td>INSTALLATION_DIRS</td>
1.269     leot     13076: </tr>
                   13077: <tr>
1.391     wiz      13078: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.396   ! wiz      13079: <td>INSTALL_ENV</td>
1.269     leot     13080: </tr>
                   13081: <tr>
1.391     wiz      13082: <td>INSTALL_ENV_SHELL</td>
1.396   ! wiz      13083: <td>INSTALL_SH_OVERRIDE</td>
1.269     leot     13084: </tr>
                   13085: <tr>
1.391     wiz      13086: <td>INSTALL_SRC</td>
1.396   ! wiz      13087: <td>INSTALL_TEMPLATES</td>
1.269     leot     13088: </tr>
                   13089: <tr>
1.391     wiz      13090: <td>INSTALL_UNSTRIPPED</td>
1.396   ! wiz      13091: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269     leot     13092: </tr>
                   13093: <tr>
1.391     wiz      13094: <td>IRCD_HYBRID_IRC_USER</td>
1.396   ! wiz      13095: <td>IRCD_HYBRID_MAXCONN</td>
1.269     leot     13096: </tr>
                   13097: <tr>
1.391     wiz      13098: <td>IRCD_HYBRID_NICLEN</td>
1.396   ! wiz      13099: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.369     wiz      13100: </tr>
                   13101: <tr>
1.391     wiz      13102: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.396   ! wiz      13103: <td>IRCD_HYBRID_TOPICLEN</td>
1.287     rillig   13104: </tr>
                   13105: <tr>
1.391     wiz      13106: <td>IRIX</td>
1.396   ! wiz      13107: <td>IRRD_USE_PGP</td>
1.269     leot     13108: </tr>
                   13109: <tr>
1.391     wiz      13110: <td>JABBERD_GROUP</td>
1.396   ! wiz      13111: <td>JABBERD_LOGDIR</td>
1.269     leot     13112: </tr>
                   13113: <tr>
1.391     wiz      13114: <td>JABBERD_PIDDIR</td>
1.396   ! wiz      13115: <td>JABBERD_SPOOLDIR</td>
1.269     leot     13116: </tr>
                   13117: <tr>
1.391     wiz      13118: <td>JABBERD_USER</td>
1.396   ! wiz      13119: <td>JAVA_APP_PATH</td>
1.269     leot     13120: </tr>
                   13121: <tr>
1.391     wiz      13122: <td>JAVA_APP_TARGETS</td>
1.396   ! wiz      13123: <td>JAVA_BINPREFIX</td>
1.382     wiz      13124: </tr>
                   13125: <tr>
1.391     wiz      13126: <td>JAVA_CLASSPATH</td>
1.396   ! wiz      13127: <td>JAVA_HOME</td>
1.378     leot     13128: </tr>
                   13129: <tr>
1.391     wiz      13130: <td>JAVA_LD_LIBRARY_PATH</td>
1.396   ! wiz      13131: <td>JAVA_NAME</td>
1.376     wiz      13132: </tr>
                   13133: <tr>
1.391     wiz      13134: <td>JAVA_UNLIMIT</td>
1.396   ! wiz      13135: <td>JAVA_WRAPPERS</td>
1.367     gdt      13136: </tr>
                   13137: <tr>
1.391     wiz      13138: <td>JPEG_ACCEPTED</td>
1.396   ! wiz      13139: <td>JPEG_DEFAULT</td>
1.360     leot     13140: </tr>
                   13141: <tr>
1.391     wiz      13142: <td>KERBEROS</td>
1.396   ! wiz      13143: <td>KERMIT_SUID_UUCP</td>
1.269     leot     13144: </tr>
                   13145: <tr>
1.391     wiz      13146: <td>KJS_USE_PCRE</td>
1.396   ! wiz      13147: <td>KNEWS_DOMAIN_FILE</td>
1.348     wiz      13148: </tr>
                   13149: <tr>
1.391     wiz      13150: <td>KNEWS_DOMAIN_NAME</td>
1.396   ! wiz      13151: <td>KRB5_ACCEPTED</td>
1.292     leot     13152: </tr>
                   13153: <tr>
1.391     wiz      13154: <td>KRB5_DEFAULT</td>
1.396   ! wiz      13155: <td>LANGUAGES</td>
1.342     wiz      13156: </tr>
                   13157: <tr>
1.391     wiz      13158: <td>LAPACKE_LIBS</td>
1.396   ! wiz      13159: <td>LAPACKE_PC</td>
1.311     leot     13160: </tr>
                   13161: <tr>
1.391     wiz      13162: <td>LAPACK_LIBS</td>
1.396   ! wiz      13163: <td>LAPACK_PC</td>
1.269     leot     13164: </tr>
                   13165: <tr>
1.391     wiz      13166: <td>LATEX2HTML_ICONPATH</td>
1.396   ! wiz      13167: <td>LDCONFIG_ADD_CMD</td>
1.332     rillig   13168: </tr>
                   13169: <tr>
1.391     wiz      13170: <td>LDCONFIG_REMOVE_CMD</td>
1.396   ! wiz      13171: <td>LDD</td>
1.269     leot     13172: </tr>
                   13173: <tr>
1.391     wiz      13174: <td>LEAFNODE_DATA_DIR</td>
1.396   ! wiz      13175: <td>LEAFNODE_GROUP</td>
1.269     leot     13176: </tr>
                   13177: <tr>
1.391     wiz      13178: <td>LEAFNODE_USER</td>
1.396   ! wiz      13179: <td>LIBDVDCSS_HOMEPAGE</td>
1.269     leot     13180: </tr>
                   13181: <tr>
1.391     wiz      13182: <td>LIBDVDCSS_MASTER_SITES</td>
1.396   ! wiz      13183: <td>LIBIMAGEQUANT_TYPE</td>
1.269     leot     13184: </tr>
                   13185: <tr>
1.391     wiz      13186: <td>LIBRSVG_TYPE</td>
1.396   ! wiz      13187: <td>LIBTOOL</td>
1.292     leot     13188: </tr>
                   13189: <tr>
1.391     wiz      13190: <td>LIBTOOLIZE_PLIST</td>
1.396   ! wiz      13191: <td>LIBTOOL_M4_OVERRIDE</td>
1.271     brook    13192: </tr>
                   13193: <tr>
1.391     wiz      13194: <td>LIBUSB_TYPE</td>
1.396   ! wiz      13195: <td>LICENSE</td>
1.269     leot     13196: </tr>
                   13197: <tr>
1.391     wiz      13198: <td>LINKER_RPATH_FLAG</td>
1.396   ! wiz      13199: <td>LINK_RPATH_FLAG</td>
1.269     leot     13200: </tr>
                   13201: <tr>
1.391     wiz      13202: <td>LINUX_BASE_NODEPS</td>
1.396   ! wiz      13203: <td>LINUX_BASE_PREFERRED</td>
1.369     wiz      13204: </tr>
                   13205: <tr>
1.391     wiz      13206: <td>LINUX_BASE_REQUIRED</td>
1.396   ! wiz      13207: <td>LINUX_LOCALES</td>
1.382     wiz      13208: </tr>
                   13209: <tr>
1.391     wiz      13210: <td>LOCALBASE</td>
1.396   ! wiz      13211: <td>LOCALBASE_LOCKTYPE</td>
1.355     rillig   13212: </tr>
                   13213: <tr>
1.391     wiz      13214: <td>LOCALPATCHES</td>
1.396   ! wiz      13215: <td>LOVE_DATA</td>
1.269     leot     13216: </tr>
                   13217: <tr>
1.391     wiz      13218: <td>LOVE_GAME</td>
1.396   ! wiz      13219: <td>LOVE_VERSION</td>
1.352     wiz      13220: </tr>
                   13221: <tr>
1.391     wiz      13222: <td>LOWER_OPSYS</td>
1.396   ! wiz      13223: <td>LOWER_OPSYS_VERSUFFIX</td>
1.338     nia      13224: </tr>
                   13225: <tr>
1.391     wiz      13226: <td>LOWER_VARIANT_VERSION</td>
1.396   ! wiz      13227: <td>LOWER_VENDOR</td>
1.370     gdt      13228: </tr>
                   13229: <tr>
1.391     wiz      13230: <td>LP32PLATFORMS</td>
1.396   ! wiz      13231: <td>LP64PLATFORMS</td>
1.370     gdt      13232: </tr>
                   13233: <tr>
1.391     wiz      13234: <td>LUA_BUSTED_ARGS</td>
1.396   ! wiz      13235: <td>LUA_CDIR</td>
1.269     leot     13236: </tr>
                   13237: <tr>
1.391     wiz      13238: <td>LUA_COMPILER</td>
1.396   ! wiz      13239: <td>LUA_DOCDIR</td>
1.329     leot     13240: </tr>
                   13241: <tr>
1.391     wiz      13242: <td>LUA_EXAMPLESDIR</td>
1.396   ! wiz      13243: <td>LUA_INCDIR</td>
1.269     leot     13244: </tr>
                   13245: <tr>
1.391     wiz      13246: <td>LUA_INTERPRETER</td>
1.396   ! wiz      13247: <td>LUA_LDIR</td>
1.269     leot     13248: </tr>
                   13249: <tr>
1.391     wiz      13250: <td>LUA_LINKER_MAGIC</td>
1.396   ! wiz      13251: <td>LUA_PKGPREFIX</td>
1.269     leot     13252: </tr>
                   13253: <tr>
1.391     wiz      13254: <td>LUA_SELF_CONFLICT</td>
1.396   ! wiz      13255: <td>LUA_USE_BUSTED</td>
1.336     nia      13256: </tr>
                   13257: <tr>
1.391     wiz      13258: <td>LUA_VERSIONS_ACCEPTED</td>
1.396   ! wiz      13259: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.333     nia      13260: </tr>
                   13261: <tr>
1.391     wiz      13262: <td>LUA_VERSION_DEFAULT</td>
1.396   ! wiz      13263: <td>LUA_VERSION_REQD</td>
1.382     wiz      13264: </tr>
                   13265: <tr>
1.391     wiz      13266: <td>Lua</td>
1.396   ! wiz      13267: <td>MACHINE_PLATFORM</td>
1.333     nia      13268: </tr>
                   13269: <tr>
1.391     wiz      13270: <td>MAILAGENT_DOMAIN</td>
1.396   ! wiz      13271: <td>MAILAGENT_EMAIL</td>
1.333     nia      13272: </tr>
                   13273: <tr>
1.391     wiz      13274: <td>MAILAGENT_FQDN</td>
1.396   ! wiz      13275: <td>MAILAGENT_ORGANIZATION</td>
1.333     nia      13276: </tr>
                   13277: <tr>
1.391     wiz      13278: <td>MAJORDOMO_HOMEDIR</td>
1.396   ! wiz      13279: <td>MAJOR_OS_VERSION</td>
1.333     nia      13280: </tr>
                   13281: <tr>
1.391     wiz      13282: <td>MAKEINFO_ARGS</td>
1.396   ! wiz      13283: <td>MAKE_DIRS</td>
1.376     wiz      13284: </tr>
                   13285: <tr>
1.391     wiz      13286: <td>MAKE_DIRS_PERMS</td>
1.396   ! wiz      13287: <td>MAKE_ENV</td>
1.378     leot     13288: </tr>
                   13289: <tr>
1.391     wiz      13290: <td>MAKE_FILE</td>
1.396   ! wiz      13291: <td>MAKE_FLAGS</td>
1.367     gdt      13292: </tr>
                   13293: <tr>
1.391     wiz      13294: <td>MAKE_JOBS</td>
1.396   ! wiz      13295: <td>MAKE_JOBS_METHOD</td>
1.360     leot     13296: </tr>
                   13297: <tr>
1.389     wiz      13298: <td>MAKE_JOBS_SAFE</td>
1.391     wiz      13299: <td>MAKE_PROGRAM</td>
1.320     wiz      13300: </tr>
                   13301: <tr>
1.389     wiz      13302: <td>MANCOMPRESSED_IF_MANZ</td>
1.391     wiz      13303: <td>MANINSTALL</td>
1.348     wiz      13304: </tr>
                   13305: <tr>
1.389     wiz      13306: <td>MANZ</td>
1.391     wiz      13307: <td>MARIADB_VERSIONS_ALL</td>
1.342     wiz      13308: </tr>
                   13309: <tr>
1.389     wiz      13310: <td>MASTER_SITES</td>
1.391     wiz      13311: <td>MASTER_SITE_BACKUP</td>
1.269     leot     13312: </tr>
                   13313: <tr>
1.389     wiz      13314: <td>MASTER_SITE_LOCAL</td>
1.391     wiz      13315: <td>MASTER_SITE_MOZILLA</td>
1.327     wiz      13316: </tr>
                   13317: <tr>
1.389     wiz      13318: <td>MASTER_SITE_OVERRIDE</td>
1.391     wiz      13319: <td>MASTER_SITE_PERL_CPAN</td>
1.269     leot     13320: </tr>
                   13321: <tr>
1.389     wiz      13322: <td>MASTER_SORT</td>
1.391     wiz      13323: <td>MASTER_SORT_RANDOM</td>
1.269     leot     13324: </tr>
                   13325: <tr>
1.389     wiz      13326: <td>MASTER_SORT_REGEX</td>
1.391     wiz      13327: <td>MECAB_CHARSET</td>
1.269     leot     13328: </tr>
                   13329: <tr>
1.389     wiz      13330: <td>MEDIATOMB_GROUP</td>
1.391     wiz      13331: <td>MEDIATOMB_USER</td>
1.303     bacon    13332: </tr>
                   13333: <tr>
1.389     wiz      13334: <td>MIPSPROBASE</td>
1.391     wiz      13335: <td>MIREDO_GROUP</td>
1.269     leot     13336: </tr>
                   13337: <tr>
1.389     wiz      13338: <td>MIREDO_USER</td>
1.391     wiz      13339: <td>MISSING_FEATURES</td>
1.269     leot     13340: </tr>
                   13341: <tr>
1.389     wiz      13342: <td>MKDIR</td>
1.391     wiz      13343: <td>MKPIE_SUPPORTED</td>
1.269     leot     13344: </tr>
                   13345: <tr>
1.389     wiz      13346: <td>MLDONKEY_GROUP</td>
1.391     wiz      13347: <td>MLDONKEY_HOME</td>
1.269     leot     13348: </tr>
                   13349: <tr>
1.389     wiz      13350: <td>MLDONKEY_USER</td>
1.391     wiz      13351: <td>MONOTONE_GROUP</td>
1.269     leot     13352: </tr>
                   13353: <tr>
1.389     wiz      13354: <td>MONOTONE_USER</td>
1.391     wiz      13355: <td>MOTIFBASE</td>
1.269     leot     13356: </tr>
                   13357: <tr>
1.389     wiz      13358: <td>MOTIF_TYPE</td>
1.391     wiz      13359: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     13360: </tr>
                   13361: <tr>
1.389     wiz      13362: <td>MPI_TYPE</td>
1.391     wiz      13363: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     13364: </tr>
                   13365: <tr>
1.389     wiz      13366: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.391     wiz      13367: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     13368: </tr>
                   13369: <tr>
1.389     wiz      13370: <td>MUST</td>
1.391     wiz      13371: <td>MV</td>
1.382     wiz      13372: </tr>
                   13373: <tr>
1.389     wiz      13374: <td>MYSQL_CHARSET</td>
1.391     wiz      13375: <td>MYSQL_DATADIR</td>
1.355     rillig   13376: </tr>
                   13377: <tr>
1.389     wiz      13378: <td>MYSQL_EXTRA_CHARSET</td>
1.391     wiz      13379: <td>MYSQL_GROUP</td>
1.269     leot     13380: </tr>
                   13381: <tr>
1.389     wiz      13382: <td>MYSQL_USER</td>
1.391     wiz      13383: <td>MYSQL_VERSION</td>
1.352     wiz      13384: </tr>
                   13385: <tr>
1.389     wiz      13386: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.391     wiz      13387: <td>MYSQL_VERSION_DEFAULT</td>
1.338     nia      13388: </tr>
                   13389: <tr>
1.389     wiz      13390: <td>NAGIOSCMD_GROUP</td>
1.391     wiz      13391: <td>NAGIOSDIR</td>
1.329     leot     13392: </tr>
                   13393: <tr>
1.389     wiz      13394: <td>NAGIOS_GROUP</td>
1.391     wiz      13395: <td>NAGIOS_USER</td>
1.269     leot     13396: </tr>
                   13397: <tr>
1.389     wiz      13398: <td>NATIVE_EXEC_FMT</td>
1.391     wiz      13399: <td>NATIVE_LOWER_OPSYS</td>
1.320     wiz      13400: </tr>
                   13401: <tr>
1.389     wiz      13402: <td>NATIVE_LOWER_VENDOR</td>
1.391     wiz      13403: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     13404: </tr>
                   13405: <tr>
1.389     wiz      13406: <td>NATIVE_OBJECT_FMT</td>
1.391     wiz      13407: <td>NATIVE_OPSYS_VERSION</td>
1.269     leot     13408: </tr>
                   13409: <tr>
1.389     wiz      13410: <td>NATIVE_OS_VARIANT</td>
1.391     wiz      13411: <td>NATIVE_OS_VERSION</td>
1.269     leot     13412: </tr>
                   13413: <tr>
1.389     wiz      13414: <td>NBPAX_PROGRAM_PREFIX</td>
1.391     wiz      13415: <td>NETBSD_LOGIN_NAME</td>
1.370     gdt      13416: </tr>
                   13417: <tr>
1.389     wiz      13418: <td>NMH_EDITOR</td>
1.391     wiz      13419: <td>NMH_MTA</td>
1.370     gdt      13420: </tr>
                   13421: <tr>
1.389     wiz      13422: <td>NMH_PAGER</td>
1.391     wiz      13423: <td>NODE_VERSIONS_ACCEPTED</td>
1.309     gutterid 13424: </tr>
                   13425: <tr>
1.389     wiz      13426: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.391     wiz      13427: <td>NODE_VERSION_DEFAULT</td>
1.269     leot     13428: </tr>
                   13429: <tr>
1.389     wiz      13430: <td>NODE_VERSION_REQD</td>
1.391     wiz      13431: <td>NOLOGIN</td>
1.269     leot     13432: </tr>
                   13433: <tr>
1.389     wiz      13434: <td>NOTE</td>
1.391     wiz      13435: <td>NOT_FOR_PLATFORM</td>
1.269     leot     13436: </tr>
                   13437: <tr>
1.389     wiz      13438: <td>NOT_PAX_ASLR_SAFE</td>
1.391     wiz      13439: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269     leot     13440: </tr>
                   13441: <tr>
1.389     wiz      13442: <td>NO_BUILD</td>
1.391     wiz      13443: <td>NO_CHECKSUM</td>
1.269     leot     13444: </tr>
                   13445: <tr>
1.389     wiz      13446: <td>NO_CONFIGURE</td>
1.391     wiz      13447: <td>NO_SKIP</td>
1.269     leot     13448: </tr>
                   13449: <tr>
1.389     wiz      13450: <td>NSD_GROUP</td>
1.391     wiz      13451: <td>NSD_LOG_FACILITY</td>
1.344     gutterid 13452: </tr>
                   13453: <tr>
1.389     wiz      13454: <td>NSD_USER</td>
1.391     wiz      13455: <td>NS_PREFERRED</td>
1.379     wiz      13456: </tr>
                   13457: <tr>
1.389     wiz      13458: <td>NULLMAILER_GROUP</td>
1.391     wiz      13459: <td>NULLMAILER_USER</td>
1.333     nia      13460: </tr>
                   13461: <tr>
1.389     wiz      13462: <td>OBJECT_FMT</td>
1.391     wiz      13463: <td>OBJHOSTNAME</td>
1.333     nia      13464: </tr>
                   13465: <tr>
1.389     wiz      13466: <td>OBJMACHINE</td>
1.391     wiz      13467: <td>OCAML_FINDLIB_DIRS</td>
1.293     rillig   13468: </tr>
                   13469: <tr>
1.389     wiz      13470: <td>OCAML_FINDLIB_REGISTER</td>
1.391     wiz      13471: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269     leot     13472: </tr>
                   13473: <tr>
1.389     wiz      13474: <td>OCAML_SITELIBDIR</td>
1.391     wiz      13475: <td>OMF</td>
1.269     leot     13476: </tr>
                   13477: <tr>
1.389     wiz      13478: <td>ONLY_FOR_COMPILER</td>
1.391     wiz      13479: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     13480: </tr>
                   13481: <tr>
1.389     wiz      13482: <td>OPENSSH_CHROOT</td>
1.391     wiz      13483: <td>OPENSSH_GROUP</td>
1.269     leot     13484: </tr>
                   13485: <tr>
1.389     wiz      13486: <td>OPENSSH_USER</td>
1.391     wiz      13487: <td>OPSYS</td>
1.269     leot     13488: </tr>
                   13489: <tr>
1.389     wiz      13490: <td>OPSYS_EMULDIR</td>
1.391     wiz      13491: <td>OPSYS_VERSION</td>
1.269     leot     13492: </tr>
                   13493: <tr>
1.389     wiz      13494: <td>OS</td>
1.391     wiz      13495: <td>OSS_TYPE</td>
1.269     leot     13496: </tr>
                   13497: <tr>
1.389     wiz      13498: <td>OSX</td>
1.391     wiz      13499: <td>OSX_PATH_TO_M4</td>
1.269     leot     13500: </tr>
                   13501: <tr>
1.389     wiz      13502: <td>OSX_PATH_TO_YACC</td>
1.391     wiz      13503: <td>OS_HAVE_ALSA</td>
1.382     wiz      13504: </tr>
                   13505: <tr>
1.389     wiz      13506: <td>OS_HAVE_RCD</td>
1.391     wiz      13507: <td>OS_VARIANT</td>
1.376     wiz      13508: </tr>
                   13509: <tr>
1.389     wiz      13510: <td>OS_VERSION</td>
1.391     wiz      13511: <td>OTF_FONTS_DIR</td>
1.369     wiz      13512: </tr>
                   13513: <tr>
1.389     wiz      13514: <td>OVERRIDE_DIRDEPTH</td>
1.391     wiz      13515: <td>OVERRIDE_GEMSPEC</td>
1.352     wiz      13516: </tr>
                   13517: <tr>
1.389     wiz      13518: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.391     wiz      13519: <td>OVERRIDE_ROCKSPEC</td>
1.376     wiz      13520: </tr>
                   13521: <tr>
1.389     wiz      13522: <td>OWN_DIRS</td>
1.391     wiz      13523: <td>OWN_DIRS_PERMS</td>
1.378     leot     13524: </tr>
                   13525: <tr>
1.389     wiz      13526: <td>P4GROUP</td>
1.391     wiz      13527: <td>P4PORT</td>
1.367     gdt      13528: </tr>
                   13529: <tr>
1.389     wiz      13530: <td>P4ROOT</td>
1.391     wiz      13531: <td>P4USER</td>
1.360     leot     13532: </tr>
                   13533: <tr>
1.389     wiz      13534: <td>PACKAGES</td>
1.391     wiz      13535: <td>PALMOS_DEFAULT_SDK</td>
1.348     wiz      13536: </tr>
                   13537: <tr>
1.389     wiz      13538: <td>PAMBASE</td>
1.391     wiz      13539: <td>PAM_DEFAULT</td>
1.329     leot     13540: </tr>
                   13541: <tr>
1.389     wiz      13542: <td>PAPERSIZE</td>
1.391     wiz      13543: <td>PASSIVE_FETCH</td>
1.342     wiz      13544: </tr>
                   13545: <tr>
1.389     wiz      13546: <td>PATCHDIR</td>
1.391     wiz      13547: <td>PATCHFILES</td>
1.320     wiz      13548: </tr>
                   13549: <tr>
1.389     wiz      13550: <td>PATCH_ARGS</td>
1.391     wiz      13551: <td>PATCH_DEBUG</td>
1.269     leot     13552: </tr>
                   13553: <tr>
1.389     wiz      13554: <td>PATCH_DIST_ARGS</td>
1.391     wiz      13555: <td>PATCH_DIST_CAT</td>
1.269     leot     13556: </tr>
                   13557: <tr>
1.389     wiz      13558: <td>PATCH_DIST_STRIP</td>
1.391     wiz      13559: <td>PATCH_FUZZ_FACTOR</td>
1.269     leot     13560: </tr>
                   13561: <tr>
1.389     wiz      13562: <td>PATCH_STRIP</td>
1.391     wiz      13563: <td>PATH</td>
1.269     leot     13564: </tr>
                   13565: <tr>
1.389     wiz      13566: <td>PCCBASE</td>
1.391     wiz      13567: <td>PEAR</td>
1.378     leot     13568: </tr>
                   13569: <tr>
1.389     wiz      13570: <td>PEAR_CHANNEL</td>
1.391     wiz      13571: <td>PEAR_CHANNEL_ALIAS</td>
1.382     wiz      13572: </tr>
                   13573: <tr>
1.389     wiz      13574: <td>PEAR_CHANNEL_VERSION</td>
1.391     wiz      13575: <td>PEAR_CMD</td>
1.382     wiz      13576: </tr>
                   13577: <tr>
1.389     wiz      13578: <td>PEAR_LIB</td>
1.391     wiz      13579: <td>PEAR_PACKAGE_XML</td>
1.376     wiz      13580: </tr>
                   13581: <tr>
1.389     wiz      13582: <td>PEP-518</td>
1.391     wiz      13583: <td>PERL5</td>
1.342     wiz      13584: </tr>
                   13585: <tr>
1.389     wiz      13586: <td>PERL5_CONFIGURE</td>
1.391     wiz      13587: <td>PERL5_CONFIGURE_DIRS</td>
1.269     leot     13588: </tr>
                   13589: <tr>
1.389     wiz      13590: <td>PERL5_LDFLAGS</td>
1.391     wiz      13591: <td>PERL5_LICENSE</td>
1.332     rillig   13592: </tr>
                   13593: <tr>
1.389     wiz      13594: <td>PERL5_MODULE_TYPE</td>
1.391     wiz      13595: <td>PERL5_PACKLIST</td>
1.320     wiz      13596: </tr>
                   13597: <tr>
1.389     wiz      13598: <td>PERL5_PACKLIST_DIR</td>
1.391     wiz      13599: <td>PERL5_PERLBASE</td>
1.292     leot     13600: </tr>
                   13601: <tr>
1.389     wiz      13602: <td>PERL5_SITEBASE</td>
1.391     wiz      13603: <td>PERL5_USE_PACKLIST</td>
1.274     rillig   13604: </tr>
                   13605: <tr>
1.389     wiz      13606: <td>PERL5_VENDORBASE</td>
1.391     wiz      13607: <td>PFCTL</td>
1.274     rillig   13608: </tr>
                   13609: <tr>
1.389     wiz      13610: <td>PFVAR_H</td>
1.391     wiz      13611: <td>PF_VERSION</td>
1.269     leot     13612: </tr>
                   13613: <tr>
1.389     wiz      13614: <td>PGGROUP</td>
1.391     wiz      13615: <td>PGHOME</td>
1.269     leot     13616: </tr>
                   13617: <tr>
1.389     wiz      13618: <td>PGPKGSRCDIR</td>
1.391     wiz      13619: <td>PGSQL_TYPE</td>
1.269     leot     13620: </tr>
                   13621: <tr>
1.389     wiz      13622: <td>PGSQL_VERSION</td>
1.391     wiz      13623: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     13624: </tr>
                   13625: <tr>
1.389     wiz      13626: <td>PGSQL_VERSION_DEFAULT</td>
1.391     wiz      13627: <td>PGUSER</td>
1.269     leot     13628: </tr>
                   13629: <tr>
1.389     wiz      13630: <td>PG_LIB_EXT</td>
1.391     wiz      13631: <td>PHP</td>
1.269     leot     13632: </tr>
                   13633: <tr>
1.389     wiz      13634: <td>PHPCOMMON_MK</td>
1.391     wiz      13635: <td>PHPPKGSRCDIR</td>
1.379     wiz      13636: </tr>
                   13637: <tr>
1.389     wiz      13638: <td>PHP_BASE_VERS</td>
1.391     wiz      13639: <td>PHP_EGDIR</td>
1.269     leot     13640: </tr>
                   13641: <tr>
1.389     wiz      13642: <td>PHP_EXTENSION_DIR</td>
1.391     wiz      13643: <td>PHP_INCDIR</td>
1.269     leot     13644: </tr>
                   13645: <tr>
1.389     wiz      13646: <td>PHP_LIBDIR</td>
1.391     wiz      13647: <td>PHP_MAJOR_VERS</td>
1.379     wiz      13648: </tr>
                   13649: <tr>
1.389     wiz      13650: <td>PHP_MINIMUM_TEENY</td>
1.391     wiz      13651: <td>PHP_MINOR_VERS</td>
1.379     wiz      13652: </tr>
                   13653: <tr>
1.389     wiz      13654: <td>PHP_PKG_PREFIX</td>
1.396   ! wiz      13655: <td>PHP_REQUIRE_MODULE</td>
1.269     leot     13656: </tr>
                   13657: <tr>
1.396   ! wiz      13658: <td>PHP_SHAREDIR</td>
1.389     wiz      13659: <td>PHP_VER</td>
1.269     leot     13660: </tr>
                   13661: <tr>
1.396   ! wiz      13662: <td>PHP_VERSION</td>
1.389     wiz      13663: <td>PHP_VERSIONS_ACCEPTED</td>
1.269     leot     13664: </tr>
                   13665: <tr>
1.396   ! wiz      13666: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.389     wiz      13667: <td>PHP_VERSION_DEFAULT</td>
1.269     leot     13668: </tr>
                   13669: <tr>
1.396   ! wiz      13670: <td>PHP_VERSION_REQD</td>
1.389     wiz      13671: <td>PILRC_USE_GTK</td>
1.269     leot     13672: </tr>
                   13673: <tr>
1.396   ! wiz      13674: <td>PKGCONFIG_BASE</td>
1.389     wiz      13675: <td>PKGCONFIG_FILE</td>
1.269     leot     13676: </tr>
                   13677: <tr>
1.396   ! wiz      13678: <td>PKGCONFIG_OVERRIDE</td>
1.389     wiz      13679: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269     leot     13680: </tr>
                   13681: <tr>
1.396   ! wiz      13682: <td>PKGDIR</td>
1.389     wiz      13683: <td>PKGGNUDIR</td>
1.269     leot     13684: </tr>
                   13685: <tr>
1.396   ! wiz      13686: <td>PKGINFODIR</td>
1.389     wiz      13687: <td>PKGLOCALEDIR</td>
1.269     leot     13688: </tr>
                   13689: <tr>
1.396   ! wiz      13690: <td>PKGMANDIR</td>
1.389     wiz      13691: <td>PKGNAME</td>
1.269     leot     13692: </tr>
                   13693: <tr>
1.396   ! wiz      13694: <td>PKGNAME_REQD</td>
1.389     wiz      13695: <td>PKGPATH</td>
1.269     leot     13696: </tr>
                   13697: <tr>
1.396   ! wiz      13698: <td>PKGREVISION</td>
1.389     wiz      13699: <td>PKGSRC_BLAS_TYPES</td>
1.269     leot     13700: </tr>
                   13701: <tr>
1.396   ! wiz      13702: <td>PKGSRC_CHANGES</td>
1.389     wiz      13703: <td>PKGSRC_COMPILER</td>
1.269     leot     13704: </tr>
                   13705: <tr>
1.396   ! wiz      13706: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.389     wiz      13707: <td>PKGSRC_LOCKTYPE</td>
1.269     leot     13708: </tr>
                   13709: <tr>
1.396   ! wiz      13710: <td>PKGSRC_MAKE_ENV</td>
1.389     wiz      13711: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269     leot     13712: </tr>
                   13713: <tr>
1.396   ! wiz      13714: <td>PKGSRC_MKPIE</td>
1.389     wiz      13715: <td>PKGSRC_MKREPRO</td>
1.269     leot     13716: </tr>
                   13717: <tr>
1.396   ! wiz      13718: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.389     wiz      13719: <td>PKGSRC_RUN_TEST</td>
1.292     leot     13720: </tr>
                   13721: <tr>
1.396   ! wiz      13722: <td>PKGSRC_SETENV</td>
1.389     wiz      13723: <td>PKGSRC_SLEEPSECS</td>
1.269     leot     13724: </tr>
                   13725: <tr>
1.396   ! wiz      13726: <td>PKGSRC_TODO</td>
1.389     wiz      13727: <td>PKGSRC_USE_CTF</td>
1.274     rillig   13728: </tr>
                   13729: <tr>
1.396   ! wiz      13730: <td>PKGSRC_USE_FORTIFY</td>
1.389     wiz      13731: <td>PKGSRC_USE_MKTOOLS</td>
1.269     leot     13732: </tr>
                   13733: <tr>
1.396   ! wiz      13734: <td>PKGSRC_USE_RELRO</td>
1.389     wiz      13735: <td>PKGSRC_USE_SSP</td>
1.269     leot     13736: </tr>
                   13737: <tr>
1.396   ! wiz      13738: <td>PKGSRC_USE_STACK_CHECK</td>
1.389     wiz      13739: <td>PKGTASKS_DATAFILE</td>
1.269     leot     13740: </tr>
                   13741: <tr>
1.396   ! wiz      13742: <td>PKGTOOLS_ARGS</td>
1.389     wiz      13743: <td>PKGTOOLS_ENV</td>
1.269     leot     13744: </tr>
                   13745: <tr>
1.396   ! wiz      13746: <td>PKG_ALTERNATIVES</td>
1.389     wiz      13747: <td>PKG_APACHE</td>
1.269     leot     13748: </tr>
                   13749: <tr>
1.396   ! wiz      13750: <td>PKG_APACHE_ACCEPTED</td>
1.389     wiz      13751: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     13752: </tr>
                   13753: <tr>
1.396   ! wiz      13754: <td>PKG_BEST_EXISTS</td>
1.389     wiz      13755: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     13756: </tr>
                   13757: <tr>
1.396   ! wiz      13758: <td>PKG_COMPRESSION</td>
1.389     wiz      13759: <td>PKG_CONFIG</td>
1.269     leot     13760: </tr>
                   13761: <tr>
1.396   ! wiz      13762: <td>PKG_CONFIG_PERMS</td>
1.389     wiz      13763: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     13764: </tr>
                   13765: <tr>
1.396   ! wiz      13766: <td>PKG_DBDIR</td>
1.389     wiz      13767: <td>PKG_DB_TMPDIR</td>
1.269     leot     13768: </tr>
                   13769: <tr>
1.396   ! wiz      13770: <td>PKG_DEBUG_LEVEL</td>
1.389     wiz      13771: <td>PKG_DEFAULT_OPTIONS</td>
1.269     leot     13772: </tr>
                   13773: <tr>
1.396   ! wiz      13774: <td>PKG_DESTDIR_SUPPORT</td>
1.389     wiz      13775: <td>PKG_DEVELOPER</td>
1.367     gdt      13776: </tr>
                   13777: <tr>
1.396   ! wiz      13778: <td>PKG_DISABLED_OPTIONS</td>
1.389     wiz      13779: <td>PKG_FATAL_ERRORS</td>
1.269     leot     13780: </tr>
                   13781: <tr>
1.396   ! wiz      13782: <td>PKG_FC</td>
1.389     wiz      13783: <td>PKG_FILELIST_CMD</td>
1.348     wiz      13784: </tr>
                   13785: <tr>
1.396   ! wiz      13786: <td>PKG_GECOS</td>
1.389     wiz      13787: <td>PKG_GID</td>
1.360     leot     13788: </tr>
                   13789: <tr>
1.396   ! wiz      13790: <td>PKG_GROUPS</td>
1.389     wiz      13791: <td>PKG_GROUPS_VARS</td>
1.269     leot     13792: </tr>
                   13793: <tr>
1.396   ! wiz      13794: <td>PKG_HOME</td>
1.389     wiz      13795: <td>PKG_INIT_SCRIPTS</td>
1.269     leot     13796: </tr>
                   13797: <tr>
1.396   ! wiz      13798: <td>PKG_JAVA_HOME</td>
1.389     wiz      13799: <td>PKG_JVM</td>
1.269     leot     13800: </tr>
                   13801: <tr>
1.396   ! wiz      13802: <td>PKG_JVMS_ACCEPTED</td>
1.389     wiz      13803: <td>PKG_JVM_DEFAULT</td>
1.269     leot     13804: </tr>
                   13805: <tr>
1.396   ! wiz      13806: <td>PKG_LEGACY_OPTIONS</td>
1.389     wiz      13807: <td>PKG_LIBTOOL</td>
1.269     leot     13808: </tr>
                   13809: <tr>
1.396   ! wiz      13810: <td>PKG_MKSYMLINKS</td>
1.389     wiz      13811: <td>PKG_OPTIONS</td>
1.396   ! wiz      13812: </tr>
        !          13813: <tr>
1.391     wiz      13814: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.396   ! wiz      13815: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     13816: </tr>
                   13817: <tr>
1.391     wiz      13818: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.396   ! wiz      13819: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     13820: </tr>
                   13821: <tr>
1.391     wiz      13822: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.396   ! wiz      13823: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     13824: </tr>
                   13825: <tr>
1.391     wiz      13826: <td>PKG_OPTIONS_VAR</td>
1.396   ! wiz      13827: <td>PKG_RCD_SCRIPTS</td>
1.269     leot     13828: </tr>
                   13829: <tr>
1.391     wiz      13830: <td>PKG_REFCOUNT_DBDIR</td>
1.396   ! wiz      13831: <td>PKG_REGISTER_SHELLS</td>
1.269     leot     13832: </tr>
                   13833: <tr>
1.391     wiz      13834: <td>PKG_RESUME_TRANSFERS</td>
1.396   ! wiz      13835: <td>PKG_SHELL</td>
1.269     leot     13836: </tr>
                   13837: <tr>
1.391     wiz      13838: <td>PKG_SUGGESTED_OPTIONS</td>
1.396   ! wiz      13839: <td>PKG_SUPPORTED_OPTIONS</td>
1.269     leot     13840: </tr>
                   13841: <tr>
1.391     wiz      13842: <td>PKG_SYSCONFBASE</td>
1.396   ! wiz      13843: <td>PKG_SYSCONFBASEDIR</td>
1.269     leot     13844: </tr>
                   13845: <tr>
1.391     wiz      13846: <td>PKG_SYSCONFDIR</td>
1.396   ! wiz      13847: <td>PKG_SYSCONFDIR_PERMS</td>
1.269     leot     13848: </tr>
                   13849: <tr>
1.391     wiz      13850: <td>PKG_SYSCONFSUBDIR</td>
1.396   ! wiz      13851: <td>PKG_SYSCONFVAR</td>
1.269     leot     13852: </tr>
                   13853: <tr>
1.391     wiz      13854: <td>PKG_TOOLS_BIN</td>
1.396   ! wiz      13855: <td>PKG_UID</td>
1.269     leot     13856: </tr>
                   13857: <tr>
1.391     wiz      13858: <td>PKG_UPDATE_FONTS_DB</td>
1.396   ! wiz      13859: <td>PKG_USERS</td>
1.269     leot     13860: </tr>
                   13861: <tr>
1.391     wiz      13862: <td>PKG_USERS_VARS</td>
1.396   ! wiz      13863: <td>PKG_VERBOSE</td>
1.269     leot     13864: </tr>
                   13865: <tr>
1.391     wiz      13866: <td>PLEASE</td>
1.396   ! wiz      13867: <td>PLIST</td>
1.269     leot     13868: </tr>
                   13869: <tr>
1.391     wiz      13870: <td>PLIST_AWK</td>
1.396   ! wiz      13871: <td>PLIST_AWK_ENV</td>
1.269     leot     13872: </tr>
                   13873: <tr>
1.391     wiz      13874: <td>PLIST_SRC</td>
1.396   ! wiz      13875: <td>PLIST_SUBST</td>
1.269     leot     13876: </tr>
                   13877: <tr>
1.391     wiz      13878: <td>PLIST_TYPE</td>
1.396   ! wiz      13879: <td>PLIST_VARS</td>
1.269     leot     13880: </tr>
                   13881: <tr>
1.391     wiz      13882: <td>POPTOP_USE_MPPE</td>
1.396   ! wiz      13883: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269     leot     13884: </tr>
                   13885: <tr>
1.391     wiz      13886: <td>POST_FETCH_HOOK</td>
1.396   ! wiz      13887: <td>PREFER</td>
1.269     leot     13888: </tr>
                   13889: <tr>
1.391     wiz      13890: <td>PREFER_NATIVE</td>
1.396   ! wiz      13891: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     13892: </tr>
                   13893: <tr>
1.391     wiz      13894: <td>PREFER_PKGSRC</td>
1.396   ! wiz      13895: <td>PREFIX</td>
1.269     leot     13896: </tr>
                   13897: <tr>
1.391     wiz      13898: <td>PREPEND_PATH</td>
1.396   ! wiz      13899: <td>PRE_ROOT_CMD</td>
1.269     leot     13900: </tr>
                   13901: <tr>
1.391     wiz      13902: <td>PRIVILEGED_STAGES</td>
1.396   ! wiz      13903: <td>PS</td>
1.269     leot     13904: </tr>
                   13905: <tr>
1.391     wiz      13906: <td>PTHREAD_AUTO_VARS</td>
1.396   ! wiz      13907: <td>PTHREAD_CFLAGS</td>
1.269     leot     13908: </tr>
                   13909: <tr>
1.391     wiz      13910: <td>PTHREAD_LDFLAGS</td>
1.396   ! wiz      13911: <td>PTHREAD_LIBS</td>
1.269     leot     13912: </tr>
                   13913: <tr>
1.391     wiz      13914: <td>PTHREAD_OPTS</td>
1.396   ! wiz      13915: <td>PTHREAD_TYPE</td>
1.269     leot     13916: </tr>
                   13917: <tr>
1.391     wiz      13918: <td>PVM_SSH</td>
1.396   ! wiz      13919: <td>PYPKGPREFIX</td>
1.269     leot     13920: </tr>
                   13921: <tr>
1.391     wiz      13922: <td>PYSOABISUFFIX</td>
1.396   ! wiz      13923: <td>PYTHON_27_ACCEPTED</td>
1.269     leot     13924: </tr>
                   13925: <tr>
1.391     wiz      13926: <td>PYTHON_FOR_BUILD_ONLY</td>
1.396   ! wiz      13927: <td>PYTHON_SELF_CONFLICT</td>
1.385     leot     13928: </tr>
                   13929: <tr>
1.391     wiz      13930: <td>PYTHON_VERSION</td>
1.396   ! wiz      13931: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.384     leot     13932: </tr>
                   13933: <tr>
1.391     wiz      13934: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.396   ! wiz      13935: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13936: </tr>
                   13937: <tr>
1.391     wiz      13938: <td>PYTHON_VERSION_DEFAULT</td>
1.396   ! wiz      13939: <td>PYTHON_VERSION_REQD</td>
1.269     leot     13940: </tr>
                   13941: <tr>
1.391     wiz      13942: <td>PYVERSSUFFIX</td>
1.396   ! wiz      13943: <td>QMAILDIR</td>
1.269     leot     13944: </tr>
                   13945: <tr>
1.391     wiz      13946: <td>QMAIL_ALIAS_USER</td>
1.396   ! wiz      13947: <td>QMAIL_DAEMON_USER</td>
1.269     leot     13948: </tr>
                   13949: <tr>
1.391     wiz      13950: <td>QMAIL_LOG_USER</td>
1.396   ! wiz      13951: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     13952: </tr>
                   13953: <tr>
1.391     wiz      13954: <td>QMAIL_PASSWD_USER</td>
1.396   ! wiz      13955: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     13956: </tr>
                   13957: <tr>
1.391     wiz      13958: <td>QMAIL_QUEUE_DIR</td>
1.396   ! wiz      13959: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     13960: </tr>
                   13961: <tr>
1.391     wiz      13962: <td>QMAIL_QUEUE_USER</td>
1.396   ! wiz      13963: <td>QMAIL_REMOTE_USER</td>
1.269     leot     13964: </tr>
                   13965: <tr>
1.391     wiz      13966: <td>QMAIL_ROOT_USER</td>
1.396   ! wiz      13967: <td>QMAIL_SEND_USER</td>
1.269     leot     13968: </tr>
                   13969: <tr>
1.391     wiz      13970: <td>QORE_LATEST_MODULE_API</td>
1.396   ! wiz      13971: <td>QORE_MODULE_API</td>
1.269     leot     13972: </tr>
                   13973: <tr>
1.391     wiz      13974: <td>QORE_MODULE_DIR</td>
1.396   ! wiz      13975: <td>QORE_USER_MODULE_DIR</td>
1.269     leot     13976: </tr>
                   13977: <tr>
1.391     wiz      13978: <td>QORE_VERSION</td>
1.396   ! wiz      13979: <td>QPOPPER_FAC</td>
1.269     leot     13980: </tr>
                   13981: <tr>
1.391     wiz      13982: <td>QPOPPER_SPOOL_DIR</td>
1.396   ! wiz      13983: <td>QPOPPER_USER</td>
1.269     leot     13984: </tr>
                   13985: <tr>
1.391     wiz      13986: <td>RAKE_NAME</td>
1.396   ! wiz      13987: <td>RASMOL_DEPTH</td>
1.269     leot     13988: </tr>
                   13989: <tr>
1.391     wiz      13990: <td>RCD_DIR</td>
1.396   ! wiz      13991: <td>RCD_ORDER</td>
1.269     leot     13992: </tr>
                   13993: <tr>
1.391     wiz      13994: <td>RCD_SCRIPTS</td>
1.396   ! wiz      13995: <td>RCD_SCRIPTS_DIR</td>
1.269     leot     13996: </tr>
                   13997: <tr>
1.391     wiz      13998: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.396   ! wiz      13999: <td>RCD_SCRIPTS_MODE</td>
1.382     wiz      14000: </tr>
                   14001: <tr>
1.391     wiz      14002: <td>RCD_SCRIPTS_SHELL</td>
1.396   ! wiz      14003: <td>RCD_SCRIPT_SRC</td>
1.378     leot     14004: </tr>
                   14005: <tr>
1.391     wiz      14006: <td>RCD_SUBR</td>
1.396   ! wiz      14007: <td>RDOC</td>
1.376     wiz      14008: </tr>
                   14009: <tr>
1.391     wiz      14010: <td>READLINE_DEFAULT</td>
1.396   ! wiz      14011: <td>READLINE_TYPE</td>
1.355     rillig   14012: </tr>
                   14013: <tr>
1.391     wiz      14014: <td>REAL_ROOT_GROUP</td>
1.396   ! wiz      14015: <td>REAL_ROOT_USER</td>
1.329     leot     14016: </tr>
                   14017: <tr>
1.391     wiz      14018: <td>RECURSIVE_MAKE</td>
1.396   ! wiz      14019: <td>RELAY_CTRL_DIR</td>
1.320     wiz      14020: </tr>
                   14021: <tr>
1.391     wiz      14022: <td>RELRO_SUPPORTED</td>
1.396   ! wiz      14023: <td>REPLACE_AWK</td>
1.338     nia      14024: </tr>
                   14025: <tr>
1.391     wiz      14026: <td>REPLACE_BASH</td>
1.396   ! wiz      14027: <td>REPLACE_CSH</td>
1.292     leot     14028: </tr>
                   14029: <tr>
1.391     wiz      14030: <td>REPLACE_KSH</td>
1.396   ! wiz      14031: <td>REPLACE_LUA</td>
1.329     leot     14032: </tr>
                   14033: <tr>
1.391     wiz      14034: <td>REPLACE_NODEJS</td>
1.396   ! wiz      14035: <td>REPLACE_OCTAVE</td>
1.327     wiz      14036: </tr>
                   14037: <tr>
1.391     wiz      14038: <td>REPLACE_PERL</td>
1.396   ! wiz      14039: <td>REPLACE_PERL6</td>
1.269     leot     14040: </tr>
                   14041: <tr>
1.391     wiz      14042: <td>REPLACE_PHP</td>
1.396   ! wiz      14043: <td>REPLACE_PYTHON</td>
1.320     wiz      14044: </tr>
                   14045: <tr>
1.391     wiz      14046: <td>REPLACE_QORE</td>
1.396   ! wiz      14047: <td>REPLACE_R</td>
1.311     leot     14048: </tr>
                   14049: <tr>
1.391     wiz      14050: <td>REPLACE_RUBY</td>
1.396   ! wiz      14051: <td>REPLACE_RUBY_DIRS</td>
1.269     leot     14052: </tr>
                   14053: <tr>
1.391     wiz      14054: <td>REPLACE_RUBY_PAT</td>
1.396   ! wiz      14055: <td>REPLACE_SH</td>
1.333     nia      14056: </tr>
                   14057: <tr>
1.391     wiz      14058: <td>REPLACE_TEXLUA</td>
1.396   ! wiz      14059: <td>REPLACE_TOOL_PYTHON</td>
1.269     leot     14060: </tr>
                   14061: <tr>
1.391     wiz      14062: <td>REPLACE_WISH</td>
1.396   ! wiz      14063: <td>REQD_DIRS</td>
1.369     wiz      14064: </tr>
                   14065: <tr>
1.391     wiz      14066: <td>REQD_DIRS_PERMS</td>
1.396   ! wiz      14067: <td>REQD_FILES</td>
1.331     gutterid 14068: </tr>
                   14069: <tr>
1.391     wiz      14070: <td>REQD_FILES_MODE</td>
1.396   ! wiz      14071: <td>REQD_FILES_PERMS</td>
1.269     leot     14072: </tr>
                   14073: <tr>
1.391     wiz      14074: <td>RESOLV_AUTO_VARS</td>
1.396   ! wiz      14075: <td>RESOLV_LDFLAGS</td>
1.333     nia      14076: </tr>
                   14077: <tr>
1.391     wiz      14078: <td>RESOLV_LIBS</td>
1.396   ! wiz      14079: <td>RM</td>
1.269     leot     14080: </tr>
                   14081: <tr>
1.391     wiz      14082: <td>ROCKSPEC_NAME</td>
1.396   ! wiz      14083: <td>ROCKSPEC_SPECFILE</td>
1.369     wiz      14084: </tr>
                   14085: <tr>
1.391     wiz      14086: <td>ROOT_CMD</td>
1.396   ! wiz      14087: <td>ROOT_GROUP</td>
1.378     leot     14088: </tr>
                   14089: <tr>
1.391     wiz      14090: <td>ROOT_USER</td>
1.396   ! wiz      14091: <td>RPCGEN</td>
1.382     wiz      14092: </tr>
                   14093: <tr>
1.391     wiz      14094: <td>RPM</td>
1.396   ! wiz      14095: <td>RPM2PKG_PLIST</td>
1.352     wiz      14096: </tr>
                   14097: <tr>
1.391     wiz      14098: <td>RPM2PKG_PREFIX</td>
1.396   ! wiz      14099: <td>RPM2PKG_STAGE</td>
1.269     leot     14100: </tr>
                   14101: <tr>
1.391     wiz      14102: <td>RPM2PKG_STRIP</td>
1.396   ! wiz      14103: <td>RPM2PKG_SUBPREFIX</td>
1.269     leot     14104: </tr>
                   14105: <tr>
1.391     wiz      14106: <td>RPMFILES</td>
1.396   ! wiz      14107: <td>RPMIGNOREPATH</td>
1.320     wiz      14108: </tr>
                   14109: <tr>
1.391     wiz      14110: <td>RPM_DB_PREFIX</td>
1.396   ! wiz      14111: <td>RSSH_CVS_PATH</td>
1.332     rillig   14112: </tr>
                   14113: <tr>
1.391     wiz      14114: <td>RSSH_RDIST_PATH</td>
1.396   ! wiz      14115: <td>RSSH_RSYNC_PATH</td>
1.329     leot     14116: </tr>
                   14117: <tr>
1.391     wiz      14118: <td>RSSH_SCP_PATH</td>
1.396   ! wiz      14119: <td>RSSH_SFTP_SERVER_PATH</td>
1.327     wiz      14120: </tr>
                   14121: <tr>
1.391     wiz      14122: <td>RUBY</td>
1.396   ! wiz      14123: <td>RUBYGEM</td>
1.269     leot     14124: </tr>
                   14125: <tr>
1.391     wiz      14126: <td>RUBYGEM_MANPAGES</td>
1.396   ! wiz      14127: <td>RUBYGEM_NAME</td>
1.311     leot     14128: </tr>
                   14129: <tr>
1.391     wiz      14130: <td>RUBYGEM_OPTIONS</td>
1.396   ! wiz      14131: <td>RUBYGEM_USE_MANPAGES</td>
1.269     leot     14132: </tr>
                   14133: <tr>
1.391     wiz      14134: <td>RUBYGEM_VERBOSE</td>
1.396   ! wiz      14135: <td>RUBY_ABI_VERSION</td>
1.269     leot     14136: </tr>
                   14137: <tr>
1.391     wiz      14138: <td>RUBY_ALLOW_HAS_RDOC</td>
1.396   ! wiz      14139: <td>RUBY_ARCH</td>
1.269     leot     14140: </tr>
                   14141: <tr>
1.389     wiz      14142: <td>RUBY_ARCHINC</td>
1.396   ! wiz      14143: <td>RUBY_ARCHLIB</td>
1.346     jnemeth  14144: </tr>
                   14145: <tr>
1.389     wiz      14146: <td>RUBY_BASE</td>
1.396   ! wiz      14147: <td>RUBY_BASERIDIR</td>
1.269     leot     14148: </tr>
                   14149: <tr>
1.389     wiz      14150: <td>RUBY_BUILD_DOCUMENT</td>
1.396   ! wiz      14151: <td>RUBY_DLEXT</td>
1.269     leot     14152: </tr>
                   14153: <tr>
1.389     wiz      14154: <td>RUBY_DOC</td>
1.396   ! wiz      14155: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     14156: </tr>
                   14157: <tr>
1.389     wiz      14158: <td>RUBY_EG</td>
1.396   ! wiz      14159: <td>RUBY_EXTCONF</td>
1.269     leot     14160: </tr>
                   14161: <tr>
1.391     wiz      14162: <td>RUBY_EXTCONF_CHECK</td>
1.396   ! wiz      14163: <td>RUBY_EXTCONF_DEBUG</td>
1.269     leot     14164: </tr>
                   14165: <tr>
1.391     wiz      14166: <td>RUBY_EXTCONF_MAKEFILE</td>
1.396   ! wiz      14167: <td>RUBY_GEM_ARCH</td>
1.269     leot     14168: </tr>
                   14169: <tr>
1.391     wiz      14170: <td>RUBY_GEM_BASE</td>
1.396   ! wiz      14171: <td>RUBY_INC</td>
1.269     leot     14172: </tr>
                   14173: <tr>
1.391     wiz      14174: <td>RUBY_LIB</td>
1.396   ! wiz      14175: <td>RUBY_LIB_BASE</td>
1.269     leot     14176: </tr>
                   14177: <tr>
1.391     wiz      14178: <td>RUBY_NAME</td>
1.396   ! wiz      14179: <td>RUBY_NOVERSION</td>
1.269     leot     14180: </tr>
                   14181: <tr>
1.391     wiz      14182: <td>RUBY_PKGPREFIX</td>
1.396   ! wiz      14183: <td>RUBY_RAILS</td>
1.269     leot     14184: </tr>
                   14185: <tr>
1.394     wiz      14186: <td>RUBY_RAILS72_VERSION</td>
1.396   ! wiz      14187: <td>RUBY_RAILS80_VERSION</td>
1.269     leot     14188: </tr>
                   14189: <tr>
1.394     wiz      14190: <td>RUBY_RAILS_ACCEPTED</td>
1.396   ! wiz      14191: <td>RUBY_RAILS_DEFAULT</td>
1.338     nia      14192: </tr>
                   14193: <tr>
1.394     wiz      14194: <td>RUBY_RAILS_REQD</td>
1.396   ! wiz      14195: <td>RUBY_RAILS_STRICT_DEP</td>
1.269     leot     14196: </tr>
                   14197: <tr>
1.394     wiz      14198: <td>RUBY_RIDIR</td>
1.396   ! wiz      14199: <td>RUBY_SETUP</td>
1.378     leot     14200: </tr>
                   14201: <tr>
1.394     wiz      14202: <td>RUBY_SHLIB</td>
1.396   ! wiz      14203: <td>RUBY_SHLIBALIAS</td>
1.269     leot     14204: </tr>
                   14205: <tr>
1.394     wiz      14206: <td>RUBY_SHLIBVER</td>
1.396   ! wiz      14207: <td>RUBY_SIMPLE_INSTALL</td>
1.269     leot     14208: </tr>
                   14209: <tr>
1.394     wiz      14210: <td>RUBY_SITEARCHLIB</td>
1.396   ! wiz      14211: <td>RUBY_SITELIB</td>
1.269     leot     14212: </tr>
                   14213: <tr>
1.394     wiz      14214: <td>RUBY_SITELIB_BASE</td>
1.396   ! wiz      14215: <td>RUBY_SITERIDIR</td>
1.269     leot     14216: </tr>
                   14217: <tr>
1.394     wiz      14218: <td>RUBY_SLEXT</td>
1.396   ! wiz      14219: <td>RUBY_SRCDIR</td>
1.269     leot     14220: </tr>
                   14221: <tr>
1.394     wiz      14222: <td>RUBY_STATICLIB</td>
1.396   ! wiz      14223: <td>RUBY_SUFFIX</td>
1.269     leot     14224: </tr>
                   14225: <tr>
1.394     wiz      14226: <td>RUBY_SYSRIDIR</td>
1.396   ! wiz      14227: <td>RUBY_USE_PTHREAD</td>
1.269     leot     14228: </tr>
                   14229: <tr>
1.394     wiz      14230: <td>RUBY_VENDORARCHLIB</td>
1.396   ! wiz      14231: <td>RUBY_VENDORLIB</td>
1.312     gdt      14232: </tr>
                   14233: <tr>
1.394     wiz      14234: <td>RUBY_VENDORLIB_BASE</td>
1.396   ! wiz      14235: <td>RUBY_VER</td>
1.289     leot     14236: </tr>
                   14237: <tr>
1.394     wiz      14238: <td>RUBY_VERSION</td>
1.396   ! wiz      14239: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269     leot     14240: </tr>
                   14241: <tr>
1.394     wiz      14242: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.396   ! wiz      14243: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     14244: </tr>
                   14245: <tr>
1.394     wiz      14246: <td>RUBY_VERSION_REQD</td>
1.396   ! wiz      14247: <td>RUBY_VER_DIR</td>
1.269     leot     14248: </tr>
                   14249: <tr>
1.394     wiz      14250: <td>RUN</td>
1.396   ! wiz      14251: <td>RUN_LDCONFIG</td>
1.269     leot     14252: </tr>
                   14253: <tr>
1.394     wiz      14254: <td>RUST_TYPE</td>
1.396   ! wiz      14255: <td>SCO</td>
1.269     leot     14256: </tr>
                   14257: <tr>
1.394     wiz      14258: <td>SCREWS_GROUP</td>
1.396   ! wiz      14259: <td>SCREWS_USER</td>
1.269     leot     14260: </tr>
                   14261: <tr>
1.394     wiz      14262: <td>SCRIPTS_ENV</td>
1.396   ! wiz      14263: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     14264: </tr>
                   14265: <tr>
1.394     wiz      14266: <td>SCROLLKEEPER_REBUILDDB</td>
1.396   ! wiz      14267: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     14268: </tr>
                   14269: <tr>
1.394     wiz      14270: <td>SDIST_PAWD</td>
1.396   ! wiz      14271: <td>SDL12_TYPE</td>
1.269     leot     14272: </tr>
                   14273: <tr>
1.394     wiz      14274: <td>SERIAL_DEVICES</td>
1.396   ! wiz      14275: <td>SETGIDGAME</td>
1.269     leot     14276: </tr>
                   14277: <tr>
1.394     wiz      14278: <td>SETGID_GAMES_PERMS</td>
1.396   ! wiz      14279: <td>SETUID_ROOT_PERMS</td>
1.269     leot     14280: </tr>
                   14281: <tr>
1.394     wiz      14282: <td>SH</td>
1.396   ! wiz      14283: <td>SHAIRPORT_GROUP</td>
1.269     leot     14284: </tr>
                   14285: <tr>
1.394     wiz      14286: <td>SHAIRPORT_USER</td>
1.396   ! wiz      14287: <td>SHLIB_EXT</td>
1.269     leot     14288: </tr>
                   14289: <tr>
1.394     wiz      14290: <td>SHORTNAME</td>
1.396   ! wiz      14291: <td>SIGN_PACKAGES</td>
1.269     leot     14292: </tr>
                   14293: <tr>
1.394     wiz      14294: <td>SILC_CLIENT_WITH_PERL</td>
1.396   ! wiz      14295: <td>SITE_SPECIFIC_PKGS</td>
1.382     wiz      14296: </tr>
                   14297: <tr>
1.394     wiz      14298: <td>SKIP_DEPENDS</td>
1.396   ! wiz      14299: <td>SMF_INSTANCES</td>
1.376     wiz      14300: </tr>
                   14301: <tr>
1.394     wiz      14302: <td>SMF_MANIFEST</td>
1.396   ! wiz      14303: <td>SMF_METHODS</td>
1.348     wiz      14304: </tr>
                   14305: <tr>
1.394     wiz      14306: <td>SMF_METHOD_SHELL</td>
1.396   ! wiz      14307: <td>SMF_METHOD_SRC</td>
1.269     leot     14308: </tr>
                   14309: <tr>
1.394     wiz      14310: <td>SMF_NAME</td>
1.396   ! wiz      14311: <td>SMF_PREFIX</td>
1.342     wiz      14312: </tr>
                   14313: <tr>
1.394     wiz      14314: <td>SMF_SRCDIR</td>
1.396   ! wiz      14315: <td>SNIPROXY_GROUP</td>
1.269     leot     14316: </tr>
                   14317: <tr>
1.394     wiz      14318: <td>SNIPROXY_USER</td>
1.396   ! wiz      14319: <td>SOURCE_BUFFSIZE</td>
1.269     leot     14320: </tr>
                   14321: <tr>
1.394     wiz      14322: <td>SPECIAL_PERMS</td>
1.396   ! wiz      14323: <td>SPECIFIC_PKGS</td>
1.292     leot     14324: </tr>
                   14325: <tr>
1.394     wiz      14326: <td>SSH_SUID</td>
1.396   ! wiz      14327: <td>SSLCERTBUNDLE</td>
1.269     leot     14328: </tr>
                   14329: <tr>
1.394     wiz      14330: <td>SSLCERTS</td>
1.396   ! wiz      14331: <td>SSLDIR</td>
1.332     rillig   14332: </tr>
                   14333: <tr>
1.394     wiz      14334: <td>SSLKEYS</td>
1.396   ! wiz      14335: <td>SSP_SUPPORTED</td>
1.378     leot     14336: </tr>
                   14337: <tr>
1.394     wiz      14338: <td>SSYNC_PAWD</td>
1.396   ! wiz      14339: <td>STEP_MSG</td>
1.378     leot     14340: </tr>
                   14341: <tr>
1.394     wiz      14342: <td>STRIP</td>
1.396   ! wiz      14343: <td>STRIP_DBG</td>
1.269     leot     14344: </tr>
                   14345: <tr>
1.394     wiz      14346: <td>STRIP_DEBUG</td>
1.396   ! wiz      14347: <td>STRIP_DEBUG_SUPPORTED</td>
1.274     rillig   14348: </tr>
                   14349: <tr>
1.394     wiz      14350: <td>STRIP_FILES_SKIP</td>
1.396   ! wiz      14351: <td>SU</td>
1.269     leot     14352: </tr>
                   14353: <tr>
1.394     wiz      14354: <td>SUBDIR</td>
1.396   ! wiz      14355: <td>SUBST</td>
1.269     leot     14356: </tr>
                   14357: <tr>
1.394     wiz      14358: <td>SUBST_CLASSES</td>
1.396   ! wiz      14359: <td>SUBST_FILES</td>
1.269     leot     14360: </tr>
                   14361: <tr>
1.394     wiz      14362: <td>SUBST_FILTER_CMD</td>
1.396   ! wiz      14363: <td>SUBST_MESSAGE</td>
1.269     leot     14364: </tr>
                   14365: <tr>
1.394     wiz      14366: <td>SUBST_NOOP_OK</td>
1.396   ! wiz      14367: <td>SUBST_SED</td>
1.269     leot     14368: </tr>
                   14369: <tr>
1.394     wiz      14370: <td>SUBST_SHOW_DIFF</td>
1.396   ! wiz      14371: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269     leot     14372: </tr>
                   14373: <tr>
1.394     wiz      14374: <td>SUBST_STAGE</td>
1.396   ! wiz      14375: <td>SUBST_VARS</td>
1.269     leot     14376: </tr>
                   14377: <tr>
1.394     wiz      14378: <td>SUNWSPROBASE</td>
1.396   ! wiz      14379: <td>SUSE_PREFER</td>
1.269     leot     14380: </tr>
                   14381: <tr>
1.394     wiz      14382: <td>SU_CMD</td>
1.396   ! wiz      14383: <td>SVN_EXTRACTDIR</td>
1.382     wiz      14384: </tr>
                   14385: <tr>
1.394     wiz      14386: <td>SVN_REPO</td>
1.396   ! wiz      14387: <td>SVN_REPOSITORIES</td>
1.382     wiz      14388: </tr>
                   14389: <tr>
1.394     wiz      14390: <td>SVN_REVISION</td>
1.396   ! wiz      14391: <td>SYSCONFBASE</td>
1.360     leot     14392: </tr>
                   14393: <tr>
1.394     wiz      14394: <td>TARGET_MACHINE_ARCH</td>
1.396   ! wiz      14395: <td>TBL</td>
1.376     wiz      14396: </tr>
                   14397: <tr>
1.394     wiz      14398: <td>TERMCAP_TYPE</td>
1.396   ! wiz      14399: <td>TERMINFO_DEFAULT</td>
1.370     gdt      14400: </tr>
                   14401: <tr>
1.394     wiz      14402: <td>TERMINFO_TYPE</td>
1.396   ! wiz      14403: <td>TEST</td>
1.352     wiz      14404: </tr>
                   14405: <tr>
1.394     wiz      14406: <td>TEST_DEPENDS</td>
1.396   ! wiz      14407: <td>TEST_DIRS</td>
1.269     leot     14408: </tr>
                   14409: <tr>
1.394     wiz      14410: <td>TEST_ENV</td>
1.396   ! wiz      14411: <td>TEST_ENV_SHELL</td>
1.342     wiz      14412: </tr>
                   14413: <tr>
1.394     wiz      14414: <td>TEST_MAKE_CMD</td>
1.396   ! wiz      14415: <td>TEST_MAKE_FLAGS</td>
1.269     leot     14416: </tr>
                   14417: <tr>
1.394     wiz      14418: <td>TEST_TARGET</td>
1.396   ! wiz      14419: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.332     rillig   14420: </tr>
                   14421: <tr>
1.394     wiz      14422: <td>TEXLIVE_REV</td>
1.396   ! wiz      14423: <td>TEXLIVE_UNVERSIONED</td>
1.327     wiz      14424: </tr>
                   14425: <tr>
1.394     wiz      14426: <td>TEXMFSITE</td>
1.396   ! wiz      14427: <td>TEX_FORMATS</td>
1.332     rillig   14428: </tr>
                   14429: <tr>
1.394     wiz      14430: <td>TEX_HYPHEN_DAT</td>
1.396   ! wiz      14431: <td>TEX_HYPHEN_DEF</td>
1.320     wiz      14432: </tr>
                   14433: <tr>
1.394     wiz      14434: <td>TEX_TEXMF_DIRS</td>
1.396   ! wiz      14435: <td>THTTPD_LOG_FACILITY</td>
1.303     bacon    14436: </tr>
                   14437: <tr>
1.394     wiz      14438: <td>TINYDYN_USER</td>
1.396   ! wiz      14439: <td>TLS</td>
1.274     rillig   14440: </tr>
                   14441: <tr>
1.394     wiz      14442: <td>TLSWRAPPER_CHROOT</td>
1.396   ! wiz      14443: <td>TO</td>
1.269     leot     14444: </tr>
                   14445: <tr>
1.394     wiz      14446: <td>TOOLDIR</td>
1.396   ! wiz      14447: <td>TOOLS_ALIASES</td>
1.269     leot     14448: </tr>
                   14449: <tr>
1.394     wiz      14450: <td>TOOLS_ALWAYS_WRAP</td>
1.396   ! wiz      14451: <td>TOOLS_ARGS</td>
1.269     leot     14452: </tr>
                   14453: <tr>
1.394     wiz      14454: <td>TOOLS_BROKEN</td>
1.396   ! wiz      14455: <td>TOOLS_CMD</td>
1.269     leot     14456: </tr>
                   14457: <tr>
1.394     wiz      14458: <td>TOOLS_CMDLINE_SED</td>
1.396   ! wiz      14459: <td>TOOLS_CREATE</td>
1.269     leot     14460: </tr>
                   14461: <tr>
1.394     wiz      14462: <td>TOOLS_CROSS_DESTDIR</td>
1.396   ! wiz      14463: <td>TOOLS_DIR</td>
1.269     leot     14464: </tr>
                   14465: <tr>
1.394     wiz      14466: <td>TOOLS_FAIL</td>
1.396   ! wiz      14467: <td>TOOLS_GNU_MISSING</td>
1.269     leot     14468: </tr>
                   14469: <tr>
1.394     wiz      14470: <td>TOOLS_LDCONFIG</td>
1.396   ! wiz      14471: <td>TOOLS_NOOP</td>
1.269     leot     14472: </tr>
                   14473: <tr>
1.394     wiz      14474: <td>TOOLS_PATH</td>
1.396   ! wiz      14475: <td>TOOLS_SCRIPT</td>
1.269     leot     14476: </tr>
                   14477: <tr>
1.394     wiz      14478: <td>TOOLS_USE_CROSS_COMPILE</td>
1.396   ! wiz      14479: <td>TOOL_DEPENDS</td>
1.269     leot     14480: </tr>
                   14481: <tr>
1.394     wiz      14482: <td>TTF_FONTDIR</td>
1.396   ! wiz      14483: <td>TTF_FONTS_DIR</td>
1.369     wiz      14484: </tr>
                   14485: <tr>
1.394     wiz      14486: <td>TYPE</td>
1.396   ! wiz      14487: <td>UAC_REQD_EXECS</td>
1.378     leot     14488: </tr>
                   14489: <tr>
1.394     wiz      14490: <td>UCSPI_SSL_GROUP</td>
1.396   ! wiz      14491: <td>UCSPI_SSL_USER</td>
1.355     rillig   14492: </tr>
                   14493: <tr>
1.394     wiz      14494: <td>UDEV_REQUIRED</td>
1.396   ! wiz      14495: <td>UDEV_TYPE</td>
1.352     wiz      14496: </tr>
                   14497: <tr>
1.391     wiz      14498: <td>UNBOUND_GROUP</td>
1.396   ! wiz      14499: <td>UNBOUND_LOG_FACILITY</td>
1.379     wiz      14500: </tr>
                   14501: <tr>
1.391     wiz      14502: <td>UNBOUND_USER</td>
1.396   ! wiz      14503: <td>UNLIMIT_RESOURCES</td>
1.379     wiz      14504: </tr>
                   14505: <tr>
1.391     wiz      14506: <td>UNPRIVILEGED</td>
1.396   ! wiz      14507: <td>UNPRIVILEGED_GROUP</td>
1.269     leot     14508: </tr>
                   14509: <tr>
1.391     wiz      14510: <td>UNPRIVILEGED_GROUPS</td>
1.396   ! wiz      14511: <td>UNPRIVILEGED_USER</td>
1.338     nia      14512: </tr>
                   14513: <tr>
1.391     wiz      14514: <td>UNWRAP_FILES</td>
1.396   ! wiz      14515: <td>UNWRAP_PATTERNS</td>
1.269     leot     14516: </tr>
                   14517: <tr>
1.391     wiz      14518: <td>UPDATE_GEMSPEC</td>
1.396   ! wiz      14519: <td>UPDATE_TARGET</td>
1.327     wiz      14520: </tr>
                   14521: <tr>
1.391     wiz      14522: <td>URI</td>
1.396   ! wiz      14523: <td>USERGROUP_PHASE</td>
1.269     leot     14524: </tr>
                   14525: <tr>
1.391     wiz      14526: <td>USERPPP_GROUP</td>
1.396   ! wiz      14527: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     14528: </tr>
                   14529: <tr>
1.391     wiz      14530: <td>USE_ABI_DEPENDS</td>
1.396   ! wiz      14531: <td>USE_ADA_FEATURES</td>
1.269     leot     14532: </tr>
                   14533: <tr>
1.391     wiz      14534: <td>USE_APR</td>
1.396   ! wiz      14535: <td>USE_BSD_MAKEFILE</td>
1.269     leot     14536: </tr>
                   14537: <tr>
1.391     wiz      14538: <td>USE_BUILTIN</td>
1.396   ! wiz      14539: <td>USE_CC_FEATURES</td>
1.269     leot     14540: </tr>
                   14541: <tr>
1.391     wiz      14542: <td>USE_CROSS_COMPILE</td>
1.396   ! wiz      14543: <td>USE_CURSES</td>
1.357     gutterid 14544: </tr>
                   14545: <tr>
1.391     wiz      14546: <td>USE_CWRAPPERS</td>
1.396   ! wiz      14547: <td>USE_CXX_FEATURES</td>
1.269     leot     14548: </tr>
                   14549: <tr>
1.391     wiz      14550: <td>USE_DB185</td>
1.396   ! wiz      14551: <td>USE_FEATURES</td>
1.269     leot     14552: </tr>
                   14553: <tr>
1.391     wiz      14554: <td>USE_GAMESGROUP</td>
1.396   ! wiz      14555: <td>USE_GCC_RUNTIME</td>
1.269     leot     14556: </tr>
                   14557: <tr>
1.391     wiz      14558: <td>USE_IMAKE</td>
1.396   ! wiz      14559: <td>USE_INDIRECT_DEPENDS</td>
1.320     wiz      14560: </tr>
                   14561: <tr>
1.391     wiz      14562: <td>USE_JAVA</td>
1.396   ! wiz      14563: <td>USE_JAVA2</td>
1.269     leot     14564: </tr>
                   14565: <tr>
1.391     wiz      14566: <td>USE_LANGUAGES</td>
1.396   ! wiz      14567: <td>USE_LIBTOOL</td>
1.269     leot     14568: </tr>
                   14569: <tr>
1.391     wiz      14570: <td>USE_NATIVE_GCC</td>
1.396   ! wiz      14571: <td>USE_NETBSD_REPO</td>
1.269     leot     14572: </tr>
                   14573: <tr>
1.391     wiz      14574: <td>USE_PKGSRC_GCC</td>
1.396   ! wiz      14575: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     14576: </tr>
                   14577: <tr>
1.391     wiz      14578: <td>USE_PKGTASKS</td>
1.396   ! wiz      14579: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     14580: </tr>
                   14581: <tr>
1.391     wiz      14582: <td>USE_RUBY_EXTCONF</td>
1.396   ! wiz      14583: <td>USE_RUBY_INSTALL</td>
1.269     leot     14584: </tr>
                   14585: <tr>
1.391     wiz      14586: <td>USE_RUBY_SETUP</td>
1.396   ! wiz      14587: <td>USE_RUBY_SETUP_PKG</td>
1.376     wiz      14588: </tr>
                   14589: <tr>
1.391     wiz      14590: <td>USE_TMPFILES</td>
1.396   ! wiz      14591: <td>USE_TOOLS</td>
1.269     leot     14592: </tr>
                   14593: <tr>
1.391     wiz      14594: <td>UUCP_GROUP</td>
1.396   ! wiz      14595: <td>UUCP_USER</td>
1.269     leot     14596: </tr>
                   14597: <tr>
1.391     wiz      14598: <td>VARBASE</td>
1.396   ! wiz      14599: <td>VARNAME</td>
1.269     leot     14600: </tr>
                   14601: <tr>
1.391     wiz      14602: <td>VIM_EXTRA_OPTS</td>
1.396   ! wiz      14603: <td>WARNING_MSG</td>
1.269     leot     14604: </tr>
                   14605: <tr>
1.391     wiz      14606: <td>WCALC_CGIDIR</td>
1.396   ! wiz      14607: <td>WCALC_CGIPATH</td>
1.269     leot     14608: </tr>
                   14609: <tr>
1.391     wiz      14610: <td>WCALC_HTMLDIR</td>
1.396   ! wiz      14611: <td>WCALC_HTMLPATH</td>
1.269     leot     14612: </tr>
                   14613: <tr>
1.391     wiz      14614: <td>WDM_MANAGERS</td>
1.396   ! wiz      14615: <td>WRAPPER_CC</td>
1.269     leot     14616: </tr>
                   14617: <tr>
1.391     wiz      14618: <td>WRAPPER_REORDER_CMDS</td>
1.396   ! wiz      14619: <td>WRKDIR</td>
1.269     leot     14620: </tr>
                   14621: <tr>
1.391     wiz      14622: <td>WRKDIR_BASENAME</td>
1.396   ! wiz      14623: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     14624: </tr>
                   14625: <tr>
1.391     wiz      14626: <td>WRKLOG</td>
1.396   ! wiz      14627: <td>WRKOBJDIR</td>
1.269     leot     14628: </tr>
                   14629: <tr>
1.391     wiz      14630: <td>WRKSRC</td>
1.396   ! wiz      14631: <td>X10_PORT</td>
1.269     leot     14632: </tr>
                   14633: <tr>
1.391     wiz      14634: <td>X11</td>
1.396   ! wiz      14635: <td>X11BASE</td>
1.269     leot     14636: </tr>
                   14637: <tr>
1.391     wiz      14638: <td>X11_PKGSRCDIR</td>
1.396   ! wiz      14639: <td>X11_TYPE</td>
1.269     leot     14640: </tr>
                   14641: <tr>
1.391     wiz      14642: <td>X509_CERTIFICATE</td>
1.396   ! wiz      14643: <td>X509_KEY</td>
1.303     bacon    14644: </tr>
                   14645: <tr>
1.391     wiz      14646: <td>XAW_TYPE</td>
1.396   ! wiz      14647: <td>XLOCK_DEFAULT_MODE</td>
1.269     leot     14648: </tr>
                   14649: <tr>
1.391     wiz      14650: <td>XMKMF</td>
1.396   ! wiz      14651: <td>XMKMF_FLAGS</td>
1.382     wiz      14652: </tr>
                   14653: <tr>
1.391     wiz      14654: <td>XXX</td>
1.396   ! wiz      14655: <td>XXXX</td>
1.269     leot     14656: </tr>
                   14657: <tr>
1.391     wiz      14658: <td>YES</td>
1.396   ! wiz      14659: <td>ZSH_STATIC</td>
1.367     gdt      14660: </tr>
                   14661: <tr>
1.391     wiz      14662: <td>__stdc__</td>
1.396   ! wiz      14663: <td>_vargroups</td>
1.360     leot     14664: </tr>
                   14665: <tr>
1.391     wiz      14666: <td>accept</td>
1.396   ! wiz      14667: <td>acquire-localbase-lock</td>
1.348     wiz      14668: </tr>
                   14669: <tr>
1.391     wiz      14670: <td>acquire-lock</td>
1.396   ! wiz      14671: <td>add</td>
1.394     wiz      14672: </tr>
                   14673: <tr>
                   14674: <td>added</td>
1.396   ! wiz      14675: <td>administrator</td>
1.269     leot     14676: </tr>
                   14677: <tr>
1.394     wiz      14678: <td>alloca</td>
1.396   ! wiz      14679: <td>alternatives</td>
1.342     wiz      14680: </tr>
                   14681: <tr>
1.394     wiz      14682: <td>aslr</td>
1.396   ! wiz      14683: <td>asprintf</td>
1.269     leot     14684: </tr>
                   14685: <tr>
1.394     wiz      14686: <td>atlas</td>
1.396   ! wiz      14687: <td>autoconf</td>
1.274     rillig   14688: </tr>
                   14689: <tr>
1.394     wiz      14690: <td>automake</td>
1.396   ! wiz      14691: <td>autoreconf</td>
1.332     rillig   14692: </tr>
                   14693: <tr>
1.394     wiz      14694: <td>awk</td>
1.396   ! wiz      14695: <td>barrier</td>
1.384     leot     14696: </tr>
                   14697: <tr>
1.394     wiz      14698: <td>bash</td>
1.396   ! wiz      14699: <td>big-endian</td>
1.269     leot     14700: </tr>
                   14701: <tr>
1.394     wiz      14702: <td>bin-install</td>
1.396   ! wiz      14703: <td>bind</td>
1.316     cirnatda 14704: </tr>
                   14705: <tr>
1.394     wiz      14706: <td>binpkg-list</td>
1.396   ! wiz      14707: <td>blas</td>
1.289     leot     14708: </tr>
                   14709: <tr>
1.394     wiz      14710: <td>bootstrap-depends</td>
1.396   ! wiz      14711: <td>broken</td>
1.269     leot     14712: </tr>
                   14713: <tr>
1.394     wiz      14714: <td>broken_on_platform</td>
1.396   ! wiz      14715: <td>bsd</td>
1.269     leot     14716: </tr>
                   14717: <tr>
1.394     wiz      14718: <td>bsd.prog.mk</td>
1.396   ! wiz      14719: <td>build</td>
1.289     leot     14720: </tr>
                   14721: <tr>
1.394     wiz      14722: <td>build-env</td>
1.396   ! wiz      14723: <td>buildlink-directories</td>
1.269     leot     14724: </tr>
                   14725: <tr>
1.394     wiz      14726: <td>buildlink-oss-soundcard-h</td>
1.396   ! wiz      14727: <td>built-in</td>
1.269     leot     14728: </tr>
                   14729: <tr>
1.394     wiz      14730: <td>builtin</td>
1.396   ! wiz      14731: <td>c</td>
1.269     leot     14732: </tr>
                   14733: <tr>
1.394     wiz      14734: <td>c++</td>
1.396   ! wiz      14735: <td>ccache</td>
1.271     brook    14736: </tr>
                   14737: <tr>
1.394     wiz      14738: <td>cce</td>
1.396   ! wiz      14739: <td>cdefs</td>
1.269     leot     14740: </tr>
                   14741: <tr>
1.394     wiz      14742: <td>ceil</td>
1.396   ! wiz      14743: <td>changes</td>
1.356     gutterid 14744: </tr>
                   14745: <tr>
1.394     wiz      14746: <td>changes-entry</td>
1.396   ! wiz      14747: <td>changes-entry-noupdate</td>
1.292     leot     14748: </tr>
                   14749: <tr>
1.394     wiz      14750: <td>check</td>
1.396   ! wiz      14751: <td>check-clean</td>
1.274     rillig   14752: </tr>
                   14753: <tr>
1.394     wiz      14754: <td>check-files</td>
1.396   ! wiz      14755: <td>check-files-clean</td>
1.269     leot     14756: </tr>
                   14757: <tr>
1.394     wiz      14758: <td>check-hackage</td>
1.396   ! wiz      14759: <td>check-vulnerable</td>
1.289     leot     14760: </tr>
                   14761: <tr>
1.394     wiz      14762: <td>checksum</td>
1.396   ! wiz      14763: <td>checksum-phase</td>
1.269     leot     14764: </tr>
                   14765: <tr>
1.394     wiz      14766: <td>clean</td>
1.396   ! wiz      14767: <td>clean-depends</td>
1.370     gdt      14768: </tr>
                   14769: <tr>
1.394     wiz      14770: <td>cleandir</td>
1.396   ! wiz      14771: <td>codeberg</td>
1.269     leot     14772: </tr>
                   14773: <tr>
1.385     leot     14774: <td>commit</td>
1.394     wiz      14775: <td>commit-changes-entry</td>
1.269     leot     14776: </tr>
                   14777: <tr>
1.385     leot     14778: <td>compact</td>
1.394     wiz      14779: <td>compiler</td>
1.269     leot     14780: </tr>
                   14781: <tr>
1.385     leot     14782: <td>conf</td>
1.394     wiz      14783: <td>config.guess</td>
1.289     leot     14784: </tr>
                   14785: <tr>
1.385     leot     14786: <td>config.sub</td>
1.394     wiz      14787: <td>configuration</td>
1.269     leot     14788: </tr>
                   14789: <tr>
1.385     leot     14790: <td>configure</td>
1.394     wiz      14791: <td>configure-env</td>
1.269     leot     14792: </tr>
                   14793: <tr>
1.385     leot     14794: <td>configure-help</td>
1.394     wiz      14795: <td>configure_args</td>
1.269     leot     14796: </tr>
                   14797: <tr>
1.385     leot     14798: <td>connect</td>
1.394     wiz      14799: <td>cos</td>
1.269     leot     14800: </tr>
                   14801: <tr>
1.385     leot     14802: <td>cpe</td>
1.394     wiz      14803: <td>cputime</td>
1.269     leot     14804: </tr>
                   14805: <tr>
1.385     leot     14806: <td>create-usergroup</td>
1.394     wiz      14807: <td>csh</td>
1.269     leot     14808: </tr>
                   14809: <tr>
1.385     leot     14810: <td>ctf</td>
1.394     wiz      14811: <td>cvs</td>
1.269     leot     14812: </tr>
                   14813: <tr>
1.385     leot     14814: <td>debug</td>
1.394     wiz      14815: <td>debug-barrier</td>
1.378     leot     14816: </tr>
                   14817: <tr>
1.385     leot     14818: <td>declaration</td>
1.394     wiz      14819: <td>declare</td>
1.376     wiz      14820: </tr>
                   14821: <tr>
1.385     leot     14822: <td>defined</td>
1.394     wiz      14823: <td>depend</td>
1.355     rillig   14824: </tr>
                   14825: <tr>
1.385     leot     14826: <td>dependencies</td>
1.394     wiz      14827: <td>depends</td>
1.352     wiz      14828: </tr>
                   14829: <tr>
1.385     leot     14830: <td>depends-checksum</td>
1.394     wiz      14831: <td>depends-fetch</td>
1.338     nia      14832: </tr>
                   14833: <tr>
1.379     wiz      14834: <td>describe</td>
1.394     wiz      14835: <td>destdir</td>
1.289     leot     14836: </tr>
                   14837: <tr>
1.379     wiz      14838: <td>disable</td>
1.394     wiz      14839: <td>distclean</td>
1.329     leot     14840: </tr>
                   14841: <tr>
1.379     wiz      14842: <td>distfiles</td>
1.394     wiz      14843: <td>distinfo</td>
1.320     wiz      14844: </tr>
                   14845: <tr>
1.378     leot     14846: <td>dl</td>
1.394     wiz      14847: <td>dlopen</td>
1.269     leot     14848: </tr>
                   14849: <tr>
1.378     leot     14850: <td>do-buildlink</td>
1.394     wiz      14851: <td>do-clean</td>
1.311     leot     14852: </tr>
                   14853: <tr>
1.378     leot     14854: <td>do-configure</td>
1.394     wiz      14855: <td>do-configure-post-hook</td>
1.269     leot     14856: </tr>
                   14857: <tr>
1.378     leot     14858: <td>do-extract</td>
1.394     wiz      14859: <td>do-fetch</td>
1.269     leot     14860: </tr>
                   14861: <tr>
1.382     wiz      14862: <td>do-install</td>
1.394     wiz      14863: <td>download</td>
1.382     wiz      14864: </tr>
                   14865: <tr>
1.377     jnemeth  14866: <td>emul</td>
1.394     wiz      14867: <td>emul-distinfo</td>
1.269     leot     14868: </tr>
                   14869: <tr>
1.377     jnemeth  14870: <td>emul-fetch</td>
1.394     wiz      14871: <td>emulation</td>
1.269     leot     14872: </tr>
                   14873: <tr>
1.377     jnemeth  14874: <td>emulator</td>
1.394     wiz      14875: <td>enable</td>
1.277     rillig   14876: </tr>
                   14877: <tr>
1.352     wiz      14878: <td>endian</td>
1.394     wiz      14879: <td>endif</td>
1.376     wiz      14880: </tr>
                   14881: <tr>
1.365     gutterid 14882: <td>enomem</td>
1.394     wiz      14883: <td>ensurepip</td>
1.378     leot     14884: </tr>
                   14885: <tr>
                   14886: <td>err</td>
1.394     wiz      14887: <td>errx</td>
1.367     gdt      14888: </tr>
                   14889: <tr>
1.378     leot     14890: <td>etc</td>
1.394     wiz      14891: <td>exp</td>
1.348     wiz      14892: </tr>
                   14893: <tr>
1.378     leot     14894: <td>extract-rpm</td>
1.394     wiz      14895: <td>fabs</td>
1.269     leot     14896: </tr>
                   14897: <tr>
1.378     leot     14898: <td>feature</td>
1.394     wiz      14899: <td>features</td>
1.342     wiz      14900: </tr>
                   14901: <tr>
1.378     leot     14902: <td>fetch</td>
1.394     wiz      14903: <td>fetch-list</td>
1.329     leot     14904: </tr>
                   14905: <tr>
1.378     leot     14906: <td>follows</td>
1.394     wiz      14907: <td>forbids</td>
1.269     leot     14908: </tr>
                   14909: <tr>
1.378     leot     14910: <td>form</td>
1.394     wiz      14911: <td>format</td>
1.320     wiz      14912: </tr>
                   14913: <tr>
1.378     leot     14914: <td>fortify</td>
1.394     wiz      14915: <td>fortify_source</td>
1.352     wiz      14916: </tr>
                   14917: <tr>
1.382     wiz      14918: <td>fossil</td>
1.394     wiz      14919: <td>friend</td>
1.382     wiz      14920: </tr>
                   14921: <tr>
1.377     jnemeth  14922: <td>fts</td>
1.394     wiz      14923: <td>fts_close</td>
1.369     wiz      14924: </tr>
                   14925: <tr>
1.377     jnemeth  14926: <td>fts_open</td>
1.394     wiz      14927: <td>fts_read</td>
1.355     rillig   14928: </tr>
                   14929: <tr>
1.377     jnemeth  14930: <td>fts_set</td>
1.394     wiz      14931: <td>gcc</td>
1.332     rillig   14932: </tr>
                   14933: <tr>
1.377     jnemeth  14934: <td>gethostbyaddr</td>
1.394     wiz      14935: <td>gethostbyname</td>
1.338     nia      14936: </tr>
                   14937: <tr>
1.377     jnemeth  14938: <td>gethostbyname2</td>
1.394     wiz      14939: <td>getopt_long</td>
1.269     leot     14940: </tr>
                   14941: <tr>
1.377     jnemeth  14942: <td>getprogname</td>
1.394     wiz      14943: <td>getservbyname</td>
1.269     leot     14944: </tr>
                   14945: <tr>
1.377     jnemeth  14946: <td>getservbyport</td>
1.394     wiz      14947: <td>getservent</td>
1.269     leot     14948: </tr>
                   14949: <tr>
1.352     wiz      14950: <td>gettext</td>
1.394     wiz      14951: <td>git</td>
1.376     wiz      14952: </tr>
                   14953: <tr>
1.365     gutterid 14954: <td>github</td>
1.394     wiz      14955: <td>gitlab</td>
1.378     leot     14956: </tr>
                   14957: <tr>
                   14958: <td>glob</td>
1.394     wiz      14959: <td>gnu</td>
1.367     gdt      14960: </tr>
                   14961: <tr>
1.378     leot     14962: <td>gnu_configure_strict</td>
1.394     wiz      14963: <td>go</td>
1.348     wiz      14964: </tr>
                   14965: <tr>
1.381     dholland 14966: <td>golang</td>
1.394     wiz      14967: <td>guess-license</td>
1.289     leot     14968: </tr>
                   14969: <tr>
1.381     dholland 14970: <td>hashbang</td>
1.394     wiz      14971: <td>heimdal</td>
1.342     wiz      14972: </tr>
                   14973: <tr>
1.376     wiz      14974: <td>help</td>
1.394     wiz      14975: <td>hg</td>
1.352     wiz      14976: </tr>
                   14977: <tr>
1.375     jkoshy   14978: <td>imake</td>
1.394     wiz      14979: <td>in-tree</td>
1.382     wiz      14980: </tr>
                   14981: <tr>
                   14982: <td>increment</td>
1.394     wiz      14983: <td>indirect</td>
1.369     wiz      14984: </tr>
                   14985: <tr>
1.382     wiz      14986: <td>inet_aton</td>
1.394     wiz      14987: <td>install</td>
1.355     rillig   14988: </tr>
                   14989: <tr>
1.382     wiz      14990: <td>install-env</td>
1.394     wiz      14991: <td>interp</td>
1.379     wiz      14992: </tr>
                   14993: <tr>
1.382     wiz      14994: <td>interpreter</td>
1.394     wiz      14995: <td>intl</td>
1.269     leot     14996: </tr>
                   14997: <tr>
1.382     wiz      14998: <td>ip4</td>
1.394     wiz      14999: <td>ip6</td>
1.329     leot     15000: </tr>
                   15001: <tr>
1.382     wiz      15002: <td>ipv4</td>
1.394     wiz      15003: <td>ipv6</td>
1.269     leot     15004: </tr>
                   15005: <tr>
1.382     wiz      15006: <td>iso</td>
1.396   ! wiz      15007: <td>jobs</td>
1.320     wiz      15008: </tr>
                   15009: <tr>
1.396   ! wiz      15010: <td>kerberos</td>
1.382     wiz      15011: <td>krb</td>
1.311     leot     15012: </tr>
                   15013: <tr>
1.396   ! wiz      15014: <td>krb5</td>
1.382     wiz      15015: <td>ksh</td>
1.269     leot     15016: </tr>
                   15017: <tr>
1.396   ! wiz      15018: <td>lapack</td>
1.382     wiz      15019: <td>latex</td>
1.269     leot     15020: </tr>
                   15021: <tr>
1.396   ! wiz      15022: <td>libiconv</td>
1.382     wiz      15023: <td>libintl_bindtextdomain</td>
1.269     leot     15024: </tr>
                   15025: <tr>
1.396   ! wiz      15026: <td>libintl_gettext</td>
1.382     wiz      15027: <td>libintl_textdomain</td>
1.269     leot     15028: </tr>
                   15029: <tr>
1.396   ! wiz      15030: <td>libnbcompat</td>
1.382     wiz      15031: <td>libs</td>
1.303     bacon    15032: </tr>
                   15033: <tr>
1.396   ! wiz      15034: <td>libtool</td>
1.382     wiz      15035: <td>licence</td>
1.303     bacon    15036: </tr>
                   15037: <tr>
1.396   ! wiz      15038: <td>license</td>
1.382     wiz      15039: <td>lintl</td>
1.269     leot     15040: </tr>
                   15041: <tr>
1.396   ! wiz      15042: <td>little-endian</td>
1.382     wiz      15043: <td>lock</td>
1.292     leot     15044: </tr>
                   15045: <tr>
1.396   ! wiz      15046: <td>locking</td>
1.382     wiz      15047: <td>lua</td>
1.269     leot     15048: </tr>
                   15049: <tr>
1.396   ! wiz      15050: <td>lvalue</td>
1.382     wiz      15051: <td>machine_endian</td>
1.289     leot     15052: </tr>
                   15053: <tr>
1.396   ! wiz      15054: <td>make</td>
1.382     wiz      15055: <td>makedistinfo</td>
1.274     rillig   15056: </tr>
                   15057: <tr>
1.396   ! wiz      15058: <td>makepatchsum</td>
1.382     wiz      15059: <td>makesum</td>
1.377     jnemeth  15060: </tr>
                   15061: <tr>
1.396   ! wiz      15062: <td>mdi</td>
1.382     wiz      15063: <td>memory</td>
1.360     leot     15064: </tr>
                   15065: <tr>
1.396   ! wiz      15066: <td>mercurial</td>
1.381     dholland 15067: <td>meta</td>
1.378     leot     15068: </tr>
                   15069: <tr>
1.396   ! wiz      15070: <td>meta-package</td>
1.381     dholland 15071: <td>meta_package</td>
1.376     wiz      15072: </tr>
                   15073: <tr>
1.396   ! wiz      15074: <td>mit-krb5</td>
1.381     dholland 15075: <td>mk.conf</td>
1.367     gdt      15076: </tr>
                   15077: <tr>
1.396   ! wiz      15078: <td>mkl</td>
1.381     dholland 15079: <td>mount</td>
1.271     brook    15080: </tr>
                   15081: <tr>
1.396   ! wiz      15082: <td>move</td>
1.381     dholland 15083: <td>moved</td>
1.348     wiz      15084: </tr>
                   15085: <tr>
1.396   ! wiz      15086: <td>mprotect</td>
1.381     dholland 15087: <td>mps</td>
1.342     wiz      15088: </tr>
                   15089: <tr>
1.396   ! wiz      15090: <td>mremap</td>
1.381     dholland 15091: <td>native</td>
1.269     leot     15092: </tr>
                   15093: <tr>
1.396   ! wiz      15094: <td>nb</td>
1.381     dholland 15095: <td>nbcompat</td>
1.269     leot     15096: </tr>
                   15097: <tr>
1.396   ! wiz      15098: <td>netlib</td>
1.381     dholland 15099: <td>network</td>
1.292     leot     15100: </tr>
                   15101: <tr>
1.396   ! wiz      15102: <td>node</td>
1.381     dholland 15103: <td>node.js</td>
1.370     gdt      15104: </tr>
                   15105: <tr>
1.396   ! wiz      15106: <td>nodejs</td>
1.381     dholland 15107: <td>obstack</td>
1.274     rillig   15108: </tr>
                   15109: <tr>
1.396   ! wiz      15110: <td>obstack_ptr_grow</td>
1.381     dholland 15111: <td>occurs</td>
1.341     gutterid 15112: </tr>
                   15113: <tr>
1.396   ! wiz      15114: <td>only</td>
1.381     dholland 15115: <td>openblas</td>
1.269     leot     15116: </tr>
                   15117: <tr>
1.396   ! wiz      15118: <td>options</td>
1.381     dholland 15119: <td>options.mk</td>
1.269     leot     15120: </tr>
                   15121: <tr>
1.396   ! wiz      15122: <td>order</td>
1.381     dholland 15123: <td>override</td>
1.333     nia      15124: </tr>
                   15125: <tr>
1.396   ! wiz      15126: <td>override-intltool</td>
1.381     dholland 15127: <td>override-message-intltool</td>
1.333     nia      15128: </tr>
                   15129: <tr>
1.396   ! wiz      15130: <td>package</td>
1.381     dholland 15131: <td>parallel</td>
1.320     wiz      15132: </tr>
                   15133: <tr>
1.396   ! wiz      15134: <td>path</td>
1.381     dholland 15135: <td>pax</td>
1.269     leot     15136: </tr>
                   15137: <tr>
1.396   ! wiz      15138: <td>paxctl</td>
1.381     dholland 15139: <td>pbulk-index</td>
1.269     leot     15140: </tr>
                   15141: <tr>
1.396   ! wiz      15142: <td>pc</td>
1.381     dholland 15143: <td>perl</td>
1.269     leot     15144: </tr>
                   15145: <tr>
1.396   ! wiz      15146: <td>perl5</td>
1.381     dholland 15147: <td>perms</td>
1.271     brook    15148: </tr>
                   15149: <tr>
1.396   ! wiz      15150: <td>php</td>
1.381     dholland 15151: <td>pkg-build-options</td>
1.269     leot     15152: </tr>
                   15153: <tr>
1.396   ! wiz      15154: <td>pkg-config</td>
1.381     dholland 15155: <td>pkg_build_options</td>
1.269     leot     15156: </tr>
                   15157: <tr>
1.396   ! wiz      15158: <td>pkgsrc</td>
1.381     dholland 15159: <td>platform</td>
1.269     leot     15160: </tr>
                   15161: <tr>
1.396   ! wiz      15162: <td>plist</td>
1.381     dholland 15163: <td>post-extract</td>
1.269     leot     15164: </tr>
                   15165: <tr>
1.396   ! wiz      15166: <td>post-fetch</td>
1.381     dholland 15167: <td>post-wrapper</td>
1.269     leot     15168: </tr>
                   15169: <tr>
1.396   ! wiz      15170: <td>pre-build-checks-hook</td>
1.381     dholland 15171: <td>pre-configure-checks-hook</td>
1.269     leot     15172: </tr>
                   15173: <tr>
1.396   ! wiz      15174: <td>pre-extract</td>
1.381     dholland 15175: <td>pre-fetch</td>
1.269     leot     15176: </tr>
                   15177: <tr>
1.396   ! wiz      15178: <td>print-plist</td>
1.376     wiz      15179: <td>print-summary-data</td>
1.269     leot     15180: </tr>
                   15181: <tr>
1.396   ! wiz      15182: <td>privileged-install-hook</td>
1.376     wiz      15183: <td>pypi</td>
1.269     leot     15184: </tr>
                   15185: <tr>
1.396   ! wiz      15186: <td>python</td>
1.376     wiz      15187: <td>r</td>
1.269     leot     15188: </tr>
                   15189: <tr>
1.396   ! wiz      15190: <td>readme-all</td>
1.376     wiz      15191: <td>recursive</td>
1.289     leot     15192: </tr>
                   15193: <tr>
1.396   ! wiz      15194: <td>recv</td>
1.376     wiz      15195: <td>recvfrom</td>
1.269     leot     15196: </tr>
                   15197: <tr>
1.396   ! wiz      15198: <td>regcomp</td>
1.376     wiz      15199: <td>release-localbase-lock</td>
1.269     leot     15200: </tr>
                   15201: <tr>
1.396   ! wiz      15202: <td>release-lock</td>
1.376     wiz      15203: <td>relro</td>
1.269     leot     15204: </tr>
                   15205: <tr>
1.396   ! wiz      15206: <td>remove</td>
1.376     wiz      15207: <td>removed</td>
1.269     leot     15208: </tr>
                   15209: <tr>
1.396   ! wiz      15210: <td>rename</td>
1.376     wiz      15211: <td>renamed</td>
1.269     leot     15212: </tr>
                   15213: <tr>
1.396   ! wiz      15214: <td>reorder</td>
1.376     wiz      15215: <td>replace</td>
1.289     leot     15216: </tr>
                   15217: <tr>
1.396   ! wiz      15218: <td>replace_interpreter</td>
1.376     wiz      15219: <td>reproducible</td>
1.289     leot     15220: </tr>
                   15221: <tr>
1.396   ! wiz      15222: <td>resolv</td>
1.376     wiz      15223: <td>root</td>
1.269     leot     15224: </tr>
                   15225: <tr>
1.396   ! wiz      15226: <td>ruby</td>
1.376     wiz      15227: <td>send</td>
1.341     gutterid 15228: </tr>
                   15229: <tr>
1.396   ! wiz      15230: <td>sendfile</td>
1.376     wiz      15231: <td>sendto</td>
1.341     gutterid 15232: </tr>
                   15233: <tr>
1.396   ! wiz      15234: <td>setenv</td>
1.376     wiz      15235: <td>setgid</td>
1.269     leot     15236: </tr>
                   15237: <tr>
1.396   ! wiz      15238: <td>setprogname</td>
1.376     wiz      15239: <td>setuid</td>
1.269     leot     15240: </tr>
                   15241: <tr>
1.396   ! wiz      15242: <td>sh</td>
1.376     wiz      15243: <td>shebang</td>
1.269     leot     15244: </tr>
                   15245: <tr>
1.396   ! wiz      15246: <td>show</td>
1.376     wiz      15247: <td>show-all</td>
1.289     leot     15248: </tr>
                   15249: <tr>
1.396   ! wiz      15250: <td>show-build-defs</td>
1.376     wiz      15251: <td>show-depends</td>
1.269     leot     15252: </tr>
                   15253: <tr>
1.396   ! wiz      15254: <td>show-depends-dirs</td>
1.376     wiz      15255: <td>show-depends-pkgpaths</td>
1.269     leot     15256: </tr>
                   15257: <tr>
1.396   ! wiz      15258: <td>show-depends-recursive</td>
1.376     wiz      15259: <td>show-deps</td>
1.269     leot     15260: </tr>
                   15261: <tr>
1.396   ! wiz      15262: <td>show-distfiles</td>
1.376     wiz      15263: <td>show-downlevel</td>
1.269     leot     15264: </tr>
                   15265: <tr>
1.396   ! wiz      15266: <td>show-subdir-var</td>
1.376     wiz      15267: <td>show-tools</td>
1.296     rillig   15268: </tr>
                   15269: <tr>
1.396   ! wiz      15270: <td>show-var</td>
1.376     wiz      15271: <td>show-vars</td>
1.269     leot     15272: </tr>
                   15273: <tr>
1.396   ! wiz      15274: <td>snprintf</td>
1.376     wiz      15275: <td>socket</td>
1.337     gutterid 15276: </tr>
                   15277: <tr>
1.396   ! wiz      15278: <td>ssp</td>
1.376     wiz      15279: <td>st_mode</td>
1.338     nia      15280: </tr>
                   15281: <tr>
1.396   ! wiz      15282: <td>stage-install</td>
1.376     wiz      15283: <td>strcasestr</td>
1.269     leot     15284: </tr>
                   15285: <tr>
1.396   ! wiz      15286: <td>strict</td>
1.376     wiz      15287: <td>strip</td>
1.269     leot     15288: </tr>
                   15289: <tr>
1.396   ! wiz      15290: <td>strndup</td>
1.376     wiz      15291: <td>strnlen</td>
1.269     leot     15292: </tr>
                   15293: <tr>
1.396   ! wiz      15294: <td>strsep</td>
1.376     wiz      15295: <td>subst</td>
1.369     wiz      15296: </tr>
                   15297: <tr>
1.396   ! wiz      15298: <td>substitutions</td>
1.382     wiz      15299: <td>subversion</td>
                   15300: </tr>
                   15301: <tr>
1.396   ! wiz      15302: <td>sun</td>
1.369     wiz      15303: <td>sunpro</td>
1.329     leot     15304: </tr>
                   15305: <tr>
1.396   ! wiz      15306: <td>sunwspro</td>
1.382     wiz      15307: <td>svn</td>
1.378     leot     15308: </tr>
                   15309: <tr>
1.396   ! wiz      15310: <td>symlink</td>
1.368     gutterid 15311: <td>test</td>
1.367     gdt      15312: </tr>
                   15313: <tr>
1.396   ! wiz      15314: <td>test-env</td>
1.368     gutterid 15315: <td>tex</td>
1.327     wiz      15316: </tr>
                   15317: <tr>
1.396   ! wiz      15318: <td>texlive</td>
1.368     gutterid 15319: <td>tmp</td>
1.342     wiz      15320: </tr>
                   15321: <tr>
1.396   ! wiz      15322: <td>todo</td>
1.368     gutterid 15323: <td>tool</td>
1.338     nia      15324: </tr>
                   15325: <tr>
1.396   ! wiz      15326: <td>tools</td>
1.368     gutterid 15327: <td>tools-libtool-m4-override</td>
1.269     leot     15328: </tr>
                   15329: <tr>
1.396   ! wiz      15330: <td>transitive</td>
1.368     gutterid 15331: <td>type</td>
1.269     leot     15332: </tr>
                   15333: <tr>
1.396   ! wiz      15334: <td>ulimit</td>
1.368     gutterid 15335: <td>undefined</td>
1.269     leot     15336: </tr>
                   15337: <tr>
1.396   ! wiz      15338: <td>undo-replace</td>
1.368     gutterid 15339: <td>unlimit</td>
1.269     leot     15340: </tr>
                   15341: <tr>
1.396   ! wiz      15342: <td>unprivileged</td>
1.368     gutterid 15343: <td>unprivileged-install-hook</td>
1.269     leot     15344: </tr>
                   15345: <tr>
1.396   ! wiz      15346: <td>unstripped</td>
1.368     gutterid 15347: <td>update</td>
1.269     leot     15348: </tr>
                   15349: <tr>
1.396   ! wiz      15350: <td>updated</td>
1.368     gutterid 15351: <td>upload</td>
1.269     leot     15352: </tr>
                   15353: <tr>
1.396   ! wiz      15354: <td>upload-distfiles</td>
1.368     gutterid 15355: <td>use_tools</td>
1.269     leot     15356: </tr>
                   15357: <tr>
1.396   ! wiz      15358: <td>user</td>
1.368     gutterid 15359: <td>utimes</td>
1.269     leot     15360: </tr>
                   15361: <tr>
1.396   ! wiz      15362: <td>vasprintf</td>
1.368     gutterid 15363: <td>verbose</td>
1.269     leot     15364: </tr>
                   15365: <tr>
1.396   ! wiz      15366: <td>vsnprintf</td>
1.368     gutterid 15367: <td>warn</td>
1.269     leot     15368: </tr>
                   15369: <tr>
1.396   ! wiz      15370: <td>warning</td>
1.368     gutterid 15371: <td>warnings</td>
1.269     leot     15372: </tr>
                   15373: <tr>
1.396   ! wiz      15374: <td>warnx</td>
1.368     gutterid 15375: <td>wattr_off</td>
1.269     leot     15376: </tr>
                   15377: <tr>
1.396   ! wiz      15378: <td>wattr_on</td>
1.368     gutterid 15379: <td>work</td>
1.269     leot     15380: </tr>
                   15381: <tr>
1.396   ! wiz      15382: <td>wrapper</td>
1.289     leot     15383: <td>wrkdir</td>
1.269     leot     15384: </tr>
                   15385: </table>
1.267     rillig   15386: </div>
                   15387: <div class="appendix">
                   15388: <div class="titlepage"><div><div><h1 class="title">
1.385     leot     15389: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   15390: <div class="toc">
                   15391: <p><b>Table of Contents</b></p>
1.210     leot     15392: <dl class="toc">
1.322     leot     15393: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
                   15394: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75      rillig   15395: </dl>
                   15396: </div>
1.79      rillig   15397: <p>This section contains information on editing the pkgsrc
                   15398:        guide itself.</p>
1.148     asau     15399: <div class="sect1">
1.75      rillig   15400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     15401: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79      rillig   15402: <p>The pkgsrc guide's source code is stored in
                   15403:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   15404:        are created from it:</p>
1.148     asau     15405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      15406: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   15407: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     15408: <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>
                   15409: <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   15410:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     15411: <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   15412:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   15413: </ul></div>
                   15414: </div>
1.148     asau     15415: <div class="sect1">
1.75      rillig   15416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.385     leot     15417: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79      rillig   15418: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      15419: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    15420: <li class="step"><p>Make sure you have checked out the htdocs repository
                   15421:        into a sibling directory of your pkgsrc directory.  You will need
                   15422:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     15423: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      15424:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   15425:        documentation) installed. These are automatically installed when
1.322     leot     15426:        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     15427: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   15428:        right directory. All further steps will take place
                   15429:        here.</p></li>
1.148     asau     15430: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   15431:        <code class="filename">files/</code>.</p></li>
1.148     asau     15432: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   15433:        guide for valid XML and to build the final output files. If you
                   15434:        get any errors at this stage, you can just edit the files, as
                   15435:        there are only symbolic links in the working directory, pointing
                   15436:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     15437: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   15438:        commit)</strong></span></p></li>
1.148     asau     15439: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   15440:        regenerate the output files with the proper RCS
                   15441:        Ids.</p></li>
1.148     asau     15442: <li class="step">
1.110     hubertf  15443: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   15444:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   15445:        <code class="filename">htdocs</code>.</p>
1.148     asau     15446: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   15447: <h3 class="title">Note</h3>
                   15448: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  15449:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   15450:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   15451:        directory.</p>
                   15452: </div>
                   15453: </li>
1.79      rillig   15454: </ol></div>
1.75      rillig   15455: </div>
                   15456: </div>
                   15457: </div></body>
1.1       grant    15458: </html>

CVSweb <webmaster@jp.NetBSD.org>